jcheron / phalcon-jquery

Ajax/Jquery.php

Doc Comments +32 added lines, -4 removed lines

@@ -155,7 +155,7 @@ 
 	 * Outputs a jQuery click event
 	 *
 	 * @param string $element The element to attach the event to
-	 * @param mixed $js The code to execute
+	 * @param string $js The code to execute
 	 * @param boolean $ret_false whether or not to return false
 	 * @return string
 	 */
@@ -220,6 +220,8 @@ 
 	 * @param string - element
 	 * @param string - Javascript code for mouse over
 	 * @param string - Javascript code for mouse out
+	 * @param string $over
+	 * @param string $out
 	 * @return string
 	 */
 	public function _hover($element='this', $over, $out) {
@@ -803,7 +805,7 @@ 
 	 *
 	 * @param string $element
 	 * @param array $options
-	 * @return void
+	 * @return string
 	 */
 	public function sortable($element, $options=array()) {
 		if (count($options)>0) {
@@ -934,6 +936,7 @@ 
 	/**
 	 * A wrapper for writing document.ready()
 	 *
+	 * @param string $js
 	 * @return string
 	 */
 	public function _document_ready($js) {
@@ -988,7 +991,7 @@ 
 	/**
 	 * Ensures the speed parameter is valid for jQuery
 	 *
-	 * @param string|int $speed
+	 * @param string $speed
 	 * @return string
 	 */
 	private function _validate_speed($speed) {
@@ -1003,6 +1006,10 @@ 
 		return $speed;
 	}
 	// ------------------------------------------------------------------------
+
+	/**
+	 * @param string $retour
+	 */
 	protected function addLoading(&$retour, $responseElement) {
 		$loading_notifier='<div class="ajax-loader">';
 		if ($this->ajaxLoader=='') {
@@ -1015,13 +1022,25 @@ 
 		$retour.="\t\t$(\"{$responseElement}\").prepend('{$loading_notifier}');\n";
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $jsCallback
+	 */
 	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
+	 * @param string $jsCallback
+	 */
 	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 : "";
@@ -1036,6 +1055,9 @@ 
 		return $retour;
 	}
 
+	/**
+	 * @param string $attr
+	 */
 	protected function _getAjaxUrl($url,$attr){
 		$url=$this->_correctAjaxUrl($url);
 		$retour="url='".$url."';\n";
@@ -1105,6 +1127,12 @@ 
 		return $retour;
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $form
+	 * @param string $responseElement
+	 * @param string $jsCallback
+	 */
 	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);
@@ -1212,7 +1240,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