phpMv / phpMv-UI

Ajax/common/html/BaseHtml.php

Doc Comments +42 added lines

@@ -124,6 +124,10 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 * @param string[] $typeCtrl
+	 */
 	protected function setMemberCtrl(&$name, $value, $typeCtrl) {
 		if ($this->ctrl($name, $value, $typeCtrl) === true) {
 			return $name=$value;
@@ -139,22 +143,35 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected function removePropertyValue($name, $value) {
 		$this->properties[$name]=\str_replace($value, "", $this->properties[$name]);
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected function removePropertyValues($name, $values) {
 		$this->removeOldValues($this->properties[$name], $values);
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function removeProperty($name) {
 		if (\array_key_exists($name, $this->properties))
 			unset($this->properties[$name]);
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 * @param string[] $typeCtrl
+	 */
 	protected function addToMemberCtrl(&$name, $value, $typeCtrl, $separator=" ") {
 		if ($this->ctrl($name, $value, $typeCtrl) === true) {
 			if (is_array($typeCtrl)) {
@@ -165,6 +182,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected function addToMember(&$name, $value, $separator=" ") {
 		$name=str_ireplace($value, "", $name) . $separator . $value;
 		return $this;
@@ -179,6 +199,9 @@ 
 		return $this->addToProperty($name, $value);
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function addToPropertyCtrl($name, $value, $typeCtrl) {
 		return $this->addToPropertyUnique($name, $value, $typeCtrl);
 	}
@@ -327,14 +350,23 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $event
+	 */
 	public function getOn($event, $url, $responseElement="", $parameters=array()) {
 		return $this->_ajaxOn("get", $event, $url, $responseElement, $parameters);
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public function getOnClick($url, $responseElement="", $parameters=array()) {
 		return $this->getOn("click", $url, $responseElement, $parameters);
 	}
 
+	/**
+	 * @param string $event
+	 */
 	public function postOn($event, $url, $params="{}", $responseElement="", $parameters=array()) {
 		$parameters["params"]=$params;
 		return $this->_ajaxOn("post", $event, $url, $responseElement, $parameters);
@@ -344,6 +376,9 @@ 
 		return $this->postOn("click", $url, $params, $responseElement, $parameters);
 	}
 
+	/**
+	 * @param string $event
+	 */
 	public function postFormOn($event, $url, $form, $responseElement="", $parameters=array()) {
 		$parameters["form"]=$form;
 		return $this->_ajaxOn("postForm", $event, $url, $responseElement, $parameters);
@@ -371,6 +406,10 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $propertyName
+	 * @param string $value
+	 */
 	protected function getElementByPropertyValue($propertyName,$value, $elements) {
 		if (is_array($elements)) {
 			$flag=false;
@@ -411,6 +450,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $jqueryCall
+	 */
 	public function jsDoJquery($jqueryCall, $param="") {
 		return "$('#" . $this->identifier . "')." . $jqueryCall . "(" . $this->_prep_value($param) . ");";
 	}

Ajax/common/html/html5/HtmlLinkTrait.php

Doc Comments +3 added lines

@@ -4,6 +4,9 @@
 
 trait HtmlLinkTrait {
 
+	/**
+	 * @param string $value
+	 */
 	public function setHref($value) {
 		$this->setProperty("href", $value);
 	}

Ajax/common/html/HtmlCollection.php

Doc Comments +6 added lines

@@ -84,6 +84,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public function removeItem($index){
 		return array_splice($this->content, $index, 1);
 	}
@@ -99,6 +102,9 @@ 
 		return $this->addItem($function($object));
 	}
 
+	/**
+	 * @param \Closure $callBack
+	 */
 	public function apply($callBack){
 		foreach ($this->content as $item){
 			$callBack($item);

Ajax/common/traits/JqueryActionsTrait.php

Doc Comments +11 added lines, -1 removed lines

@@ -3,7 +3,17 @@ 
 namespace Ajax\common\traits;
 
 trait JqueryActionsTrait {
+
+	/**
+	 * @param string $element
+	 * @param string $js
+	 * @param string $event
+	 */
 	public abstract function _add_event($element, $js, $event, $preventDefault=false, $stopPropagation=false,$immediatly=true);
+
+	/**
+	 * @param string $element
+	 */
 	public abstract function _prep_element($element);
 	public abstract function _prep_value($value);
 
@@ -384,7 +394,7 @@ 
 
 	/**
 	 * Ensures the speed parameter is valid for jQuery
-	 * @param string|int $speed
+	 * @param string $speed
 	 * @return string
 	 */
 	private function _validate_speed($speed) {

Ajax/common/traits/JqueryAjaxTrait.php

Doc Comments +28 added lines

@@ -10,7 +10,17 @@ 
 	protected $ajaxLoader='<span></span><span></span><span></span><span></span><span></span>';
 
 	public abstract function _prep_value($value);
+
+	/**
+	 * @param string $element
+	 * @param string $js
+	 * @param string $event
+	 */
 	public abstract function _add_event($element, $js, $event, $preventDefault=false, $stopPropagation=false,$immediatly=true);
+
+	/**
+	 * @param string $retour
+	 */
 	protected function addLoading(&$retour, $responseElement) {
 		$loading_notifier='<div class="ajax-loader">';
 		if ($this->ajaxLoader=='') {
@@ -23,13 +33,23 @@ 
 		$retour.="\t\t$({$responseElement}).prepend('{$loading_notifier}');\n";
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public function _get($url, $params="{}", $responseElement="", $jsCallback=NULL, $attr="id", $hasLoader=true,$immediatly=false) {
 		return $this->_ajax("get", $url,$params,$responseElement,$jsCallback,$attr,$hasLoader,$immediatly);
 	}
+
+	/**
+	 * @param string $url
+	 */
 	public function _post($url, $params="{}", $responseElement="", $jsCallback=NULL, $attr="id", $hasLoader=true,$immediatly=false) {
 		return $this->_ajax("post", $url,$params,$responseElement,$jsCallback,$attr,$hasLoader,$immediatly);
 	}
 
+	/**
+	 * @param string $method
+	 */
 	protected function _ajax($method,$url, $params="{}", $responseElement="", $jsCallback=NULL, $attr="id", $hasLoader=true,$immediatly=false) {
 		if(JString::isNull($params)){$params="{}";}
 		$jsCallback=isset($jsCallback) ? $jsCallback : "";
@@ -46,6 +66,9 @@ 
 			return $retour;
 	}
 
+	/**
+	 * @param string $attr
+	 */
 	protected function _getAjaxUrl($url,$attr){
 		$url=$this->_correctAjaxUrl($url);
 		$retour="url='".$url."';\n";
@@ -177,6 +200,11 @@ 
 		return $this->_add_event($element, $this->_jsonArray($maskSelector,$url,$method, $params,$jsCallback, $attr, $context), $event, $preventDefault, $stopPropagation,$immediatly);
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $form
+	 * @param string $responseElement
+	 */
 	public function _postForm($url, $form, $responseElement, $validation=false, $jsCallback=NULL, $attr="id", $hasLoader=true,$immediatly=false) {
 		$jsCallback=isset($jsCallback) ? $jsCallback : "";
 		$retour=$this->_getAjaxUrl($url, $attr);

Ajax/common/traits/JqueryEventsTrait.php

Doc Comments +9 added lines

@@ -3,7 +3,16 @@
 namespace Ajax\common\traits;
 
 trait JqueryEventsTrait {
+
+	/**
+	 * @param string $element
+	 */
 	public abstract function _prep_element($element);
+
+	/**
+	 * @param string $element
+	 * @param string $event
+	 */
 	public abstract function _add_event($element, $js, $event, $preventDefault=false, $stopPropagation=false,$immediatly=true);
 
 	/**

Ajax/php/yii/URI.php

Doc Comments +1 added lines, -1 removed lines

@@ -429,7 +429,7 @@
 	 *
 	 * @access public
 	 * @param array an associative array of key/values
-	 * @return array
+	 * @return string
 	 *
 	 */
 	function assoc_to_uri($array) {

Ajax/semantic/html/base/HtmlSemNavElement.php

Doc Comments +10 added lines, -2 removed lines

@@ -22,6 +22,11 @@ 
 	protected $_contentSeparator="";
 
 
+	/**
+	 * @param string $identifier
+	 * @param string $tagName
+	 * @param string $baseClass
+	 */
 	public function __construct($identifier,$tagName,$baseClass){
 		parent::__construct($identifier,$tagName,$baseClass);
 		$this->root="";
@@ -31,7 +36,7 @@ 
 	/**
 	 * Associate an ajax get to the elements, displayed in $targetSelector
 	 * @param string $targetSelector the target of the get
-	 * @return HtmlNavElement
+	 * @return HtmlSemNavElement
 	 */
 	public function autoGetOnClick($targetSelector){
 		return $this->getOnClick($this->root, $targetSelector,array("attr"=>$this->attr));
@@ -63,7 +68,7 @@ 
 	/**
 	 * Define the html attribute for each element url in ajax
 	 * @param string $attr html attribute
-	 * @return HtmlNavElement
+	 * @return HtmlSemNavElement
 	 */
 	public function setAttr($attr) {
 		$this->attr = $attr;
@@ -103,6 +108,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	protected function getContentDivider($index){
 		if(\is_array($this->_contentSeparator)===true){
 			return @$this->_contentSeparator[$index];

Ajax/semantic/html/base/traits/BaseTrait.php

Doc Comments +12 added lines

@@ -12,12 +12,24 @@
 	protected $_states=[ ];
 	protected $_baseClass;
 
+	/**
+	 * @param string $name
+	 */
 	protected abstract function setPropertyCtrl($name, $value, $typeCtrl);
 
+	/**
+	 * @param string $name
+	 */
 	protected abstract function addToPropertyCtrl($name, $value, $typeCtrl);
 
+	/**
+	 * @param string $name
+	 */
 	protected abstract function addToPropertyCtrlCheck($name, $value, $typeCtrl);
 
+	/**
+	 * @param string $name
+	 */
 	public abstract function addToProperty($name, $value, $separator=" ");
 
 	public function addVariation($variation) {