@@ -7,6 +7,9 @@ |
||
7 | 7 | class HtmlImg extends \Ajax\common\html\html5\HtmlImg { |
8 | 8 | use BaseTrait; |
9 | 9 | |
10 | + /** |
|
11 | + * @param string $identifier |
|
12 | + */ |
|
10 | 13 | public function __construct($identifier, $src="", $alt="") { |
11 | 14 | parent::__construct($identifier, $src, $alt); |
12 | 15 | $this->_baseClass="ui image"; |
@@ -24,6 +24,9 @@ discard block |
||
24 | 24 | protected $value; |
25 | 25 | protected $_associative; |
26 | 26 | |
27 | + /** |
|
28 | + * @param string $identifier |
|
29 | + */ |
|
27 | 30 | public function __construct($identifier, $value="", $items=array(),$associative=true) { |
28 | 31 | parent::__construct($identifier, "div"); |
29 | 32 | $this->_template=include dirname(__FILE__).'/../templates/tplDropdown.php'; |
@@ -67,7 +70,7 @@ discard block |
||
67 | 70 | /** |
68 | 71 | * Insert an item at a position |
69 | 72 | * @param mixed $item |
70 | - * @param number $position |
|
73 | + * @param integer $position |
|
71 | 74 | * @return \Ajax\semantic\html\content\HtmlDropdownItem|unknown |
72 | 75 | */ |
73 | 76 | public function insertItem($item,$position=0){ |
@@ -168,6 +171,9 @@ discard block |
||
168 | 171 | } |
169 | 172 | } |
170 | 173 | |
174 | + /** |
|
175 | + * @param integer $index |
|
176 | + */ |
|
171 | 177 | public function getItem($index){ |
172 | 178 | return $this->items[$index]; |
173 | 179 | } |
@@ -258,6 +264,9 @@ discard block |
||
258 | 264 | return $this->addToPropertyCtrl("class", $value." pointing",Direction::getConstantValues("pointing")); |
259 | 265 | } |
260 | 266 | |
267 | + /** |
|
268 | + * @param string $value |
|
269 | + */ |
|
261 | 270 | public function setValue($value){ |
262 | 271 | $this->value=$value; |
263 | 272 | return $this; |
@@ -292,6 +301,9 @@ discard block |
||
292 | 301 | return $this->addToPropertyCtrl("class", "compact", array("compact")); |
293 | 302 | } |
294 | 303 | |
304 | + /** |
|
305 | + * @param string $action |
|
306 | + */ |
|
295 | 307 | public function setAction($action){ |
296 | 308 | $this->_params["action"]=$action; |
297 | 309 | } |
@@ -12,6 +12,9 @@ |
||
12 | 12 | class HtmlStep extends HtmlSemCollection{ |
13 | 13 | protected $_activeStep; |
14 | 14 | |
15 | + /** |
|
16 | + * @param string $identifier |
|
17 | + */ |
|
15 | 18 | public function __construct( $identifier,$steps=array()){ |
16 | 19 | parent::__construct( $identifier,"div", "ui steps"); |
17 | 20 | $this->addItems($steps); |
@@ -53,6 +53,9 @@ discard block |
||
53 | 53 | $element->setStyle($value); |
54 | 54 | } |
55 | 55 | |
56 | + /** |
|
57 | + * @param HtmlDropdown $bt |
|
58 | + */ |
|
56 | 59 | private function dropdownAsButton($bt) { |
57 | 60 | $this->addExistingDropDown($bt); |
58 | 61 | $bt->setTagName("button"); |
@@ -81,6 +84,9 @@ discard block |
||
81 | 84 | return $result; |
82 | 85 | } |
83 | 86 | |
87 | + /** |
|
88 | + * @param integer $iid |
|
89 | + */ |
|
84 | 90 | private function _addArrayElement(array $element,$iid){ |
85 | 91 | if (array_key_exists("glyph", $element)) |
86 | 92 | $bt=new HtmlGlyphButton($this->identifier."-button-".$iid); |
@@ -49,6 +49,10 @@ discard block |
||
49 | 49 | return $itemO; |
50 | 50 | } |
51 | 51 | |
52 | + /** |
|
53 | + * @param string $classname |
|
54 | + * @param integer $index |
|
55 | + */ |
|
52 | 56 | protected function setItemIdentifier($item,$classname,$index){ |
53 | 57 | if($item instanceof BaseWidget){ |
54 | 58 | if($item->getIdentifier()===""){ |
@@ -93,6 +97,9 @@ discard block |
||
93 | 97 | return $this; |
94 | 98 | } |
95 | 99 | |
100 | + /** |
|
101 | + * @param integer $index |
|
102 | + */ |
|
96 | 103 | public function removeItem($index){ |
97 | 104 | return array_splice($this->content, $index, 1); |
98 | 105 | } |
@@ -108,6 +115,9 @@ discard block |
||
108 | 115 | return $this->addItem($function($object)); |
109 | 116 | } |
110 | 117 | |
118 | + /** |
|
119 | + * @param \Closure $callBack |
|
120 | + */ |
|
111 | 121 | public function apply($callBack){ |
112 | 122 | foreach ($this->content as $item){ |
113 | 123 | $callBack($item); |
@@ -13,15 +13,28 @@ discard block |
||
13 | 13 | * @property InstanceViewer $_instanceViewer |
14 | 14 | */ |
15 | 15 | trait DataTableFieldAsTrait{ |
16 | + |
|
17 | + /** |
|
18 | + * @param \Closure $field |
|
19 | + */ |
|
16 | 20 | abstract public function addField($field); |
21 | + |
|
22 | + /** |
|
23 | + * @param integer $index |
|
24 | + * @param \Closure $field |
|
25 | + */ |
|
17 | 26 | abstract public function insertField($index,$field); |
27 | + |
|
28 | + /** |
|
29 | + * @param \Closure $field |
|
30 | + */ |
|
18 | 31 | abstract public function insertInField($index,$field); |
19 | 32 | abstract public function fieldAs($index,$type,$attributes=NULL); |
20 | 33 | /** |
21 | 34 | * @param string $caption |
22 | 35 | * @param callable $callback |
23 | 36 | * @param boolean $visibleHover |
24 | - * @return callable |
|
37 | + * @return \Closure |
|
25 | 38 | */ |
26 | 39 | private function getFieldButtonCallable($caption,$visibleHover=true,$callback=null){ |
27 | 40 | return $this->getCallable("getFieldButton",[$caption,$visibleHover],$callback); |
@@ -31,7 +44,7 @@ discard block |
||
31 | 44 | * @param callable $thisCallback |
32 | 45 | * @param array $parameters |
33 | 46 | * @param callable $callback |
34 | - * @return callable |
|
47 | + * @return \Closure |
|
35 | 48 | */ |
36 | 49 | private function getCallable($thisCallback,$parameters,$callback=null){ |
37 | 50 | $result=function($instance) use($thisCallback,$parameters,$callback){ |
@@ -83,6 +96,9 @@ discard block |
||
83 | 96 | }, $index,$attributes); |
84 | 97 | } |
85 | 98 | |
99 | + /** |
|
100 | + * @param HtmlButton $element |
|
101 | + */ |
|
86 | 102 | protected function _visibleOver($element){ |
87 | 103 | $this->_visibleHover=true; |
88 | 104 | return $element->addToProperty("class", "visibleover")->setProperty("style","visibility:hidden;"); |
@@ -93,7 +109,7 @@ discard block |
||
93 | 109 | * @param string $caption |
94 | 110 | * @param callable $callback |
95 | 111 | * @param boolean $visibleHover |
96 | - * @return \Ajax\semantic\widgets\datatable\DataTable |
|
112 | + * @return DataTableFieldAsTrait |
|
97 | 113 | */ |
98 | 114 | public function addFieldButton($caption,$visibleHover=true,$callback=null){ |
99 | 115 | $this->addField($this->getCallable("getFieldButton",[$caption,$visibleHover],$callback)); |
@@ -105,7 +121,7 @@ discard block |
||
105 | 121 | * @param int $index |
106 | 122 | * @param string $caption |
107 | 123 | * @param callable $callback |
108 | - * @return \Ajax\semantic\widgets\datatable\DataTable |
|
124 | + * @return DataTableFieldAsTrait |
|
109 | 125 | */ |
110 | 126 | public function insertFieldButton($index,$caption,$visibleHover=true,$callback=null){ |
111 | 127 | $this->insertField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback)); |
@@ -117,18 +133,26 @@ discard block |
||
117 | 133 | * @param int $index |
118 | 134 | * @param string $caption |
119 | 135 | * @param callable $callback |
120 | - * @return \Ajax\semantic\widgets\datatable\DataTable |
|
136 | + * @return DataTableFieldAsTrait |
|
121 | 137 | */ |
122 | 138 | public function insertInFieldButton($index,$caption,$visibleHover=true,$callback=null){ |
123 | 139 | $this->insertInField($index, $this->getFieldButtonCallable($caption,$visibleHover,$callback)); |
124 | 140 | return $this; |
125 | 141 | } |
126 | 142 | |
143 | + /** |
|
144 | + * @param string $icon |
|
145 | + * @param string $class |
|
146 | + */ |
|
127 | 147 | private function addDefaultButton($icon,$class=null,$visibleHover=true,$callback=null){ |
128 | 148 | $this->addField($this->getCallable("getDefaultButton",[$icon,$class,$visibleHover],$callback)); |
129 | 149 | return $this; |
130 | 150 | } |
131 | 151 | |
152 | + /** |
|
153 | + * @param string $icon |
|
154 | + * @param string $class |
|
155 | + */ |
|
132 | 156 | private function insertDefaultButtonIn($index,$icon,$class=null,$visibleHover=true,$callback=null){ |
133 | 157 | $this->insertInField($index,$this->getCallable("getDefaultButton",[$icon,$class,$visibleHover],$callback)); |
134 | 158 | return $this; |
@@ -146,7 +170,7 @@ discard block |
||
146 | 170 | * @param boolean $visibleHover |
147 | 171 | * @param array $deleteBehavior |
148 | 172 | * @param callable $callback |
149 | - * @return DataTable |
|
173 | + * @return DataTableFieldAsTrait |
|
150 | 174 | */ |
151 | 175 | public function addDeleteButton($visibleHover=true,$deleteBehavior=[],$callback=null){ |
152 | 176 | $this->_deleteBehavior=$deleteBehavior; |
@@ -15,6 +15,7 @@ |
||
15 | 15 | * {@inheritdoc} |
16 | 16 | * |
17 | 17 | * @see \Ajax\semantic\widgets\dataform\DataForm::__construct() |
18 | + * @param string $identifier |
|
18 | 19 | */ |
19 | 20 | public function __construct($identifier,$modelInstance=null,$fieldsOrder,$fieldsDefinition,$fields=[],$captions=[],$separators=[]) { |
20 | 21 | if(!isset($modelInstance)){ |
@@ -18,6 +18,9 @@ discard block |
||
18 | 18 | private $_container; |
19 | 19 | private $_row; |
20 | 20 | |
21 | + /** |
|
22 | + * @param string $identifier |
|
23 | + */ |
|
21 | 24 | public function __construct($identifier) { |
22 | 25 | parent::__construct($identifier, "tr", ""); |
23 | 26 | $this->_states=[ State::ACTIVE,State::POSITIVE,State::NEGATIVE,State::WARNING,State::ERROR,State::DISABLED ]; |
@@ -78,6 +81,7 @@ discard block |
||
78 | 81 | /** |
79 | 82 | * Sets or adds values to the row cols |
80 | 83 | * @param mixed $values |
84 | + * @param \Closure $callback |
|
81 | 85 | */ |
82 | 86 | protected function _addOrSetValues($values,$callback) { |
83 | 87 | $count=$this->count(); |
@@ -63,6 +63,9 @@ discard block |
||
63 | 63 | |
64 | 64 | |
65 | 65 | |
66 | + /** |
|
67 | + * @param string $op |
|
68 | + */ |
|
66 | 69 | protected function _generateBehavior($op,$params,JsUtils $js){ |
67 | 70 | if(isset($this->_urls[$op])){ |
68 | 71 | $params=\array_merge($params,["attr"=>"data-ajax"]); |
@@ -139,6 +142,9 @@ discard block |
||
139 | 142 | } |
140 | 143 | } |
141 | 144 | |
145 | + /** |
|
146 | + * @param string $checkedClass |
|
147 | + */ |
|
142 | 148 | protected function _generateRow($instance,&$table,$checkedClass=null){ |
143 | 149 | $this->_instanceViewer->setInstance($instance); |
144 | 150 | InstanceViewer::$index++; |
@@ -215,6 +221,9 @@ discard block |
||
215 | 221 | return $this; |
216 | 222 | } |
217 | 223 | |
224 | + /** |
|
225 | + * @param PositionInTable $part |
|
226 | + */ |
|
218 | 227 | private function addToolbarRow($part,$table,$captions){ |
219 | 228 | $hasPart=$table->hasPart($part); |
220 | 229 | if($hasPart){ |
@@ -254,7 +263,7 @@ discard block |
||
254 | 263 | * Paginates the DataTable element with a Semantic HtmlPaginationMenu component |
255 | 264 | * @param number $page the active page number |
256 | 265 | * @param number $total_rowcount the total number of items |
257 | - * @param number $items_per_page The number of items per page |
|
266 | + * @param integer $items_per_page The number of items per page |
|
258 | 267 | * @param number $pages_visibles The number of visible pages in the Pagination component |
259 | 268 | * @return DataTable |
260 | 269 | */ |
@@ -265,9 +274,9 @@ discard block |
||
265 | 274 | |
266 | 275 | /** |
267 | 276 | * Auto Paginates the DataTable element with a Semantic HtmlPaginationMenu component |
268 | - * @param number $page the active page number |
|
269 | - * @param number $items_per_page The number of items per page |
|
270 | - * @param number $pages_visibles The number of visible pages in the Pagination component |
|
277 | + * @param integer $page the active page number |
|
278 | + * @param integer $items_per_page The number of items per page |
|
279 | + * @param integer $pages_visibles The number of visible pages in the Pagination component |
|
271 | 280 | * @return DataTable |
272 | 281 | */ |
273 | 282 | public function autoPaginate($page=1,$items_per_page=10,$pages_visibles=4){ |
@@ -333,6 +342,9 @@ discard block |
||
333 | 342 | return $this; |
334 | 343 | } |
335 | 344 | |
345 | + /** |
|
346 | + * @return string |
|
347 | + */ |
|
336 | 348 | public function getRefreshSelector() { |
337 | 349 | if(isset($this->_refreshSelector)) |
338 | 350 | return $this->_refreshSelector; |