jcheron / phalcon-jquery

Ajax/common/html/BaseHtml.php

Doc Comments +39 added lines

@@ -108,6 +108,10 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $propertyName
+	 * @param string $value
+	 */
 	protected function propertyContains($propertyName,$value){
 		$values=$this->getProperty($propertyName);
 		if(isset($values)){
@@ -137,17 +141,28 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 * @param string $value
+	 */
 	protected function removePropertyValue($name,$value){
 		$this->properties[$name]=\str_replace($value, "", $this->properties[$name]);
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected 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)) {
@@ -172,6 +187,9 @@ 
 		return $this->addToProperty($name, $value);
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function addToPropertyCtrl($name, $value, $typeCtrl) {
 		// if($this->ctrl($name, $value, $typeCtrl)===true){
 		return $this->addToPropertyUnique($name, $value, $typeCtrl);
@@ -239,6 +257,9 @@ 
 
 	}
 
+	/**
+	 * @param string $before
+	 */
 	public function wrap($before, $after="") {
 		if(isset($before)){
 			$this->wrapBefore.=$before;
@@ -307,6 +328,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $operation
+	 */
 	public function _ajaxOn($operation, $event, $url, $responseElement="", $parameters=array()) {
 		$params=array (
 				"url" => $url,
@@ -317,14 +341,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);
@@ -334,6 +367,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);
@@ -383,6 +419,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $jqueryCall
+	 */
 	public function jsDoJquery($jqueryCall, $param=""){
 		return "$('#".$this->identifier."').".$jqueryCall."(".$this->_prep_value($param).");";
 	}

Ajax/semantic/html/collections/menus/HtmlAccordionMenu.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 	protected $_tabsType="tabs";
 	protected $stacked="";
 
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $tagName="ul") {
 		parent::__construct($identifier, $tagName);
 		$this->_template="<%tagName% %properties%>%tabs%</%tagName%>%content%";

Ajax/semantic/html/collections/menus/HtmlMenu.php

Doc Comments +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
 	/**
 	 * Sets the menu type
 	 * @param string $type one of text,item
-	 * @return \Ajax\semantic\html\collections\HtmlMenu
+	 * @return HtmlMenu
 	 */
 	public function setType($type=""){
 		return $this->addToPropertyCtrl("class", $type, array("","item","text"));

Ajax/semantic/html/modules/HtmlAccordion.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 	protected $_tabsType="tabs";
 	protected $stacked="";
 
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $tagName="ul") {
 		parent::__construct($identifier, $tagName);
 		$this->_template="<%tagName% %properties%>%tabs%</%tagName%>%content%";

Ajax/semantic/html/collections/form/HtmlFormFields.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 	protected $_tabsType="tabs";
 	protected $stacked="";
 
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $tagName="ul") {
 		parent::__construct($identifier, $tagName);
 		$this->_template="<%tagName% %properties%>%tabs%</%tagName%>%content%";

Ajax/Jquery.php

Doc Comments +5 added lines, -1 removed lines

@@ -207,7 +207,7 @@ 
 	 *
 	 * @param string $element
 	 * @param array $options
-	 * @return void
+	 * @return string
 	 */
 	public function sortable($element, $options=array()) {
 		if (count($options)>0) {
@@ -351,6 +351,7 @@ 
 	/**
 	 * A wrapper for writing document.ready()
 	 *
+	 * @param string $js
 	 * @return string
 	 */
 	public function _document_ready($js) {
@@ -420,6 +421,9 @@ 
 		return $speed;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	private function minify($input) {
 	if(trim($input) === "") return $input;
 	return preg_replace(

Ajax/Semantic.php

Doc Comments -1 removed lines

@@ -93,7 +93,6 @@
 	/**
 	 * Return a new Semantic Html Breadcrumb
 	 * @param string $identifier
-	 * @param array $elements
 	 * @param boolean $autoActive sets the last element's class to <b>active</b> if true. default : true
 	 * @param function $hrefFunction the function who generates the href elements. default : function($e){return $e->getContent()}
 	 * @return HtmlBreadcrumb

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);
 
 	/**