DataTableFieldAsTrait::addFieldButtons() - Code Metrics - Inspection of "addFieldButtons" - phpMv/phpMv-UI - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( db4c08...7ebf5f )

by Jean-Christophe

created 2017-11-08 02:02 UTC

DataTableFieldAsTrait::addFieldButtons() A

↳ Parent: DataTableFieldAsTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	3

<?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){

		$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){

			$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){

		$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);

	}

	/**
	 * 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);

		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);
	}
}


1			<?php
2			namespace Ajax\semantic\widgets\datatable;
3			use Ajax\semantic\html\elements\HtmlButton;
4			use Ajax\semantic\widgets\base\InstanceViewer;
5			use Ajax\semantic\html\base\HtmlSemDoubleElement;
6			use Ajax\common\html\BaseHtml;
7			use Ajax\semantic\html\elements\HtmlButtonGroups;
8
9			/**
10			* trait used in DataTable
11			* @author jc
12			* @property array $_deleteBehavior
13			* @property array $_editBehavior
14			* @property boolean $_visibleHover
15			* @property InstanceViewer $_instanceViewer
16			*/
17			trait DataTableFieldAsTrait{
18			abstract public function addField($field);
19			abstract public function insertField($index,$field);
20			abstract public function insertInField($index,$field);
21			abstract public function fieldAs($index,$type,$attributes=NULL);
22			/**
23			* @param string $caption
24			* @param callable $callback
25			* @param boolean $visibleHover
26			* @return callable
27			*/
28			private function getFieldButtonCallable($caption,$visibleHover=true,$callback=null){
29			return $this->getCallable("getFieldButton",[$caption,$visibleHover],$callback);
30			}
31
32			/**
33			* @param callable $thisCallback
34			* @param array $parameters
35			* @param callable $callback
36			* @return callable
37			*/
38			private function getCallable($thisCallback,$parameters,$callback=null){
39			$result=function($instance) use($thisCallback,$parameters,$callback){
40			$object=call_user_func_array(array($this,$thisCallback), $parameters);
41			if(isset($callback)){
42			if(\is_callable($callback)){
43			$callback($object,$instance,$this->_instanceViewer->count()+1);
44			}
45			}
46			if($object instanceof HtmlSemDoubleElement){
47			$id=$this->_instanceViewer->getIdentifier();
48			$object->setProperty("data-ajax",$id);
49			if($object->propertyContains("class","visibleover")){
50			$this->_visibleHover=true;
51			$object->setProperty("style","visibility:hidden;");
52			}
53			}
54			return $object;
55			};
56			return $result;
57			}
58
59			/**
60			* @param string $caption
61			* @return HtmlButton
62			*/
63			private function getFieldButton($caption,$visibleHover=true){
64			$bt= new HtmlButton("",$caption);
65			if($visibleHover)
66			$this->_visibleOver($bt);
67			return $bt;
68			}
69
70			private function getFieldButtons($buttons,$visibleHover=true){
			0 ignored issues – show Unused Code introduced 2017-11-08 02:05 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
71			$bts=new HtmlButtonGroups("",$buttons);
72			if($visibleHover)
73			$this->_visibleOver($bts);
74			return $bts;
75			}
76
77			/**
78			* Creates a submit button at $index position
79			* @param int $index
80			* @param string $cssStyle
81			* @param string $url
82			* @param string $responseElement
83			* @param array $attributes associative array (<b>ajax</b> key is for ajax post)
84			* @return DataTable
85			*/
86			public function fieldAsSubmit($index,$cssStyle=NULL,$url=NULL,$responseElement=NULL,$attributes=NULL){
87			return $this->_fieldAs(function($id,$name,$value,$caption) use ($url,$responseElement,$cssStyle,$index,$attributes){
			0 ignored issues – show Bug introduced 2017-02-18 14:54 UTC by Report Bug Copy Issue Report The method `_fieldAs()` does not exist on `Ajax\semantic\widgets\da...e\DataTableFieldAsTrait`. Did you maybe mean `fieldAs()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history... Unused Code introduced 2017-02-14 01:35 UTC by Report Bug Copy Issue Report The parameter `$caption` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
88			$button=new HtmlButton($id,$value,$cssStyle);
89			$button->postOnClick($url,"$(event.target).closest('tr').find(':input').serialize()",$responseElement,$attributes["ajax"]);
90			if(!isset($attributes["visibleHover"]) \|\| $attributes["visibleHover"])
91			$this->_visibleOver($button);
92			return $button;
93			}, $index,$attributes);
94			}
95
96			protected function _visibleOver(BaseHtml $element){
97			$this->_visibleHover=true;
98			return $element->addToProperty("class", "visibleover")->setProperty("style","visibility:hidden;");
99			}
100
101			/**
102			* Inserts a new Button for each row
103			* @param string $caption
104			* @param callable $callback
105			* @param boolean $visibleHover
106			* @return DataTable
107			*/
108			public function addFieldButton($caption,$visibleHover=true,$callback=null){
109			$this->addField($this->getCallable("getFieldButton",[$caption,$visibleHover],$callback));
110			return $this;
111			}
112
113			/**
114			* Inserts a new ButtonGroups for each row
115			* @param array $buttons
116			* @param callable $callback
117			* @param boolean $visibleHover
118			* @return DataTable
119			*/
120			public function addFieldButtons($buttons,$visibleHover=true,$callback=null){
121			$this->addField($this->getCallable("getFieldButtons",[$buttons,$visibleHover],$callback));
122			return $this;
123			}
124
125			/**
126			* Inserts a new Button for each row at col $index
127			* @param int $index
128			* @param string $caption
129			* @param callable $callback
130			* @return DataTable
131			*/
132			public function insertFieldButton($index,$caption,$visibleHover=true,$callback=null){
133			$this->insertField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
134			return $this;
135			}
136
137			/**
138			* Inserts a new Button for each row in col at $index
139			* @param int $index
140			* @param string $caption
141			* @param callable $callback
142			* @return DataTable
143			*/
144			public function insertInFieldButton($index,$caption,$visibleHover=true,$callback=null){
145			$this->insertInField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
146			return $this;
147			}
148
149			private function addDefaultButton($icon,$class=null,$visibleHover=true,$callback=null){
150			$this->addField($this->getCallable("getDefaultButton",[$icon,$class,$visibleHover],$callback));
151			return $this;
152			}
153
154			private function insertDefaultButtonIn($index,$icon,$class=null,$visibleHover=true,$callback=null){
155			$this->insertInField($index,$this->getCallable("getDefaultButton",[$icon,$class,$visibleHover],$callback));
156			return $this;
157			}
158
159			private function getDefaultButton($icon,$class=null,$visibleHover=true){
			0 ignored issues – show Unused Code introduced 2017-10-02 23:27 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
160			$bt=$this->getFieldButton("",$visibleHover);
161			$bt->asIcon($icon);
162			if(isset($class))
163			$bt->addClass($class);
164			return $bt;
165			}
166
167			/**
168			* Adds a delete button
169			* @param boolean $visibleHover
170			* @param array $deleteBehavior default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
171			* @param callable $callback this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
172			* @return DataTable
173			*/
174			public function addDeleteButton($visibleHover=true,$deleteBehavior=[],$callback=null){
175			$this->_deleteBehavior=$deleteBehavior;
176			return $this->addDefaultButton("remove","_delete red basic",$visibleHover,$callback);
177			}
178
179			/**
180			* Adds an edit button
181			* @param string $visibleHover
182			* @param array $editBehavior default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
183			* @param callable $callback this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
184			* @return DataTable
185			*/
186			public function addEditButton($visibleHover=true,$editBehavior=[],$callback=null){
187			$this->_editBehavior=$editBehavior;
188			return $this->addDefaultButton("edit","_edit basic",$visibleHover,$callback);
			0 ignored issues – show Bug introduced 2017-10-17 01:12 UTC by Report Bug Copy Issue Report It seems like `$visibleHover` defined by parameter `$visibleHover` on line 186 can also be of type `string`; however, `Ajax\semantic\widgets\da...ait::addDefaultButton()` does only seem to accept `boolean`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
189			}
190
191			/**
192			* Adds an edit and a delete button
193			* @param string $visibleHover
194			* @param array $behavior default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
195			* @param callable $callbackEdit this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
196			* @param callable $callbackDelete this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
197			* @return DataTable
198			*/
199			public function addEditDeleteButtons($visibleHover=true,$behavior=[],$callbackEdit=null,$callbackDelete=null){
200			$this->addEditButton($visibleHover,$behavior,$callbackEdit);
201			$index=$this->_instanceViewer->visiblePropertiesCount()-1;
202			$this->insertDeleteButtonIn($index,$visibleHover,$behavior,$callbackDelete);
			0 ignored issues – show Bug introduced 2017-10-17 01:12 UTC by Report Bug Copy Issue Report It seems like `$visibleHover` defined by parameter `$visibleHover` on line 199 can also be of type `string`; however, `Ajax\semantic\widgets\da...:insertDeleteButtonIn()` does only seem to accept `boolean`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
203			return $this;
204			}
205
206			public function insertDeleteButtonIn($index,$visibleHover=true,$deleteBehavior=[],$callback=null){
207			$this->_deleteBehavior=$deleteBehavior;
208			return $this->insertDefaultButtonIn($index,"remove","_delete red basic",$visibleHover,$callback);
209			}
210
211			public function insertEditButtonIn($index,$visibleHover=true,$editBehavior=[],$callback=null){
212			$this->_editBehavior=$editBehavior;
213			return $this->insertDefaultButtonIn($index,"edit","_edit basic",$visibleHover,$callback);
214			}
215			}
216

phpMv / phpMv-UI

Push — master ( db4c08...7ebf5f )

DataTableFieldAsTrait::addFieldButtons() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like