phpMv / phpMv-UI

Ajax/semantic/widgets/datatable/DataTableFieldAsTrait.php

Doc Comments +33 added lines, -8 removed lines

@@ -14,15 +14,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);
@@ -32,7 +45,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){
@@ -94,7 +107,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));
@@ -106,7 +119,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));
@@ -118,18 +131,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;
@@ -148,7 +170,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;
@@ -160,7 +182,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;
@@ -173,7 +195,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);
@@ -182,6 +204,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);