jcheron / phalcon-jquery

Ajax/bootstrap/html/HtmlGridsystem.php

Doc Comments +4 added lines

@@ -16,6 +16,10 @@
 class HtmlGridSystem extends HtmlDoubleElement {
 	private $rows;
 	
+	/**
+	 * @param string $identifier
+	 * @param integer $numCols
+	 */
 	public function __construct($identifier,$numRows=1,$numCols=NULL){
 		parent::__construct($identifier,"div");
 		$this->setProperty("class", "container-fluid");

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(

Ajax/bootstrap/html/HtmlBreadcrumbs.php

Doc Comments +3 added lines, -1 removed lines

@@ -164,7 +164,6 @@ 
 	 * Associate an ajax get to the breadcrumbs 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
 	 */
 	public function autoGetOnClick($targetSelector){
@@ -178,6 +177,9 @@ 
 		return parent::contentAsString();
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	public function getElement($index){
 		return $this->content[$index];
 	}

Ajax/bootstrap/html/HtmlProgressbar.php

Doc Comments +16 added lines, -1 removed lines

@@ -19,6 +19,9 @@ 
 	protected $style="";
 	protected $styleLimits=null;
 
+	/**
+	 * @param string $identifier
+	 */
 	public function __construct($identifier, $style="info", $value=0, $max=100, $min=0) {
 		parent::__construct($identifier);
 		$this->_template=include 'templates/tplProgressbar.php';
@@ -28,6 +31,9 @@ 
 		$this->setStyle($style);
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function setActive($value) {
 		if(is_array($this->content)){
 			foreach ($this->content as $pb){
@@ -42,6 +48,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function setStriped($value) {
 		if(is_array($this->content)){
 			foreach ($this->content as $pb){
@@ -56,6 +65,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function showCaption($value) {
 		if(is_array($this->content)){
 			foreach ($this->content as $pb){
@@ -113,6 +125,9 @@ 
 		return $this->isStacked;
 	}
 
+	/**
+	 * @param boolean $isStacked
+	 */
 	public function setIsStacked($isStacked) {
 		$this->isStacked=$isStacked;
 		return $this;
@@ -121,7 +136,7 @@ 
 	/**
 	 * define the progressbar style
 	 * avaible values : "success","info","warning","danger"
-	 * @param string|int $cssStyle
+	 * @param string $cssStyle
 	 * @return \Ajax\bootstrap\html\HtmlProgressbar default : ""
 	 */
 	public function setStyle($cssStyle) {

Ajax/common/html/PropertyWrapper.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
 
 class PropertyWrapper {
 
+	/**
+	 * @param \Ajax\JsUtils $js
+	 */
 	public static function wrap($input, $js=NULL, $separator=' ', $valueQuote='"') {
 		$output="";
 		if (is_string($input)) {

Ajax/bootstrap/html/content/HtmlListgroupItem.php

Doc Comments +4 added lines, -1 removed lines

@@ -18,6 +18,9 @@ 
  */
 class HtmlListgroupItem extends HtmlElementAsContent {
 
+	/**
+	 * @param HtmlBsDoubleElement $element
+	 */
 	public function __construct($element) {
 		parent::__construct($element);
 		$this->element->setProperty("class", "list-group-item");
@@ -37,7 +40,7 @@ 
 	 * define the Panel style
 	 * avaible values : "list-group-item-default","list-group-item-primary","list-group-item-success","list-group-item-info","list-group-item-warning","list-group-item-danger"
 	 * @param string|int $cssStyle
-	 * @return \Ajax\bootstrap\html\HtmlListgroupItem default : "list-group-item-default"
+	 * @return \Ajax\common\html\HtmlSingleElement default : "list-group-item-default"
 	 */
 	public function setStyle($cssStyle) {
 		if (!PhalconUtils::startsWith($cssStyle, "list-group-item"))

Ajax/semantic/html/elements/HtmlButton.php

Doc Comments +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
 	/**
 	 * Set the button value
 	 * @param string $value
-	 * @return \Ajax\semantic\html\HtmlButton
+	 * @return HtmlButton
 	 */
 	public function setValue($value) {
 		$this->content=$value;
@@ -43,8 +43,8 @@ 
 
 	/**
 	 * define the button style
-	 * @param string|int $cssStyle
-	 * @return \Ajax\semantic\html\HtmlButton default : ""
+	 * @param string $cssStyle
+	 * @return HtmlButton default : ""
 	 */
 	public function setStyle($cssStyle) {
 		return $this->addToProperty("class",$cssStyle);
@@ -87,7 +87,7 @@ 
 	}
 
 	/**
-	 * @param string|HtmlIcon $icon
+	 * @param string $icon
 	 * @return \Ajax\semantic\html\elements\HtmlButton
 	 */
 	public function asIcon($icon){

Ajax/semantic/html/content/HtmlDropdownItem.php

Doc Comments +6 added lines

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

Ajax/common/html/BaseHtml.php

Doc Comments +32 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,6 +141,10 @@ 
 		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)) {
@@ -161,6 +169,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);
@@ -228,6 +239,9 @@ 
 
 	}
 
+	/**
+	 * @param string $before
+	 */
 	public function wrap($before, $after="") {
 		if(isset($before)){
 			$this->wrapBefore.=$before;
@@ -296,6 +310,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $operation
+	 */
 	public function _ajaxOn($operation, $event, $url, $responseElement="", $parameters=array()) {
 		$params=array (
 				"url" => $url,
@@ -306,14 +323,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);
@@ -323,6 +349,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);
@@ -372,6 +401,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $jqueryCall
+	 */
 	public function jsDoJquery($jqueryCall, $param=""){
 		return "$('#".$this->identifier."').".$jqueryCall."(".$this->_prep_value($param).");";
 	}