jcheron / phalcon-jquery

Ajax/Jquery.php

Doc Comments +35 added lines, -4 removed lines

@@ -159,7 +159,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
 	 */
@@ -235,6 +235,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) {
@@ -768,7 +770,7 @@ 
 	 *
 	 * @param string $element
 	 * @param array $options
-	 * @return void
+	 * @return string
 	 */
 	public function sortable($element, $options=array()) {
 		if (count($options)>0) {
@@ -904,6 +906,7 @@ 
 	/**
 	 * A wrapper for writing document.ready()
 	 *
+	 * @param string $js
 	 * @return string
 	 */
 	public function _document_ready($js) {
@@ -958,7 +961,7 @@ 
 	/**
 	 * Ensures the speed parameter is valid for jQuery
 	 *
-	 * @param string|int $speed
+	 * @param string $speed
 	 * @return string
 	 */
 	private function _validate_speed($speed) {
@@ -973,6 +976,10 @@ 
 		return $speed;
 	}
 	// ------------------------------------------------------------------------
+
+	/**
+	 * @param string $retour
+	 */
 	protected function addLoading(&$retour, $responseElement) {
 		$loading_notifier='<div class="ajax-loader">';
 		if ($this->ajaxLoader=='') {
@@ -985,13 +992,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 : "";
@@ -1008,6 +1027,9 @@ 
 		return $retour;
 	}
 
+	/**
+	 * @param string $attr
+	 */
 	protected function _getAjaxUrl($url,$attr){
 		$url=$this->_correctAjaxUrl($url);
 		$retour="url='".$url."';\n";
@@ -1139,6 +1161,12 @@ 
 		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
+	 * @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);
@@ -1252,7 +1280,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
@@ -1290,6 +1318,9 @@ 
 		return $this->_add_event($element, $this->_exec($js), $event, $preventDefault, $stopPropagation,$immediatly);
 	}
 
+	/**
+	 * @param string $input
+	 */
 	private function minify($input) {
 	if(trim($input) === "") return $input;
 	return preg_replace(

Braces +98 added lines, -66 removed lines

@@ -424,8 +424,9 @@ 
 		$element=$this->_prep_element($element);
 		$value=$this->_prep_value($value);
 		$str="$({$element}).after({$value});";
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -441,10 +442,12 @@ 
 		if (isset($value)) {
 			$value=$this->_prep_value($value);
 			$str="$({$element}).attr(\"$attributeName\",{$value});";
-		} else
-			$str="$({$element}).attr(\"$attributeName\");";
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		} else {
+					$str="$({$element}).attr(\"$attributeName\");";
+		}
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -460,10 +463,12 @@ 
 		if (isset($param)) {
 			$param=$this->_prep_value($param);
 			$str="$({$element}).{$jQueryCall}({$param});";
-		} else
-			$str="$({$element}).{$jQueryCall}();";
-			if ($immediatly)
-				$this->jquery_code_for_compile[]=$str;
+		} else {
+					$str="$({$element}).{$jQueryCall}();";
+		}
+			if ($immediatly) {
+							$this->jquery_code_for_compile[]=$str;
+			}
 			return $str;
 	}
 	/**
@@ -478,8 +483,9 @@ 
 		$to=$this->_prep_element($to);
 		$element=$this->_prep_element($element);
 		$str="$({$to}).{$jQueryCall}({$element});";
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 			return $str;
 	}
 	// --------------------------------------------------------------------
@@ -516,8 +522,9 @@ 
 
 		$str="$({$element}).animate({\n$animations\n\t\t}".$speed.$extra.");";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -542,8 +549,9 @@ 
 
 		$str="$({$element}).fadeIn({$speed}{$callback});";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -568,8 +576,9 @@ 
 
 		$str="$({$element}).fadeOut({$speed}{$callback});";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -594,8 +603,9 @@ 
 
 		$str="$({$element}).hide({$speed}{$callback});";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -622,8 +632,9 @@ 
 
 		$str="$({$element}).slideUp({$speed}{$callback});";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -648,8 +659,9 @@ 
 
 		$str="$({$element}).slideDown({$speed}{$callback});";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -674,8 +686,9 @@ 
 
 		$str="$({$element}).slideToggle({$speed}{$callback});";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -692,8 +705,9 @@ 
 		$element=$this->_prep_element($element);
 		$str="$({$element}).toggle();";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -709,8 +723,9 @@ 
 		$element=$this->_prep_element($element);
 		$str="$({$element}).trigger(\"$event\");";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -735,8 +750,9 @@ 
 
 		$str="$({$element}).show({$speed}{$callback});";
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -754,8 +770,9 @@ 
 			$str.="else{".$jsCodeIfFalse."}";
 		}
 
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$str;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$str;
+		}
 		return $str;
 	}
 
@@ -821,12 +838,14 @@ 
 		if ($stopPropagation===true) {
 			$js="event.stopPropagation();\n".$js;
 		}
-		if (array_search($event, $this->jquery_events)===false)
-			$event="\n\t$(".$this->_prep_element($element).").bind('{$event}',function(event){\n\t\t{$js}\n\t});\n";
-		else
-			$event="\n\t$(".$this->_prep_element($element).").{$event}(function(event){\n\t\t{$js}\n\t});\n";
-		if($immediatly)
-			$this->jquery_code_for_compile[]=$event;
+		if (array_search($event, $this->jquery_events)===false) {
+					$event="\n\t$(".$this->_prep_element($element).").bind('{$event}',function(event){\n\t\t{$js}\n\t});\n";
+		} else {
+					$event="\n\t$(".$this->_prep_element($element).").{$event}(function(event){\n\t\t{$js}\n\t});\n";
+		}
+		if($immediatly) {
+					$this->jquery_code_for_compile[]=$event;
+		}
 		return $event;
 	}
 
@@ -879,8 +898,9 @@ 
 		}
 		$output=($script_tags===FALSE) ? $script : $this->inline($script);
 
-		if ($view!=NULL)
-			$view->setVar($view_var, $output);
+		if ($view!=NULL) {
+					$view->setVar($view_var, $output);
+		}
 		return $output;
 	}
 
@@ -1003,8 +1023,9 @@ 
 		}
 		$retour.="$.".$method."(url,".$params.").done(function( data ) {\n";
 		$retour.=$this->_getOnAjaxDone($responseElement, $jsCallback)."});\n";
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$retour;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$retour;
+		}
 		return $retour;
 	}
 
@@ -1012,13 +1033,15 @@ 
 		$url=$this->_correctAjaxUrl($url);
 		$retour="url='".$url."';\n";
 		$slash="/";
-		if(PhalconUtils::endsWith($url, "/"))
-			$slash="";
+		if(PhalconUtils::endsWith($url, "/")) {
+					$slash="";
+		}
 		if(JString::isNotNull($attr)){
-			if ($attr=="value")
-				$retour.="url=url+'".$slash."'+$(this).val();\n";
-			else if($attr!=null && $attr!=="")
-				$retour.="url=url+'".$slash."'+$(this).attr('".$attr."');\n";
+			if ($attr=="value") {
+							$retour.="url=url+'".$slash."'+$(this).val();\n";
+			} else if($attr!=null && $attr!=="") {
+							$retour.="url=url+'".$slash."'+$(this).attr('".$attr."');\n";
+			}
 		}
 		return $retour;
 	}
@@ -1040,8 +1063,9 @@ 
 	}
 
 	protected function _correctAjaxUrl($url) {
-		if (PhalconUtils::endsWith($url, "/"))
-			$url=substr($url, 0, strlen($url)-1);
+		if (PhalconUtils::endsWith($url, "/")) {
+					$url=substr($url, 0, strlen($url)-1);
+		}
 		if (strncmp($url, 'http://', 7)!=0&&strncmp($url, 'https://', 8)!=0) {
 			$url=$this->_di->get("url")->get($url);
 		}
@@ -1065,8 +1089,9 @@ 
 		$retour.="\t".$jsCallback."\n".
 				"\t$(document).trigger('jsonReady',[data]);\n".
 		"});\n";
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$retour;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$retour;
+		}
 		return $retour;
 	}
 
@@ -1105,7 +1130,7 @@ 
 		if($context===null){
 			$appendTo="\t\tnewElm.appendTo($('".$maskSelector."').parent());\n";
 			$newElm = "$('#'+newId)";
-		}else{
+		} else{
 			$appendTo="\t\tnewElm.appendTo(".$context.");\n";
 			$newElm = $context.".find('#'+newId)";
 		}
@@ -1115,8 +1140,9 @@ 
 		$retour.="\t}\n"."\tfor(var key in value){\n"."\t\t\tvar html = $('<div />').append($(newElm).clone()).html();\n"."\t\t\tif(html.indexOf('[['+key+']]')>-1){\n"."\t\t\t\tcontent=$(html.split('[['+key+']]').join(value[key]));\n"."\t\t\t\t$(newElm).replaceWith(content);newElm=content;\n"."\t\t\t}\n"."\t\tvar sel='[data-id=\"'+key+'\"]';if($(sel,newElm).length){\n"."\t\t\tvar selElm=$(sel,newElm);\n"."\t\t\t if(selElm.is('[value]')) { selElm.attr('value',value[key]);selElm.val(value[key]);} else { selElm.html(value[key]); }\n"."\t\t}\n"."}\n"."\t$(newElm).show(true);"."\n"."\t$(newElm).removeClass('hide');"."});\n";
 		$retour.="\t$(document).trigger('jsonReady',[data]);\n";
 		$retour.="\t".$jsCallback."\n"."});\n";
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$retour;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$retour;
+		}
 		return $retour;
 	}
 	/**
@@ -1157,8 +1183,9 @@ 
 			}});\n";
 			$retour.="$('#".$form."').submit();\n";
 		}
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$retour;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$retour;
+		}
 		return $retour;
 	}
 
@@ -1238,11 +1265,13 @@ 
 	public function _doJQuery($element, $jqueryCall, $param="", $jsCallback="", $immediatly=false) {
 		$param=$this->_prep_value($param);
 		$callback="";
-		if ($jsCallback!="")
-			$callback=", function(event){\n{$jsCallback}\n}";
+		if ($jsCallback!="") {
+					$callback=", function(event){\n{$jsCallback}\n}";
+		}
 		$script="$(".$this->_prep_element($element).").".$jqueryCall."(".$param.$callback.");\n";
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$script;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$script;
+		}
 		return $script;
 	}
 
@@ -1271,8 +1300,9 @@ 
 	 */
 	public function _exec($js, $immediatly=false) {
 		$script=$js."\n";
-		if ($immediatly)
-			$this->jquery_code_for_compile[]=$script;
+		if ($immediatly) {
+					$this->jquery_code_for_compile[]=$script;
+		}
 		return $script;
 	}
 
@@ -1291,7 +1321,9 @@ 
 	}
 
 	private function minify($input) {
-	if(trim($input) === "") return $input;
+	if(trim($input) === "") {
+		return $input;
+	}
 	return preg_replace(
 			array(
 					// Remove comment(s)