phpMv / phpMv-UI

Ajax/common/html/HtmlCollection.php

Doc Comments +10 added lines

@@ -49,6 +49,10 @@ 
 		return $itemO;
 	}
 
+	/**
+	 * @param string $classname
+	 * @param integer $index
+	 */
 	protected function setItemIdentifier($item,$classname,$index){
 		if($item instanceof BaseWidget){
 			if($item->getIdentifier()===""){
@@ -93,6 +97,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public function removeItem($index){
 		return array_splice($this->content, $index, 1);
 	}
@@ -108,6 +115,9 @@ 
 		return $this->addItem($function($object));
 	}
 
+	/**
+	 * @param \Closure $callBack
+	 */
 	public function apply($callBack){
 		foreach ($this->content as $item){
 			$callBack($item);

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/business/BusinessForm.php

Doc Comments +1 added lines

@@ -15,6 +15,7 @@
 	 * {@inheritdoc}
 	 *
 	 * @see \Ajax\semantic\widgets\dataform\DataForm::__construct()
+	 * @param string $identifier
 	 */
 	public function __construct($identifier,$modelInstance=null,$fieldsOrder,$fieldsDefinition,$fields=[],$captions=[],$separators=[]) {
 		if(!isset($modelInstance)){

Ajax/semantic/html/content/table/HtmlTR.php

Doc Comments +4 added lines

@@ -18,6 +18,9 @@ 
 	private $_container;
 	private $_row;
 
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier) {
 		parent::__construct($identifier, "tr", "");
 		$this->_states=[ State::ACTIVE,State::POSITIVE,State::NEGATIVE,State::WARNING,State::ERROR,State::DISABLED ];
@@ -78,6 +81,7 @@ 
 	/**
 	 * Sets or adds values to the row cols
 	 * @param mixed $values
+	 * @param \Closure $callback
 	 */
 	protected function _addOrSetValues($values,$callback) {
 		$count=$this->count();

Ajax/semantic/widgets/datatable/DataTable.php

Doc Comments +16 added lines, -4 removed lines

@@ -63,6 +63,9 @@ 
 
 
 
+	/**
+	 * @param string $op
+	 */
 	protected function _generateBehavior($op,$params,JsUtils $js){
 		if(isset($this->_urls[$op])){
 			$params=\array_merge($params,["attr"=>"data-ajax"]);
@@ -139,6 +142,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $checkedClass
+	 */
 	protected function _generateRow($instance,&$table,$checkedClass=null){
 		$this->_instanceViewer->setInstance($instance);
 		InstanceViewer::$index++;
@@ -215,6 +221,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param PositionInTable $part
+	 */
 	private function addToolbarRow($part,$table,$captions){
 		$hasPart=$table->hasPart($part);
 		if($hasPart){
@@ -254,7 +263,7 @@ 
 	 * Paginates the DataTable element with a Semantic HtmlPaginationMenu component
 	 * @param number $page the active page number
 	 * @param number $total_rowcount the total number of items
-	 * @param number $items_per_page The number of items per page
+	 * @param integer $items_per_page The number of items per page
 	 * @param number $pages_visibles The number of visible pages in the Pagination component
 	 * @return DataTable
 	 */
@@ -265,9 +274,9 @@ 
 
 	/**
 	 * Auto Paginates the DataTable element with a Semantic HtmlPaginationMenu component
-	 * @param number $page the active page number
-	 * @param number $items_per_page The number of items per page
-	 * @param number $pages_visibles The number of visible pages in the Pagination component
+	 * @param integer $page the active page number
+	 * @param integer $items_per_page The number of items per page
+	 * @param integer $pages_visibles The number of visible pages in the Pagination component
 	 * @return DataTable
 	 */
 	public function autoPaginate($page=1,$items_per_page=10,$pages_visibles=4){
@@ -333,6 +342,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getRefreshSelector() {
 		if(isset($this->_refreshSelector))
 			return $this->_refreshSelector;

Ajax/semantic/html/content/table/HtmlTableContent.php

Doc Comments +16 added lines, -4 removed lines

@@ -62,6 +62,9 @@ 
 		return $tr;
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	public function newRow($value) {
 		return $this->createItem($value);
 	}
@@ -160,6 +163,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $colIndex
+	 */
 	public function setColValues($colIndex, $values=array()) {
 		$count=$this->count();
 		if (!\is_array($values)) {
@@ -180,6 +186,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $rowIndex
+	 */
 	public function setRowValues($rowIndex, $values=array()) {
 		$count=$this->count();
 		if (!\is_array($values)) {
@@ -189,6 +198,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $function
+	 */
 	private function colAlign($colIndex, $function) {
 		$count=$this->count();
 		for($i=0; $i < $count; $i++) {
@@ -266,7 +278,7 @@ 
 	}
 
 	/**
-	 * @param mixed $callback
+	 * @param callable $callback
 	 * @param string $format
 	 * @return HtmlTableContent
 	 */
@@ -279,7 +291,7 @@ 
 	}
 
 	/**
-	 * @param mixed $callback
+	 * @param callable $callback
 	 * @param string $format
 	 * @return HtmlTableContent
 	 */
@@ -292,7 +304,7 @@ 
 	}
 
 	/**
-	 * @param mixed $callback
+	 * @param callable $callback
 	 * @return HtmlTableContent
 	 */
 	public function applyCells($callback) {
@@ -304,7 +316,7 @@ 
 	}
 
 	/**
-	 * @param mixed $callback
+	 * @param callable $callback
 	 * @return HtmlTableContent
 	 */
 	public function applyRows($callback) {

Ajax/semantic/widgets/base/FieldAsTrait.php

Doc Comments +11 added lines

@@ -30,9 +30,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(BaseHtml &$button,$event,$url,$responseElement=NULL,$parameters=NULL);
 
 	/**
@@ -243,6 +251,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public function fieldAs($index,$type,$attributes=NULL){
 		$method="fieldAs".\ucfirst($type);
 		if(\method_exists($this, $method)){

Ajax/semantic/widgets/base/InstanceViewer.php

Doc Comments +4 added lines, -1 removed lines

@@ -249,6 +249,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public static function setIndex($index) {
 		self::$index=$index;
 	}
@@ -307,7 +310,7 @@ 
 	 * The $callback function can take the following arguments : $field=>the compiled field, $instance : the active instance of the object, $index: the field position
 	 * @param int $index postion of the compiled field
 	 * @param callable $callback function called after the field compilation
-	 * @return \Ajax\semantic\widgets\datatable\InstanceViewer
+	 * @return InstanceViewer
 	 */
 	public function afterCompile($index,$callback){
 		$this->afterCompile[$index]=$callback;

Ajax/common/html/BaseHtml.php

Doc Comments +14 added lines

@@ -63,6 +63,10 @@ 
 
 
 
+	/**
+	 * @param string $name
+	 * @param string[] $typeCtrl
+	 */
 	protected function setMemberCtrl(&$name, $value, $typeCtrl) {
 		if ($this->ctrl($name, $value, $typeCtrl) === true) {
 			return $name=$value;
@@ -80,6 +84,10 @@ 
 
 
 
+	/**
+	 * @param string $name
+	 * @param string[] $typeCtrl
+	 */
 	protected function addToMemberCtrl(&$name, $value, $typeCtrl, $separator=" ") {
 		if ($this->ctrl($name, $value, $typeCtrl) === true) {
 			if (\is_array($typeCtrl)) {
@@ -90,6 +98,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected function addToMember(&$name, $value, $separator=" ") {
 		$name=str_ireplace($value, "", $name) . $separator . $value;
 		return $this;
@@ -102,6 +113,9 @@ 
 		$oldValue=trim($oldValue);
 	}
 
+	/**
+	 * @param \Closure $callback
+	 */
 	protected function _getElementBy($callback,$elements){
 		if (\is_array($elements)) {
 			$elements=\array_values($elements);