jcheron / phalcon-jquery

Ajax/common/traits/JqueryActionsTrait.php

Doc Comments +5 added lines, -1 removed lines

@@ -3,6 +3,10 @@ 
 namespace Ajax\common\traits;
 
 trait JqueryActionsTrait {
+
+	/**
+	 * @param string $element
+	 */
 	public abstract function _prep_element($element);
 	public abstract function _prep_value($value);
 
@@ -383,7 +387,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

@@ -9,7 +9,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=='') {
@@ -22,13 +32,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 : "";
@@ -45,6 +65,9 @@ 
 			return $retour;
 	}
 
+	/**
+	 * @param string $attr
+	 */
 	protected function _getAjaxUrl($url,$attr){
 		$url=$this->_correctAjaxUrl($url);
 		$retour="url='".$url."';\n";
@@ -176,6 +199,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);
 
 	/**