Ajax\semantic\widgets\datatable\DataTableFieldAsTrait

Complexity

Total Complexity

27

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
	addField()	0	1	?
	insertField()	0	1	?
	insertInField()	0	1	?
	fieldAs()	0	1	?
A	getFieldButtonCallable()	0	3	1
B	getCallable()	0	20	5
A	getFieldButton()	0	6	2
A	getFieldButtons()	0	6	2
A	fieldAsSubmit()	0	9	3
A	_visibleOver()	0	4	1
A	addFieldButton()	0	4	1
A	addFieldButtons()	0	4	1
A	insertFieldButton()	0	4	1
A	insertInFieldButton()	0	4	1
A	addDefaultButton()	0	4	1
A	insertDefaultButtonIn()	0	4	1
A	getDefaultButton()	0	7	2
A	addDeleteButton()	0	4	1
A	addEditButton()	0	4	1
A	addEditDeleteButtons()	0	6	1
A	insertDeleteButtonIn()	0	4	1
A	insertEditButtonIn()	0	4	1

<?php
namespace Ajax\semantic\widgets\datatable;
use Ajax\semantic\html\elements\HtmlButton;
use Ajax\semantic\widgets\base\InstanceViewer;
use Ajax\semantic\html\base\HtmlSemDoubleElement;
use Ajax\common\html\BaseHtml;
use Ajax\semantic\html\elements\HtmlButtonGroups;

/**
 * trait used in DataTable
 * @author jc
 * @property array $_deleteBehavior
 * @property array $_editBehavior
 * @property boolean $_visibleHover
 * @property InstanceViewer $_instanceViewer
 */
trait DataTableFieldAsTrait{
	abstract public function addField($field);
	abstract public function insertField($index,$field);
	abstract public function insertInField($index,$field);
	abstract public function fieldAs($index,$type,$attributes=NULL);
	/**
	 * @param string $caption
	 * @param callable $callback
	 * @param boolean $visibleHover
	 * @return callable
	 */
	private function getFieldButtonCallable($caption,$visibleHover=true,$callback=null){
		return $this->getCallable("getFieldButton",[$caption,$visibleHover],$callback);
	}

	/**
	 * @param callable $thisCallback
	 * @param array $parameters
	 * @param callable $callback
	 * @return callable
	 */
	private function getCallable($thisCallback,$parameters,$callback=null){
		$result=function($instance) use($thisCallback,$parameters,$callback){
			$object=call_user_func_array(array($this,$thisCallback), $parameters);
			if(isset($callback)){
				if(\is_callable($callback)){
					$callback($object,$instance,$this->_instanceViewer->count()+1);
				}
			}
			if($object instanceof HtmlSemDoubleElement){
				$id=$this->_instanceViewer->getIdentifier();
				$object->setProperty("data-ajax",$id);
				if($object->propertyContains("class","visibleover")){
					$this->_visibleHover=true;
					$object->setProperty("style","visibility:hidden;");
				}
			}
			return $object;
		};
		return $result;
	}

	/**
	 * @param string $caption
	 * @return HtmlButton
	 */
	private function getFieldButton($caption,$visibleHover=true){
		$bt= new HtmlButton("",$caption);
		if($visibleHover)
			$this->_visibleOver($bt);
		return $bt;
	}

	private function getFieldButtons($buttons,$visibleHover=true){

This method is not used, and could be removed.

		$bts=new HtmlButtonGroups("",$buttons);
		if($visibleHover)
			$this->_visibleOver($bts);
		return $bts;
	}

	/**
	 * Creates a submit button at $index position
	 * @param int $index
	 * @param string $cssStyle
	 * @param string $url
	 * @param string $responseElement
	 * @param array $attributes associative array (<b>ajax</b> key is for ajax post)
	 * @return DataTable
	 */
	public function fieldAsSubmit($index,$cssStyle=NULL,$url=NULL,$responseElement=NULL,$attributes=NULL){
		return $this->_fieldAs(function($id,$name,$value,$caption) use ($url,$responseElement,$cssStyle,$index,$attributes){

The method _fieldAs() does not exist on Ajax\semantic\widgets\datatable\DataTableFieldAsTrait. Did you maybe mean fieldAs()?

The parameter $caption is not used and could be removed.

			$button=new HtmlButton($id,$value,$cssStyle);
			$button->postOnClick($url,"$(event.target).closest('tr').find(':input').serialize()",$responseElement,$attributes["ajax"]);
			if(!isset($attributes["visibleHover"]) || $attributes["visibleHover"])
				$this->_visibleOver($button);
				return $button;
		}, $index,$attributes);
	}

	protected function _visibleOver(BaseHtml $element){
		$this->_visibleHover=true;
		return $element->addToProperty("class", "visibleover")->setProperty("style","visibility:hidden;");
	}

	/**
	 * Inserts a new Button for each row
	 * @param string $caption
	 * @param callable $callback
	 * @param boolean $visibleHover
	 * @return DataTable
	 */
	public function addFieldButton($caption,$visibleHover=true,$callback=null){
		$this->addField($this->getCallable("getFieldButton",[$caption,$visibleHover],$callback));
		return $this;
	}

	/**
	 * Inserts a new ButtonGroups for each row
	 * @param array $buttons
	 * @param callable $callback
	 * @param boolean $visibleHover
	 * @return DataTable
	 */
	public function addFieldButtons($buttons,$visibleHover=true,$callback=null){
		$this->addField($this->getCallable("getFieldButtons",[$buttons,$visibleHover],$callback));
		return $this;
	}

	/**
	 * Inserts a new Button for each row at col $index
	 * @param int $index
	 * @param string $caption
	 * @param callable $callback
	 * @return DataTable
	 */
	public function insertFieldButton($index,$caption,$visibleHover=true,$callback=null){
		$this->insertField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
		return $this;
	}

	/**
	 * Inserts a new Button for each row in col at $index
	 * @param int $index
	 * @param string $caption
	 * @param callable $callback
	 * @return DataTable
	 */
	public function insertInFieldButton($index,$caption,$visibleHover=true,$callback=null){
		$this->insertInField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
		return $this;
	}

	private function addDefaultButton($icon,$class=null,$visibleHover=true,$callback=null){
		$this->addField($this->getCallable("getDefaultButton",[$icon,$class,$visibleHover],$callback));
		return $this;
	}

	private function insertDefaultButtonIn($index,$icon,$class=null,$visibleHover=true,$callback=null){
		$this->insertInField($index,$this->getCallable("getDefaultButton",[$icon,$class,$visibleHover],$callback));
		return $this;
	}

	private function getDefaultButton($icon,$class=null,$visibleHover=true){

This method is not used, and could be removed.

		$bt=$this->getFieldButton("",$visibleHover);
		$bt->asIcon($icon);
		if(isset($class))
			$bt->addClass($class);
		return $bt;
	}

	/**
	 * Adds a delete button
	 * @param boolean $visibleHover
	 * @param array $deleteBehavior default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
	 * @param callable $callback this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
	 * @return DataTable
	 */
	public function addDeleteButton($visibleHover=true,$deleteBehavior=[],$callback=null){
		$this->_deleteBehavior=$deleteBehavior;
		return $this->addDefaultButton("remove","_delete red basic",$visibleHover,$callback);
	}

	/**
	 * Adds an edit button
	 * @param string $visibleHover
	 * @param array $editBehavior default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
	 * @param callable $callback this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
	 * @return DataTable
	 */
	public function addEditButton($visibleHover=true,$editBehavior=[],$callback=null){
		$this->_editBehavior=$editBehavior;
		return $this->addDefaultButton("edit","_edit basic",$visibleHover,$callback);

It seems like $visibleHover defined by parameter $visibleHover on line 186 can also be of type string; however, Ajax\semantic\widgets\datatable\DataTableFieldAsTrait::addDefaultButton() does only seem to accept boolean, maybe add an additional type check?

	}

	/**
	 * Adds an edit and a delete button
	 * @param string $visibleHover
	 * @param array $behavior default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
	 * @param callable $callbackEdit this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
	 * @param callable $callbackDelete this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
	 * @return DataTable
	 */
	public function addEditDeleteButtons($visibleHover=true,$behavior=[],$callbackEdit=null,$callbackDelete=null){
		$this->addEditButton($visibleHover,$behavior,$callbackEdit);
		$index=$this->_instanceViewer->visiblePropertiesCount()-1;
		$this->insertDeleteButtonIn($index,$visibleHover,$behavior,$callbackDelete);

It seems like $visibleHover defined by parameter $visibleHover on line 199 can also be of type string; however, Ajax\semantic\widgets\datatable\DataTableFieldAsTrait::insertDeleteButtonIn() does only seem to accept boolean, maybe add an additional type check?

		return $this;
	}

	public function insertDeleteButtonIn($index,$visibleHover=true,$deleteBehavior=[],$callback=null){
		$this->_deleteBehavior=$deleteBehavior;
		return $this->insertDefaultButtonIn($index,"remove","_delete red basic",$visibleHover,$callback);
	}

	public function insertEditButtonIn($index,$visibleHover=true,$editBehavior=[],$callback=null){
		$this->_editBehavior=$editBehavior;
		return $this->insertDefaultButtonIn($index,"edit","_edit basic",$visibleHover,$callback);
	}
}