jcheron / phalcon-jquery

Ajax/semantic/html/elements/HtmlDivider.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/elements/HtmlLabel.php

Doc Comments +4 added lines, -1 removed lines

@@ -10,13 +10,16 @@
 
 class HtmlLabel extends HtmlSemDoubleElement {
 	use LabeledIconTrait;
+
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier,$caption="",$tagName="div") {
 		parent::__construct($identifier,$tagName,"ui label");
 		$this->content=$caption;
 	}
 
 	/**
-	 * @param string $side
 	 * @return \Ajax\semantic\html\elements\HtmlLabel
 	 */
 	public function setPointing($value=Direction::NONE){

Ajax/semantic/html/collections/HtmlBreadcrumb.php

Doc Comments +2 added lines, -3 removed lines

@@ -55,8 +55,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));
@@ -118,7 +117,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;

Ajax/common/html/HtmlCollection.php

Doc Comments +6 added lines

@@ -87,6 +87,9 @@ 
 		$this->addItem($function($object));
 	}
 
+	/**
+	 * @param \Closure $callBack
+	 */
 	public function apply($callBack){
 		foreach ($this->content as $item){
 			$callBack($item);
@@ -121,6 +124,9 @@ 
 		return $this->_bsComponent;
 	}
 
+	/**
+	 * @param string $tagName
+	 */
 	protected function contentAs($tagName){
 		foreach ($this->content as $item){
 			$item->setTagName($tagName);

Ajax/semantic/html/base/HtmlSemNavElement.php

Doc Comments +10 added lines, -3 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="";
@@ -32,8 +37,7 @@ 
 	 * Associate an ajax get to the 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 HtmlNavElement
+	 * @return HtmlSemNavElement
 	 */
 	public function autoGetOnClick($targetSelector){
 		return $this->getOnClick($this->root, $targetSelector,array("attr"=>$this->attr));
@@ -65,7 +69,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;
@@ -105,6 +109,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	protected function getContentDivider($index){
 		if(\is_array($this->_contentSeparator)===true){
 			return @$this->_contentSeparator[$index];

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

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
 trait IconTrait {
 	private $_hasIcon=false;
 
+	/**
+	 * @param boolean $direction
+	 */
 	public function addIcon($icon,$direction=Direction::LEFT){
 		if($this->_hasIcon===false){
 			$iconO=$icon;

Ajax/semantic/html/content/HtmlDropdownItem.php

Doc Comments +7 added lines

@@ -11,6 +11,10 @@ 
 
 class HtmlDropdownItem extends HtmlSemDoubleElement {
 	use IconTrait;
+
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $content="",$value=NULL,$image=NULL) {
 		parent::__construct($identifier, "a");
 		$this->setClass("item");
@@ -61,6 +65,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function setContent($content){
 		if($content==="-"){
 			$this->asDivider();

Ajax/Semantic.php

Doc Comments +9 added lines, -4 removed lines

@@ -41,7 +41,7 @@ 
 	 *
 	 * @param string $attachTo
 	 * @param string|array $params
-	 * @return $this
+	 * @return common\components\SimpleComponent
 	 */
 	public function generic($attachTo=NULL, $params=NULL) {
 		return $this->addComponent(new GenericComponent($this->js), $attachTo, $params);
@@ -50,16 +50,22 @@ 
 	 *
 	 * @param string $attachTo
 	 * @param string|array $params
-	 * @return $this
+	 * @return common\components\SimpleComponent
 	 */
 	public function popup($attachTo=NULL, $params=NULL) {
 		return $this->addComponent(new Popup($this->js), $attachTo, $params);
 	}
 
+	/**
+	 * @param string $attachTo
+	 */
 	public function dropdown($attachTo=NULL, $params=NULL) {
 		return $this->addComponent(new Dropdown($this->js), $attachTo, $params);
 	}
 
+	/**
+	 * @param string $attachTo
+	 */
 	public function accordion($attachTo=NULL, $params=NULL) {
 		return $this->addComponent(new Accordion($this->js), $attachTo, $params);
 	}
@@ -220,7 +226,7 @@ 
 
 	/**
 	 * @param string $identifier
-	 * @param number $niveau
+	 * @param integer $niveau
 	 * @param mixed $content
 	 * @param string $type
 	 */
@@ -239,7 +245,6 @@ 
 	/**
 	 * Return a new Seamntic 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/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).");";
 	}