phpMv / phpMv-UI

Ajax/semantic/widgets/datatable/DataTableFieldAsTrait.php

Doc Comments +34 added lines, -9 removed lines

@@ -15,15 +15,28 @@ 
  * @property InstanceViewer $_instanceViewer
  */
 trait DataTableFieldAsTrait{
+
+	/**
+	 * @param \Closure $field
+	 */
 	abstract public function addField($field);
+
+	/**
+	 * @param integer $index
+	 * @param \Closure $field
+	 */
 	abstract public function insertField($index,$field);
+
+	/**
+	 * @param \Closure $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
+	 * @return \Closure
 	 */
 	private function getFieldButtonCallable($caption,$visibleHover=true,$callback=null){
 		return $this->getCallable("getFieldButton",[$caption,$visibleHover],$callback);
@@ -33,7 +46,7 @@ 
 	 * @param callable $thisCallback
 	 * @param array $parameters
 	 * @param callable $callback
-	 * @return callable
+	 * @return \Closure
 	 */
 	private function getCallable($thisCallback,$parameters,$callback=null){
 		$result=function($instance) use($thisCallback,$parameters,$callback){
@@ -103,7 +116,7 @@ 
 	 * @param string $caption
 	 * @param callable $callback
 	 * @param boolean $visibleHover
-	 * @return DataTable
+	 * @return DataTableFieldAsTrait
 	 */
 	public function addFieldButton($caption,$visibleHover=true,$callback=null){
 		$this->addField($this->getCallable("getFieldButton",[$caption,$visibleHover],$callback));
@@ -115,7 +128,7 @@ 
 	 * @param array $buttons
 	 * @param callable $callback
 	 * @param boolean $visibleHover
-	 * @return DataTable
+	 * @return DataTableFieldAsTrait
 	 */
 	public function addFieldButtons($buttons,$visibleHover=true,$callback=null){
 		$this->addField($this->getCallable("getFieldButtons",[$buttons,$visibleHover],$callback));
@@ -127,7 +140,7 @@ 
 	 * @param int $index
 	 * @param string $caption
 	 * @param callable $callback
-	 * @return DataTable
+	 * @return DataTableFieldAsTrait
 	 */
 	public function insertFieldButton($index,$caption,$visibleHover=true,$callback=null){
 		$this->insertField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
@@ -139,18 +152,27 @@ 
 	 * @param int $index
 	 * @param string $caption
 	 * @param callable $callback
-	 * @return DataTable
+	 * @return DataTableFieldAsTrait
 	 */
 	public function insertInFieldButton($index,$caption,$visibleHover=true,$callback=null){
 		$this->insertInField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
 		return $this;
 	}
 
+	/**
+	 * @param string $icon
+	 * @param string $class
+	 * @param callable $callback
+	 */
 	private function addDefaultButton($icon,$class=null,$visibleHover=true,$callback=null){
 		$this->addField($this->getCallable("getDefaultButton",[$icon,$class,$visibleHover],$callback));
 		return $this;
 	}
 
+	/**
+	 * @param string $icon
+	 * @param string $class
+	 */
 	private function insertDefaultButtonIn($index,$icon,$class=null,$visibleHover=true,$callback=null){
 		$this->insertInField($index,$this->getCallable("getDefaultButton",[$icon,$class,$visibleHover],$callback));
 		return $this;
@@ -169,7 +191,7 @@ 
 	 * @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
+	 * @return DataTableFieldAsTrait
 	 */
 	public function addDeleteButton($visibleHover=true,$deleteBehavior=[],$callback=null){
 		$this->_deleteBehavior=$deleteBehavior;
@@ -181,7 +203,7 @@ 
 	 * @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
+	 * @return DataTableFieldAsTrait
 	 */
 	public function addEditButton($visibleHover=true,$editBehavior=[],$callback=null){
 		$this->_editBehavior=$editBehavior;
@@ -194,7 +216,7 @@ 
 	 * @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
+	 * @return DataTableFieldAsTrait
 	 */
 	public function addEditDeleteButtons($visibleHover=true,$behavior=[],$callbackEdit=null,$callbackDelete=null){
 		$this->addEditButton($visibleHover,$behavior,$callbackEdit);
@@ -203,6 +225,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param callable $callback
+	 */
 	public function insertDeleteButtonIn($index,$visibleHover=true,$deleteBehavior=[],$callback=null){
 		$this->_deleteBehavior=$deleteBehavior;
 		return $this->insertDefaultButtonIn($index,"remove","_delete red basic",$visibleHover,$callback);

Spacing +56 added lines, -56 removed lines

@@ -14,19 +14,19 @@ 
  * @property boolean $_visibleHover
  * @property InstanceViewer $_instanceViewer
  */
-trait DataTableFieldAsTrait{
+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);
+	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);
+	private function getFieldButtonCallable($caption, $visibleHover=true, $callback=null) {
+		return $this->getCallable("getFieldButton", [$caption, $visibleHover], $callback);
 	}
 
 	/**
@@ -35,20 +35,20 @@ 
 	 * @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);
+	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){
+			if ($object instanceof HtmlSemDoubleElement) {
 				$id=$this->_instanceViewer->getIdentifier();
-				$object->setProperty("data-ajax",$id);
-				if($object->propertyContains("class","visibleover")){
+				$object->setProperty("data-ajax", $id);
+				if ($object->propertyContains("class", "visibleover")) {
 					$this->_visibleHover=true;
-					$object->setProperty("style","visibility:hidden;");
+					$object->setProperty("style", "visibility:hidden;");
 				}
 			}
 			return $object;
@@ -60,16 +60,16 @@ 
 	 * @param string $caption
 	 * @return HtmlButton
 	 */
-	private function getFieldButton($caption,$visibleHover=true){
-		$bt= new HtmlButton("",$caption);
-		if($visibleHover)
+	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)
+	private function getFieldButtons($buttons, $visibleHover=true) {
+		$bts=new HtmlButtonGroups("", $buttons);
+		if ($visibleHover)
 			$this->_visibleOver($bts);
 		return $bts;
 	}
@@ -83,19 +83,19 @@ 
 	 * @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"])
+	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);
+		}, $index, $attributes);
 	}
 
-	protected function _visibleOver(BaseHtml $element){
+	protected function _visibleOver(BaseHtml $element) {
 		$this->_visibleHover=true;
-		return $element->addToProperty("class", "visibleover")->setProperty("style","visibility:hidden;");
+		return $element->addToProperty("class", "visibleover")->setProperty("style", "visibility:hidden;");
 	}
 
 	/**
@@ -105,8 +105,8 @@ 
 	 * @param boolean $visibleHover
 	 * @return DataTable
 	 */
-	public function addFieldButton($caption,$visibleHover=true,$callback=null){
-		$this->addField($this->getCallable("getFieldButton",[$caption,$visibleHover],$callback));
+	public function addFieldButton($caption, $visibleHover=true, $callback=null) {
+		$this->addField($this->getCallable("getFieldButton", [$caption, $visibleHover], $callback));
 		return $this;
 	}
 
@@ -117,8 +117,8 @@ 
 	 * @param boolean $visibleHover
 	 * @return DataTable
 	 */
-	public function addFieldButtons($buttons,$visibleHover=true,$callback=null){
-		$this->addField($this->getCallable("getFieldButtons",[$buttons,$visibleHover],$callback));
+	public function addFieldButtons($buttons, $visibleHover=true, $callback=null) {
+		$this->addField($this->getCallable("getFieldButtons", [$buttons, $visibleHover], $callback));
 		return $this;
 	}
 
@@ -129,8 +129,8 @@ 
 	 * @param callable $callback
 	 * @return DataTable
 	 */
-	public function insertFieldButton($index,$caption,$visibleHover=true,$callback=null){
-		$this->insertField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
+	public function insertFieldButton($index, $caption, $visibleHover=true, $callback=null) {
+		$this->insertField($index, $this->getFieldButtonCallable($caption, $visibleHover, $callback));
 		return $this;
 	}
 
@@ -141,25 +141,25 @@ 
 	 * @param callable $callback
 	 * @return DataTable
 	 */
-	public function insertInFieldButton($index,$caption,$visibleHover=true,$callback=null){
-		$this->insertInField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
+	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));
+	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));
+	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);
+	private function getDefaultButton($icon, $class=null, $visibleHover=true) {
+		$bt=$this->getFieldButton("", $visibleHover);
 		$bt->asIcon($icon);
-		if(isset($class))
+		if (isset($class))
 			$bt->addClass($class);
 		return $bt;
 	}
@@ -171,9 +171,9 @@ 
 	 * @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){
+	public function addDeleteButton($visibleHover=true, $deleteBehavior=[], $callback=null) {
 		$this->_deleteBehavior=$deleteBehavior;
-		return $this->addDefaultButton("remove","_delete red basic",$visibleHover,$callback);
+		return $this->addDefaultButton("remove", "_delete red basic", $visibleHover, $callback);
 	}
 
 	/**
@@ -183,9 +183,9 @@ 
 	 * @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){
+	public function addEditButton($visibleHover=true, $editBehavior=[], $callback=null) {
 		$this->_editBehavior=$editBehavior;
-		return $this->addDefaultButton("edit","_edit basic",$visibleHover,$callback);
+		return $this->addDefaultButton("edit", "_edit basic", $visibleHover, $callback);
 	}
 
 	/**
@@ -196,20 +196,20 @@ 
 	 * @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);
+	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);
+		$this->insertDeleteButtonIn($index, $visibleHover, $behavior, $callbackDelete);
 		return $this;
 	}
 
-	public function insertDeleteButtonIn($index,$visibleHover=true,$deleteBehavior=[],$callback=null){
+	public function insertDeleteButtonIn($index, $visibleHover=true, $deleteBehavior=[], $callback=null) {
 		$this->_deleteBehavior=$deleteBehavior;
-		return $this->insertDefaultButtonIn($index,"remove","_delete red basic",$visibleHover,$callback);
+		return $this->insertDefaultButtonIn($index, "remove", "_delete red basic", $visibleHover, $callback);
 	}
 
-	public function insertEditButtonIn($index,$visibleHover=true,$editBehavior=[],$callback=null){
+	public function insertEditButtonIn($index, $visibleHover=true, $editBehavior=[], $callback=null) {
 		$this->_editBehavior=$editBehavior;
-		return $this->insertDefaultButtonIn($index,"edit","_edit basic",$visibleHover,$callback);
+		return $this->insertDefaultButtonIn($index, "edit", "_edit basic", $visibleHover, $callback);
 	}
 }

Braces +12 added lines, -8 removed lines

@@ -62,15 +62,17 @@ 
 	 */
 	private function getFieldButton($caption,$visibleHover=true){
 		$bt= new HtmlButton("",$caption);
-		if($visibleHover)
-			$this->_visibleOver($bt);
+		if($visibleHover) {
+					$this->_visibleOver($bt);
+		}
 		return $bt;
 	}
 
 	private function getFieldButtons($buttons,$visibleHover=true){
 		$bts=new HtmlButtonGroups("",$buttons);
-		if($visibleHover)
-			$this->_visibleOver($bts);
+		if($visibleHover) {
+					$this->_visibleOver($bts);
+		}
 		return $bts;
 	}
 
@@ -87,8 +89,9 @@ 
 		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);
+			if(!isset($attributes["visibleHover"]) || $attributes["visibleHover"]) {
+							$this->_visibleOver($button);
+			}
 				return $button;
 		}, $index,$attributes);
 	}
@@ -159,8 +162,9 @@ 
 	private function getDefaultButton($icon,$class=null,$visibleHover=true){
 		$bt=$this->getFieldButton("",$visibleHover);
 		$bt->asIcon($icon);
-		if(isset($class))
-			$bt->addClass($class);
+		if(isset($class)) {
+					$bt->addClass($class);
+		}
 		return $bt;
 	}