phpMv / phpMv-UI

Ajax/common/traits/JsUtilsActionsTrait.php

Doc Comments +5 added lines, -5 removed lines

@@ -13,7 +13,7 @@ 
 
 	/**
 	 * Ensures the speed parameter is valid for jQuery
-	 * @param string|int $speed
+	 * @param string $speed
 	 * @return string
 	 */
 	private function _validate_speed($speed) {
@@ -422,7 +422,7 @@ 
 	 *
 	 * @param string $element
 	 * @param array $options
-	 * @return void
+	 * @return string
 	 */
 	public function sortable($element, $options=array()) {
 		if (count($options)>0) {
@@ -493,7 +493,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);
@@ -505,7 +505,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);
@@ -517,7 +517,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

Ajax/common/traits/JsUtilsAjaxTrait.php

Doc Comments +31 added lines

@@ -16,8 +16,17 @@ 
 	protected $ajaxLoader='<span></span><span></span><span></span><span></span><span></span>';
 
 	abstract public function getUrl($url);
+
+	/**
+	 * @param string $element
+	 * @param string $js
+	 * @param string $event
+	 */
 	abstract public function _add_event($element, $js, $event, $preventDefault=false, $stopPropagation=false,$immediatly=true);
 
+	/**
+	 * @param string $method
+	 */
 	protected function _ajax($method,$url, $params="{}", $responseElement="", $jsCallback=NULL, $attr="id", $hasLoader=true,$jqueryDone="html",$ajaxTransition=null,$immediatly=false) {
 		if(JString::isNull($params)){$params="{}";}
 		$jsCallback=isset($jsCallback) ? $jsCallback : "";
@@ -36,6 +45,9 @@ 
 
 
 
+	/**
+	 * @param string $attr
+	 */
 	protected function _getAjaxUrl($url,$attr){
 		$url=$this->_correctAjaxUrl($url);
 		$retour="url='".$url."';";
@@ -53,6 +65,9 @@ 
 			return $retour;
 	}
 
+	/**
+	 * @param string $jqueryDone
+	 */
 	protected function _getOnAjaxDone($responseElement,$jqueryDone,$ajaxTransition,$jsCallback){
 		$retour="";$call=null;
 		if ($responseElement!=="") {
@@ -86,6 +101,9 @@ 
 			return $url;
 	}
 
+	/**
+	 * @param string $retour
+	 */
 	protected function addLoading(&$retour, $responseElement) {
 		$loading_notifier='<div class="ajax-loader">';
 		if ($this->ajaxLoader=='') {
@@ -252,6 +270,7 @@ 
 	 * @param string $rowClass the css class for the new element
 	 * @param string $context jquery DOM element, array container.
 	 * @param boolean $immediatly
+	 * @param string $maskSelector
 	 */
 	public function jsonArray($maskSelector, $url, $method="get", $params="{}", $jsCallback=NULL,$rowClass="_json",$context=NULL,$immediatly=false) {
 		return $this->_jsonArray($maskSelector, $url,$method,$params,$jsCallback,$rowClass,$context,NULL,$immediatly);
@@ -342,6 +361,11 @@ 
 		return $this->getOn("click", $element, $url, $responseElement, $parameters);
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $jsCallback
+	 * @param callable $ajaxTransition
+	 */
 	private function _post($url, $params="{}", $responseElement="", $jsCallback=NULL, $attr="id", $hasLoader=true,$jqueryDone="html",$ajaxTransition=null,$immediatly=false) {
 		return $this->_ajax("post", $url,$params,$responseElement,$jsCallback,$attr,$hasLoader,$jqueryDone,$ajaxTransition,$immediatly);
 	}
@@ -412,6 +436,13 @@ 
 		return $this->postOn("click", $element, $url, $params, $responseElement, $parameters);
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $form
+	 * @param string $responseElement
+	 * @param string $jsCallback
+	 * @param callable $ajaxTransition
+	 */
 	private function _postForm($url, $form, $responseElement, $validation=false, $jsCallback=NULL, $attr="id", $hasLoader=true,$jqueryDone="html",$ajaxTransition=null,$immediatly=false) {
 		$jsCallback=isset($jsCallback) ? $jsCallback : "";
 		$retour=$this->_getAjaxUrl($url, $attr);