phpMv / phpMv-UI

Ajax/semantic/html/modules/HtmlDropdown.php

Doc Comments +14 added lines, -2 removed lines

@@ -25,6 +25,9 @@ 
 	protected $_associative;
 	protected $_multiple;
 
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $value="", $items=array(),$associative=true) {
 		parent::__construct($identifier, "div");
 		$this->_template=include dirname(__FILE__).'/../templates/tplDropdown.php';
@@ -78,7 +81,7 @@ 
 	/**
 	 * Insert an item at a position
 	 * @param mixed $item
-	 * @param number $position
+	 * @param integer $position
 	 * @return \Ajax\semantic\html\content\HtmlDropdownItem|unknown
 	 */
 	public function insertItem($item,$position=0){
@@ -190,7 +193,7 @@ 
 	 * Sets the values of a property for each item in the collection
 	 * @param string $property
 	 * @param array $values
-	 * @return HtmlCollection
+	 * @return HtmlDropdown
 	 */
 	public function setPropertyValues($property,$values){
 		$i=0;
@@ -209,6 +212,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public function getItem($index){
 		return $this->items[$index];
 	}
@@ -302,6 +308,9 @@ 
 		return $this->addToPropertyCtrl("class", $value." pointing",Direction::getConstantValues("pointing"));
 	}
 
+	/**
+	 * @param string $value
+	 */
 	public function setValue($value){
 		$this->value=$value;
 		return $this;
@@ -338,6 +347,9 @@ 
 		return $this->addToPropertyCtrl("class", "compact", array("compact"));
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function setAction($action){
 		$this->_params["action"]=$action;
 	}

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);

Ajax/semantic/html/elements/HtmlButton.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 
 	/**
 	 * define the button style
-	 * @param string|int $cssStyle
+	 * @param string $cssStyle
 	 * @return HtmlButton default : ""
 	 */
 	public function setStyle($cssStyle) {

Ajax/common/traits/JsUtilsActionsTrait.php

Doc Comments +10 added lines, -6 removed lines

@@ -11,6 +11,11 @@ 
  */
 trait JsUtilsActionsTrait {
 
+	/**
+	 * @param string $element
+	 * @param string $js
+	 * @param string $event
+	 */
 	abstract public function _add_event($element, $js, $event, $preventDefault=false, $stopPropagation=false,$immediatly=true);
 	/**
 	 * show or hide with effect
@@ -35,7 +40,7 @@ 
 	}
 	/**
 	 * Ensures the speed parameter is valid for jQuery
-	 * @param string|int $speed
+	 * @param string $speed
 	 * @return string
 	 */
 	private function _validate_speed($speed) {
@@ -364,7 +369,7 @@ 
 	 *
 	 * @param string $element
 	 * @param array $options
-	 * @return void
+	 * @return string
 	 */
 	public function sortable($element, $options=array()) {
 		if (count($options)>0) {
@@ -435,7 +440,7 @@ 
 	 * @param string $jqueryCall the JQuery callback
 	 * @param mixed $param array or string parameters
 	 * @param string $jsCallback javascript code to execute after the jquery call
-	 * @return mixed
+	 * @return string
 	 */
 	public function doJQuery($element, $jqueryCall, $param="", $jsCallback="") {
 		return $this->_doJQuery($element, $jqueryCall, $param, $jsCallback, true);
@@ -447,7 +452,7 @@ 
 	 * @param string $jqueryCall the JQuery callback
 	 * @param mixed $param array or string parameters
 	 * @param string $jsCallback javascript code to execute after the jquery call
-	 * @return mixed
+	 * @return string
 	 */
 	public function doJQueryDeferred($element, $jqueryCall, $param="", $jsCallback="") {
 		return $this->_doJQuery($element, $jqueryCall, $param, $jsCallback, false);
@@ -459,7 +464,7 @@ 
 	 * @param string $element
 	 * @param string $elementToModify
 	 * @param string $jqueryCall
-	 * @param string|array $param
+	 * @param string $param
 	 * @param boolean $preventDefault
 	 * @param boolean $stopPropagation
 	 * @param string $jsCallback javascript code to execute after the jquery call
@@ -504,7 +509,6 @@ 
 	/**
 	 * Executes the code $js
 	 * @param string $js Code to execute
-	 * @param boolean $immediatly delayed if false
 	 * @return String
 	 */
 	public function execAtLast($js) {

Ajax/semantic/html/collections/form/traits/FieldTrait.php

Doc Comments +7 added lines

@@ -17,9 +17,16 @@
  */
 trait FieldTrait {
 
+	/**
+	 * @param string $name
+	 */
 	abstract public function addToProperty($name, $value, $separator=" ");
 	abstract public function addLabel($caption, $style="label-default", $leftSeparator=" ");
 	abstract public function addContent($content,$before=false);
+
+	/**
+	 * @return string
+	 */
 	abstract public function getField();
 	abstract public function getDataField();
 

Ajax/common/html/HtmlCollection.php

Doc Comments +10 added lines

@@ -50,6 +50,10 @@ 
 		return $itemO;
 	}
 
+	/**
+	 * @param string $classname
+	 * @param integer $index
+	 */
 	protected function setItemIdentifier($item,$classname,$index){
 		if($item instanceof BaseWidget){
 			if(JString::isNull($item->getIdentifier())){
@@ -94,6 +98,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public function removeItem($index){
 		return array_splice($this->content, $index, 1);
 	}
@@ -109,6 +116,9 @@ 
 		return $this->addItem($function($object));
 	}
 
+	/**
+	 * @param \Closure $callBack
+	 */
 	public function apply($callBack){
 		foreach ($this->content as $item){
 			$callBack($item);

Ajax/semantic/widgets/base/InstanceViewer.php

Doc Comments +10 added lines, -1 removed lines

@@ -83,6 +83,9 @@ 
 
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	protected function _getDefaultValue($name,$value,$index){
 		$func=$this->defaultValueFunction;
 		return $func($name,$value,$index,$this->instance);
@@ -244,6 +247,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param callable $callback
+	 */
 	public function setValueFunction($index,$callback){
 		$this->values[$index]=$callback;
 		return $this;
@@ -254,6 +260,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public static function setIndex($index) {
 		self::$index=$index;
 	}
@@ -313,7 +322,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;