jcheron / phalcon-jquery

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

Ajax/bootstrap/html/HtmlDropdown.php

Doc Comments +12 added lines, -1 removed lines

@@ -22,6 +22,7 @@ 
 	/**
 	 *
 	 * @param string $identifier the id
+	 * @param string $cssStyle
 	 */
 	public function __construct($identifier, $value="", $items=array(), $cssStyle=null, $onClick=null) {
 		parent::__construct($identifier, "", $cssStyle, $onClick);
@@ -45,7 +46,7 @@ 
 	/**
 	 * define the button style
 	 * avaible values : "btn-default","btn-primary","btn-success","btn-info","btn-warning","btn-danger"
-	 * @param string|int $cssStyle
+	 * @param string $cssStyle
 	 * @return \Ajax\bootstrap\html\HtmlDropdown default : "btn-default"
 	 */
 	public function setStyle($cssStyle) {
@@ -149,10 +150,16 @@ 
 		return $this->items [$index];
 	}
 
+	/**
+	 * @param string $value
+	 */
 	public function setBtnClass($value) {
 		$this->class=$value;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	public function setMClass($value) {
 		$this->mClass=$value;
 	}
@@ -183,6 +190,7 @@ 
 	/**
 	 * Sets the tagName's dropdown
 	 * @see \Ajax\bootstrap\html\BaseHtml::setTagName()
+	 * @param string $tagName
 	 */
 	public function setTagName($tagName) {
 		if ($tagName=="button")
@@ -194,6 +202,9 @@ 
 		return $this->compile();
 	}
 
+	/**
+	 * @param string $btnCaption
+	 */
 	public function setBtnCaption($btnCaption) {
 		$this->btnCaption=$btnCaption;
 		return $this;

Ajax/semantic/html/base/HtmlSemNavElement.php

Doc Comments +10 added lines, -2 removed lines

@@ -22,6 +22,11 @@ 
 	protected $_contentSeparator="";
 
 
+	/**
+	 * @param string $identifier
+	 * @param string $tagName
+	 * @param string $baseClass
+	 */
 	public function __construct($identifier,$tagName,$baseClass){
 		parent::__construct($identifier,$tagName,$baseClass);
 		$this->root="";
@@ -31,7 +36,7 @@ 
 	/**
 	 * Associate an ajax get to the elements, displayed in $targetSelector
 	 * @param string $targetSelector the target of the get
-	 * @return HtmlNavElement
+	 * @return HtmlSemNavElement
 	 */
 	public function autoGetOnClick($targetSelector){
 		return $this->getOnClick($this->root, $targetSelector,array("attr"=>$this->attr));
@@ -63,7 +68,7 @@ 
 	/**
 	 * Define the html attribute for each element url in ajax
 	 * @param string $attr html attribute
-	 * @return HtmlNavElement
+	 * @return HtmlSemNavElement
 	 */
 	public function setAttr($attr) {
 		$this->attr = $attr;
@@ -103,6 +108,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	protected function getContentDivider($index){
 		if(\is_array($this->_contentSeparator)===true){
 			return @$this->_contentSeparator[$index];

Ajax/semantic/html/modules/HtmlDropdown.php

Doc Comments +7 added lines, -1 removed lines

@@ -21,6 +21,9 @@ 
 	protected $params=array("action"=>"nothing","on"=>"hover");
 	protected $input;
 
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $value="", $items=array()) {
 		parent::__construct($identifier, "div");
 		$this->_template=include dirname(__FILE__).'/../templates/tplDropdown.php';
@@ -47,7 +50,7 @@ 
 	/**
 	 * Insert an item at a position
 	 * @param mixed $item
-	 * @param number $position
+	 * @param integer $position
 	 * @return \Ajax\semantic\html\content\HtmlDropdownItem|unknown
 	 */
 	public function insertItem($item,$position=0){
@@ -196,6 +199,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function setAction($action){
 		$this->params["action"]=$action;
 	}

Ajax/bootstrap/traits/BootstrapComponentsTrait.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
 
 trait BootstrapComponentsTrait {
 
+	/**
+	 * @param string|null $attachTo
+	 */
 	public abstract function addComponent(SimpleComponent $component, $attachTo, $params);
 	/**
 	 *

Ajax/common/traits/JqueryActionsTrait.php

Doc Comments +11 added lines, -1 removed lines

@@ -3,7 +3,17 @@ 
 namespace Ajax\common\traits;
 
 trait JqueryActionsTrait {
+
+	/**
+	 * @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 $element
+	 */
 	public abstract function _prep_element($element);
 	public abstract function _prep_value($value);
 
@@ -384,7 +394,7 @@ 
 
 	/**
 	 * Ensures the speed parameter is valid for jQuery
-	 * @param string|int $speed
+	 * @param string $speed
 	 * @return string
 	 */
 	private function _validate_speed($speed) {

Ajax/semantic/html/base/traits/IconTrait.php

Doc Comments +7 added lines

@@ -7,9 +7,16 @@
 trait IconTrait {
 	private $_hasIcon=false;
 
+	/**
+	 * @param string $name
+	 * @param string $value
+	 */
 	protected abstract function addToPropertyCtrl($name, $value, $typeCtrl);
 	public abstract function addContent($content,$before=false);
 
+	/**
+	 * @param boolean $direction
+	 */
 	public function addIcon($icon,$direction=Direction::LEFT){
 		if($this->_hasIcon===false){
 			$iconO=$icon;

Ajax/semantic/html/collections/HtmlBreadcrumb.php

Doc Comments +3 added lines, -4 removed lines

@@ -57,8 +57,7 @@ 
 	 * Associate an ajax get to the breadcrumb elements, displayed in $targetSelector
 	 * $attr member is used to build each element url
 	 * @param string $targetSelector the target of the get
-	 * @param string $attr the html attribute used to build the elements url
-	 * @return HtmlBreadcrumbs
+	 * @return HtmlBreadcrumb
 	 */
 	public function autoGetOnClick($targetSelector){
 		return $this->getOnClick($this->root, $targetSelector,array("attr"=>$this->attr));
@@ -83,7 +82,7 @@ 
 	/**
 	 * Add new elements in breadcrumbs corresponding to request dispatcher : controllerName, actionName, parameters
 	 * @param Dispatcher $dispatcher the request dispatcher
-	 * @return \Ajax\bootstrap\html\HtmlBreadcrumbs
+	 * @return HtmlBreadcrumb
 	 */
 	public function fromDispatcher($dispatcher,$startIndex=0){
 		$this->startIndex=$startIndex;
@@ -120,7 +119,7 @@ 
 	/**
 	 * sets the function who generates the href elements. default : function($element){return $element->getContent()}
 	 * @param function $_hrefFunction
-	 * @return \Ajax\bootstrap\html\HtmlBreadcrumbs
+	 * @return HtmlBreadcrumb
 	 */
 	public function setHrefFunction($_hrefFunction) {
 		$this->_hrefFunction = $_hrefFunction;