phpMv / phpMv-UI

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/semantic/html/collections/HtmlGrid.php

Doc Comments +4 added lines, -1 removed lines

@@ -22,6 +22,9 @@ 
 	private $_colSizing=true;
 	private $_implicitRows=false;
 
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $numRows=1, $numCols=NULL, $createCols=true, $implicitRows=false) {
 		parent::__construct($identifier, "div", "ui grid");
 		$this->_implicitRows=$implicitRows;
@@ -162,7 +165,7 @@ 
 	/**
 	 * return the row at $index
 	 * @param int $index
-	 * @return \Ajax\semantic\html\collections\HtmlGridRow
+	 * @return \Ajax\common\html\HtmlDoubleElement
 	 */
 	public function getRow($index) {
 		return $this->getItem($index);

Ajax/semantic/widgets/dataform/DataForm.php

Doc Comments +11 added lines

@@ -72,6 +72,9 @@ 
 		}
 	}
 
+	/**
+	 * @param HtmlForm $form
+	 */
 	protected function _generateFields($form,$values,$headers,$sepFirst,$wrappers){
 		$wrapper=null;
 		if(isset($headers[$sepFirst+1]))
@@ -136,12 +139,20 @@ 
 		$this->content[$this->_toolbarPosition]=$this->_toolbar;
 	}
 
+	/**
+	 * @param integer $index
+	 * @param string $title
+	 */
 	public function addDividerBefore($index,$title){
 		$index=$this->_getIndex($index);
 		$this->_instanceViewer->addHeaderDividerBefore($index, $title);
 		return $this;
 	}
 
+	/**
+	 * @param string $index
+	 * @param string $contentAfter
+	 */
 	public function addWrapper($index,$contentBefore,$contentAfter=null){
 		$index=$this->_getIndex($index);
 		$this->_instanceViewer->addWrapper($index, $contentBefore,$contentAfter);

Ajax/semantic/traits/SemanticHtmlViewsTrait.php

Doc Comments -1 removed lines

@@ -21,7 +21,6 @@
 
 	/**
 	 * @param string $identifier
-	 * @param array $items
 	 * @return HtmlCardGroups
 	 */
 	public function htmlCardGroups($identifier, $cards=array()) {

Ajax/semantic/html/content/view/ContentPartTrait.php

Doc Comments +5 added lines

@@ -7,6 +7,11 @@
  * @property mixed $content
  */
 trait ContentPartTrait{
+
+	/**
+	 * @param \Ajax\semantic\html\elements\HtmlButtonGroups $element
+	 * @param string $partKey
+	 */
 	public function addElementInPart($element,$partKey,$before=false,$force=false){
 		$part=$this->getPart($partKey,null,$force);
 		if($part instanceof  HtmlSemDoubleElement){

Ajax/semantic/html/content/view/HtmlViewContent.php

Doc Comments +4 added lines

@@ -12,6 +12,10 @@
 
 class HtmlViewContent extends HtmlSemDoubleElement {
 	use ContentPartTrait;
+
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $content=array()) {
 		parent::__construct($identifier, "div", "content",[]);
 		$this->setContent($content);