phpMv / phpMv-UI

Ajax/semantic/widgets/base/FieldAsTrait.php

Doc Comments +18 added lines

@@ -27,9 +27,17 @@ 
 trait FieldAsTrait{
 
 	abstract protected function _getFieldIdentifier($prefix,$name="");
+
+	/**
+	 * @param \Closure $callback
+	 */
 	abstract public function setValueFunction($index,$callback);
 	abstract protected function _getFieldName($index);
 	abstract protected function _getFieldCaption($index);
+
+	/**
+	 * @param string $event
+	 */
 	abstract protected function _buttonAsSubmit(HtmlButton &$button,$event,$url,$responseElement=NULL,$parameters=NULL);
 
 	/**
@@ -68,12 +76,19 @@ 
 		}
 	}
 
+	/**
+	 * @param HtmlFormInput $field
+	 */
 	protected function _prepareFormFields(&$field,$name,&$attributes){
 		$field->setName($name);
 		$this->_addRules($field, $attributes);
 		return $field;
 	}
 
+	/**
+	 * @param \Closure $elementCallback
+	 * @param string $prefix
+	 */
 	protected function _fieldAs($elementCallback,$index,$attributes=NULL,$prefix=null){
 		$this->setValueFunction($index,function($value) use ($index,&$attributes,$elementCallback,$prefix){
 			$caption=$this->_getFieldCaption($index);
@@ -224,6 +239,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public function fieldAs($index,$type,$attributes=NULL){
 		$method="fieldAs".\ucfirst($type);
 		if(\method_exists($this, $method)){

Ajax/semantic/widgets/datatable/DataTableFieldAsTrait.php

Doc Comments +30 added lines, -6 removed lines

@@ -13,15 +13,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);
@@ -31,7 +44,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){
@@ -83,6 +96,9 @@ 
 		}, $index,$attributes);
 	}
 
+	/**
+	 * @param HtmlButton $element
+	 */
 	protected function _visibleOver($element){
 		$this->_visibleHover=true;
 		return $element->addToProperty("class", "visibleover")->setProperty("style","visibility:hidden;");
@@ -93,7 +109,7 @@ 
 	 * @param string $caption
 	 * @param callable $callback
 	 * @param boolean $visibleHover
-	 * @return \Ajax\semantic\widgets\datatable\DataTable
+	 * @return DataTableFieldAsTrait
 	 */
 	public function addFieldButton($caption,$visibleHover=true,$callback=null){
 		$this->addField($this->getCallable("getFieldButton",[$caption,$visibleHover],$callback));
@@ -105,7 +121,7 @@ 
 	 * @param int $index
 	 * @param string $caption
 	 * @param callable $callback
-	 * @return \Ajax\semantic\widgets\datatable\DataTable
+	 * @return DataTableFieldAsTrait
 	 */
 	public function insertFieldButton($index,$caption,$visibleHover=true,$callback=null){
 		$this->insertField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback));
@@ -117,18 +133,26 @@ 
 	 * @param int $index
 	 * @param string $caption
 	 * @param callable $callback
-	 * @return \Ajax\semantic\widgets\datatable\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
+	 */
 	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;
@@ -146,7 +170,7 @@ 
 	 * @param boolean $visibleHover
 	 * @param array $deleteBehavior
 	 * @param callable $callback
-	 * @return DataTable
+	 * @return DataTableFieldAsTrait
 	 */
 	public function addDeleteButton($visibleHover=true,$deleteBehavior=[],$callback=null){
 		$this->_deleteBehavior=$deleteBehavior;

Ajax/semantic/widgets/datatable/DataTable.php

Doc Comments +10 added lines

@@ -32,6 +32,10 @@ 
 	protected $_targetSelector;
 
 
+	/**
+	 * @param string $identifier
+	 * @param string $model
+	 */
 	public function __construct($identifier,$model,$modelInstance=NULL) {
 		parent::__construct($identifier, $model,$modelInstance);
 		$this->_init(new InstanceViewer($identifier), "table", new HtmlTable($identifier, 0,0), false);
@@ -55,6 +59,9 @@ 
 
 
 
+	/**
+	 * @param string $op
+	 */
 	protected function _generateBehavior($op,$params,JsUtils $js){
 		if(isset($this->_urls[$op])){
 			$params=\array_merge($params,["attr"=>"data-ajax"]);
@@ -184,6 +191,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param PositionInTable $part
+	 */
 	private function addToolbarRow($part,$table,$captions){
 		$hasPart=$table->hasPart($part);
 		if($hasPart){