Completed
Push — master ( 3c0bc3...b6875a )
by Jean-Christophe
03:24
created
Ajax/semantic/html/collections/table/HtmlTable.php 1 patch
Doc Comments   +12 added lines, -5 removed lines patch added patch discarded remove patch
@@ -23,6 +23,10 @@  discard block
 block discarded – undo
23 23
 	private $_footer;
24 24
 	private $_afterCompileEvents;
25 25
 
26
+	/**
27
+	 * @param integer $rowCount
28
+	 * @param integer $colCount
29
+	 */
26 30
 	public function __construct($identifier, $rowCount, $colCount) {
27 31
 		parent::__construct($identifier, "table", "ui table");
28 32
 		$this->content=array ();
@@ -112,7 +116,7 @@  discard block
 block discarded – undo
112 116
 	/**
113 117
 	 * Retuns the row at $rowIndex
114 118
 	 * @param int $rowIndex
115
-	 * @return \Ajax\semantic\html\content\HtmlTR
119
+	 * @return \Ajax\common\html\HtmlDoubleElement
116 120
 	 */
117 121
 	public function getRow($rowIndex) {
118 122
 		return $this->getBody()->getRow($rowIndex);
@@ -154,7 +158,7 @@  discard block
 block discarded – undo
154 158
 	 * Sets values to the col at index $colIndex
155 159
 	 * @param int $colIndex
156 160
 	 * @param array $values
157
-	 * @return \Ajax\semantic\html\collections\HtmlTable
161
+	 * @return HtmlTable
158 162
 	 */
159 163
 	public function setColValues($colIndex, $values=array()) {
160 164
 		$this->getBody()->setColValues($colIndex, $values);
@@ -165,7 +169,7 @@  discard block
 block discarded – undo
165 169
 	 * Sets values to the row at index $rowIndex
166 170
 	 * @param int $rowIndex
167 171
 	 * @param array $values
168
-	 * @return \Ajax\semantic\html\collections\HtmlTable
172
+	 * @return HtmlTable
169 173
 	 */
170 174
 	public function setRowValues($rowIndex, $values=array()) {
171 175
 		$this->getBody()->setRowValues($rowIndex, $values);
@@ -188,6 +192,9 @@  discard block
 block discarded – undo
188 192
 		return $this->colAlign($colIndex, "colLeft");
189 193
 	}
190 194
 
195
+	/**
196
+	 * @param string $function
197
+	 */
191 198
 	private function colAlign($colIndex, $function) {
192 199
 		if (\is_array($colIndex)) {
193 200
 			foreach ( $colIndex as $cIndex ) {
@@ -263,7 +270,7 @@  discard block
 block discarded – undo
263 270
 
264 271
 	/**
265 272
 	 * @param array $parts
266
-	 * @return \Ajax\semantic\html\collections\HtmlTable
273
+	 * @return HtmlTable
267 274
 	 */
268 275
 	public function setCompileParts($parts=["tbody"]) {
269 276
 		$this->_compileParts=$parts;
@@ -286,7 +293,7 @@  discard block
 block discarded – undo
286 293
 	 * The callback function called after the insertion of each row when fromDatabaseObjects is called
287 294
 	 * callback function takes the parameters $row : the row inserted and $object: the instance of model used
288 295
 	 * @param callable $callback
289
-	 * @return \Ajax\semantic\html\collections\HtmlTable
296
+	 * @return HtmlTable
290 297
 	 */
291 298
 	public function onNewRow($callback) {
292 299
 		$this->_afterCompileEvents["onNewRow"]=$callback;
Please login to merge, or discard this patch.
Ajax/bootstrap/html/HtmlBreadcrumbs.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -177,6 +177,9 @@
 block discarded – undo
177 177
 		return parent::contentAsString();
178 178
 	}
179 179
 
180
+	/**
181
+	 * @param integer $index
182
+	 */
180 183
 	public function getElement($index){
181 184
 		return $this->content[$index];
182 185
 	}
Please login to merge, or discard this patch.
Ajax/common/html/BaseHtml.php 1 patch
Doc Comments   +27 added lines patch added patch discarded remove patch
@@ -124,6 +124,10 @@  discard block
 block discarded – undo
124 124
 		return $this;
125 125
 	}
126 126
 
127
+	/**
128
+	 * @param string $name
129
+	 * @param string[] $typeCtrl
130
+	 */
127 131
 	protected function setMemberCtrl(&$name, $value, $typeCtrl) {
128 132
 		if ($this->ctrl($name, $value, $typeCtrl) === true) {
129 133
 			return $name=$value;
@@ -139,22 +143,35 @@  discard block
 block discarded – undo
139 143
 		return $this;
140 144
 	}
141 145
 
146
+	/**
147
+	 * @param string $name
148
+	 */
142 149
 	protected function removePropertyValue($name, $value) {
143 150
 		$this->properties[$name]=\str_replace($value, "", $this->properties[$name]);
144 151
 		return $this;
145 152
 	}
146 153
 
154
+	/**
155
+	 * @param string $name
156
+	 */
147 157
 	protected function removePropertyValues($name, $values) {
148 158
 		$this->removeOldValues($this->properties[$name], $values);
149 159
 		return $this;
150 160
 	}
151 161
 
162
+	/**
163
+	 * @param string $name
164
+	 */
152 165
 	public function removeProperty($name) {
153 166
 		if (\array_key_exists($name, $this->properties))
154 167
 			unset($this->properties[$name]);
155 168
 		return $this;
156 169
 	}
157 170
 
171
+	/**
172
+	 * @param string $name
173
+	 * @param string[] $typeCtrl
174
+	 */
158 175
 	protected function addToMemberCtrl(&$name, $value, $typeCtrl, $separator=" ") {
159 176
 		if ($this->ctrl($name, $value, $typeCtrl) === true) {
160 177
 			if (is_array($typeCtrl)) {
@@ -165,6 +182,9 @@  discard block
 block discarded – undo
165 182
 		return $this;
166 183
 	}
167 184
 
185
+	/**
186
+	 * @param string $name
187
+	 */
168 188
 	protected function addToMember(&$name, $value, $separator=" ") {
169 189
 		$name=str_ireplace($value, "", $name) . $separator . $value;
170 190
 		return $this;
@@ -179,6 +199,9 @@  discard block
 block discarded – undo
179 199
 		return $this->addToProperty($name, $value);
180 200
 	}
181 201
 
202
+	/**
203
+	 * @param string $name
204
+	 */
182 205
 	public function addToPropertyCtrl($name, $value, $typeCtrl) {
183 206
 		return $this->addToPropertyUnique($name, $value, $typeCtrl);
184 207
 	}
@@ -283,6 +306,10 @@  discard block
 block discarded – undo
283 306
 		return null;
284 307
 	}
285 308
 
309
+	/**
310
+	 * @param string $propertyName
311
+	 * @param string $value
312
+	 */
286 313
 	protected function getElementByPropertyValue($propertyName,$value, $elements) {
287 314
 		if (is_array($elements)) {
288 315
 			$flag=false;
Please login to merge, or discard this patch.
Ajax/semantic/html/elements/HtmlButtonGroups.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -13,6 +13,9 @@
 block discarded – undo
13 13
  */
14 14
 class HtmlIconGroups extends HtmlSemCollection {
15 15
 
16
+	/**
17
+	 * @param string $identifier
18
+	 */
16 19
 	public function __construct($identifier, $icons=array(), $size="") {
17 20
 		parent::__construct($identifier, "i", "icons");
18 21
 		$this->addItems($icons);
Please login to merge, or discard this patch.
Ajax/semantic/html/modules/HtmlDropdown.php 1 patch
Doc Comments   +10 added lines, -1 removed lines patch added patch discarded remove patch
@@ -63,7 +63,7 @@  discard block
 block discarded – undo
63 63
 	/**
64 64
 	 * Insert an item at a position
65 65
 	 * @param mixed $item
66
-	 * @param number $position
66
+	 * @param integer $position
67 67
 	 * @return \Ajax\semantic\html\content\HtmlDropdownItem|unknown
68 68
 	 */
69 69
 	public function insertItem($item,$position=0){
@@ -164,6 +164,9 @@  discard block
 block discarded – undo
164 164
 		}
165 165
 	}
166 166
 
167
+	/**
168
+	 * @param integer $index
169
+	 */
167 170
 	public function getItem($index){
168 171
 		return $this->items[$index];
169 172
 	}
@@ -254,6 +257,9 @@  discard block
 block discarded – undo
254 257
 		return $this->addToPropertyCtrl("class", $value." pointing",Direction::getConstantValues("pointing"));
255 258
 	}
256 259
 
260
+	/**
261
+	 * @param string $value
262
+	 */
257 263
 	public function setValue($value){
258 264
 		$this->value=$value;
259 265
 		return $this;
@@ -288,6 +294,9 @@  discard block
 block discarded – undo
288 294
 		return $this->addToPropertyCtrl("class", "compact", array("compact"));
289 295
 	}
290 296
 
297
+	/**
298
+	 * @param string $action
299
+	 */
291 300
 	public function setAction($action){
292 301
 		$this->_params["action"]=$action;
293 302
 	}
Please login to merge, or discard this patch.
Ajax/semantic/html/elements/html5/HtmlImg.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -13,6 +13,9 @@
 block discarded – undo
13 13
  */
14 14
 class HtmlIconGroups extends HtmlSemCollection {
15 15
 
16
+	/**
17
+	 * @param string $identifier
18
+	 */
16 19
 	public function __construct($identifier, $icons=array(), $size="") {
17 20
 		parent::__construct($identifier, "i", "icons");
18 21
 		$this->addItems($icons);
Please login to merge, or discard this patch.
Ajax/semantic/html/base/traits/BaseTrait.php 1 patch
Doc Comments   +22 added lines, -1 removed lines patch added patch discarded remove patch
@@ -16,18 +16,39 @@  discard block
 block discarded – undo
16 16
 	protected $_states=[ ];
17 17
 	protected $_baseClass;
18 18
 
19
+	/**
20
+	 * @param string $name
21
+	 */
19 22
 	abstract protected function setPropertyCtrl($name, $value, $typeCtrl);
20 23
 
24
+	/**
25
+	 * @param string $name
26
+	 */
21 27
 	abstract protected function addToPropertyCtrl($name, $value, $typeCtrl);
22 28
 
29
+	/**
30
+	 * @param string $name
31
+	 */
23 32
 	abstract protected function addToPropertyCtrlCheck($name, $value, $typeCtrl);
24 33
 
34
+	/**
35
+	 * @param string $name
36
+	 */
25 37
 	abstract public function addToProperty($name, $value, $separator=" ");
26 38
 
39
+	/**
40
+	 * @param string $name
41
+	 */
27 42
 	abstract public function setProperty($name, $value);
28 43
 
44
+	/**
45
+	 * @param HtmlIcon $content
46
+	 */
29 47
 	abstract public function addContent($content,$before=false);
30 48
 
49
+	/**
50
+	 * @param string $jsCode
51
+	 */
31 52
 	abstract public function onCreate($jsCode);
32 53
 
33 54
 	public function addVariation($variation) {
@@ -108,7 +129,7 @@  discard block
 block discarded – undo
108 129
 	/**
109 130
 	 * show it is currently unable to be interacted with
110 131
 	 * @param boolean $disable
111
-	 * @return \Ajax\semantic\html\elements\HtmlSemDoubleElement
132
+	 * @return BaseTrait
112 133
 	 */
113 134
 	public function setDisabled($disable=true) {
114 135
 		if($disable)
Please login to merge, or discard this patch.
Ajax/common/Widget.php 1 patch
Doc Comments   +15 added lines patch added patch discarded remove patch
@@ -44,6 +44,11 @@  discard block
 block discarded – undo
44 44
 			$this->show($modelInstance);
45 45
 	}
46 46
 
47
+	/**
48
+	 * @param InstanceViewer $instanceViewer
49
+	 * @param string $contentKey
50
+	 * @param boolean $edition
51
+	 */
47 52
 	protected function _init($instanceViewer,$contentKey,$content,$edition){
48 53
 		$this->_instanceViewer=$instanceViewer;
49 54
 		$this->content=[$contentKey=>$content];
@@ -96,16 +101,26 @@  discard block
 block discarded – undo
96 101
 		return $this;
97 102
 	}
98 103
 
104
+	/**
105
+	 * @param \Closure $field
106
+	 */
99 107
 	public function addField($field){
100 108
 		$this->_instanceViewer->addField($field);
101 109
 		return $this;
102 110
 	}
103 111
 
112
+	/**
113
+	 * @param integer $index
114
+	 * @param \Closure $field
115
+	 */
104 116
 	public function insertField($index,$field){
105 117
 		$this->_instanceViewer->insertField($index, $field);
106 118
 		return $this;
107 119
 	}
108 120
 
121
+	/**
122
+	 * @param \Closure $field
123
+	 */
109 124
 	public function insertInField($index,$field){
110 125
 		$this->_instanceViewer->insertInField($index, $field);
111 126
 		return $this;
Please login to merge, or discard this patch.
Ajax/semantic/widgets/base/InstanceViewer.php 1 patch
Doc Comments   +13 added lines, -1 removed lines patch added patch discarded remove patch
@@ -45,6 +45,9 @@  discard block
 block discarded – undo
45 45
 		return $value;
46 46
 	}
47 47
 
48
+	/**
49
+	 * @param integer $index
50
+	 */
48 51
 	public function getValue($index){
49 52
 		$property=$this->properties[$index];
50 53
 		return $this->_getValue($property, $index);
@@ -54,6 +57,9 @@  discard block
 block discarded – undo
54 57
 
55 58
 	}
56 59
 
60
+	/**
61
+	 * @param string $name
62
+	 */
57 63
 	protected function _getDefaultValue($name,$value,$index){
58 64
 		$func=$this->defaultValueFunction;
59 65
 		return $func($name,$value,$index);
@@ -197,6 +203,9 @@  discard block
 block discarded – undo
197 203
 		return $this;
198 204
 	}
199 205
 
206
+	/**
207
+	 * @param integer $index
208
+	 */
200 209
 	public static function setIndex($index) {
201 210
 		self::$index=$index;
202 211
 	}
@@ -255,7 +264,7 @@  discard block
 block discarded – undo
255 264
 	 * The $callback function can take the following arguments : $field=>the compiled field, $instance : the active instance of the object, $index: the field position
256 265
 	 * @param int $index postion of the compiled field
257 266
 	 * @param callable $callback function called after the field compilation
258
-	 * @return \Ajax\semantic\widgets\datatable\InstanceViewer
267
+	 * @return InstanceViewer
259 268
 	 */
260 269
 	public function afterCompile($index,$callback){
261 270
 		$this->afterCompile[$index]=$callback;
@@ -273,6 +282,9 @@  discard block
 block discarded – undo
273 282
 		return $this;
274 283
 	}
275 284
 
285
+	/**
286
+	 * @param callable $defaultValueFunction
287
+	 */
276 288
 	public function setDefaultValueFunction($defaultValueFunction) {
277 289
 		$this->defaultValueFunction=$defaultValueFunction;
278 290
 		return $this;
Please login to merge, or discard this patch.