HtmlGrid::getItem() - Code Metrics - Inspection of "Fix scrut bugs" - phpMv/phpMv-UI - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 30b096...92726b )

by Jean-Christophe

created 2018-04-03 18:05 UTC

HtmlGrid::getItem() A

↳ Parent: HtmlGrid

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0

<?php

namespace Ajax\semantic\html\collections;

use Ajax\semantic\html\content\HtmlGridRow;
use Ajax\semantic\html\base\constants\Wide;
use Ajax\semantic\html\base\constants\VerticalAlignment;
use Ajax\semantic\html\base\HtmlSemCollection;
use Ajax\semantic\html\base\traits\TextAlignmentTrait;
use Ajax\semantic\html\content\HtmlGridCol;

/**
 * Semantic Grid component
 * @see http://semantic-ui.com/collections/grid.html
 * @author jc
 * @version 1.001
 */
class HtmlGrid extends HtmlSemCollection {
	use TextAlignmentTrait;
	private $_createCols;
	private $_colSizing=true;
	private $_implicitRows=false;

	public function __construct($identifier, $numRows=1, $numCols=NULL, $createCols=true, $implicitRows=false) {
		parent::__construct($identifier, "div", "ui grid");
		$this->_implicitRows=$implicitRows;
		$this->_createCols=$createCols;
		if (isset($numCols)) {
			$this->_colSizing=false;
			$this->setWide($numCols);
		}
		if($createCols)
			$this->setRowsCount($numRows, $numCols);
	}

	public function asSegment() {
		return $this->addToPropertyCtrl("class", "segment", array ("segment" ));
	}

	public function asContainer() {
		return $this->addToPropertyCtrl("class", "container", array ("container" ));
	}

	/**
	 * Defines the grid width (alias for setWidth)
	 * @param int $wide
	 */
	public function setWide($wide) {
		if(isset(Wide::getConstants()["W" . $wide])){
			$wide=Wide::getConstants()["W" . $wide];
			$this->addToPropertyCtrl("class", $wide, Wide::getConstants());
			return $this->addToPropertyCtrl("class", "column", array ("column" ));
		}
		return $this;
	}

	/**
	 * Defines the grid width
	 * @param int $width
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function setWidth($width) {
		return $this->setWide($width);
	}

	/**
	 * Adds a row with $colsCount columns
	 * @param int $colsCount number of columns to create
	 * @return mixed
	 */
	public function addRow($colsCount=NULL) {
		$rowCount=$this->rowCount() + 1;
		$this->setRowsCount($rowCount, $colsCount, true);
		return $this->content[$rowCount - 1];
	}

	/**
	 * Adds a col
	 * @param int $width with of the column to add
	 * @return mixed|\Ajax\semantic\html\collections\HtmlGrid
	 */
	public function addCol($width=NULL) {
		$colCount=$this->colCount() + 1;
		$this->setColsCount($colCount, true, $width);
		if ($this->hasOnlyCols($this->count()))
			return $this->content[$colCount - 1];
		return $this;
	}

	/**
	 *
	 * @param array $sizes array of width of the columns to create
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function addCols($sizes=array()) {
		foreach ( $sizes as $size ) {
			$this->addCol($size);
		}
		return $this;
	}

	/**
	 * Create $rowsCount rows
	 * @param int $rowsCount
	 * @param int $colsCount
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function setRowsCount($rowsCount, $colsCount=NULL, $force=false) {
		$count=$this->count();
		if ($rowsCount < 2 && $force === false) {
			for($i=$count; $i < $colsCount; $i++) {
				$this->addItem(new HtmlGridCol("col-" . $this->identifier . "-" . $i));
			}
		} else {
			if ($this->hasOnlyCols($count)) {
				$tmpContent=$this->content;
				$item=$this->addItem($colsCount);
				$item->setContent($tmpContent);
				$this->content=array ();
				$count=1;
			}
			for($i=$count; $i < $rowsCount; $i++) {
				$this->addItem($colsCount);
			}
		}
		return $this;
	}

	protected function hasOnlyCols($count) {
		return $count > 0 && $this->content[0] instanceof HtmlGridCol;
	}

	/**
	 * Defines the number of columns in the grid
	 * @param int $numCols
	 * @param boolean $toCreate
	 * @param int $width
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function setColsCount($numCols, $toCreate=true, $width=NULL) {
		if (isset($width)===false) {
			$this->setWide($numCols);
		}
		if ($toCreate === true) {
			$count=$this->count();
			if ($count == 0 || $this->hasOnlyCols($count)) {
				for($i=$count; $i < $numCols; $i++) {
					$this->addItem(new HtmlGridCol("col-" . $this->identifier . "-" . $i, $width));
				}
			} else {
				for($i=0; $i < $count; $i++) {
					$this->getItem($i)->setColsCount($numCols);
				}
			}
		}
		return $this;
	}

	/**
	 * return the row at $index
	 * @param int $index
	 * @return HtmlGridRow
	 */
	public function getRow($index) {
		return $this->getItem($index);
	}
	
	/**
	 * @return HtmlGridRow
	 */
	public function getItem($index){
		return parent::getItem($index);
	}

	/**
	 * Returns the row count
	 * @return int
	 */
	public function rowCount() {
		$count=$this->count();
		if ($this->hasOnlyCols($count))
			return 0;
		return $count;
	}

	/**
	 * Returns the column count
	 * @return int
	 */
	public function colCount() {
		$count=$this->count();
		if ($this->hasOnlyCols($count))
			return $count;
		if ($count > 0)
			return $this->getItem(0)->count();
		return 0;
	}

	/**
	 * Returns the cell (HtmlGridCol) at position rrow,$col
	 * @param int $row
	 * @param int $col
	 * @return HtmlGridCol
	 */
	public function getCell($row, $col) {
		if ($row < 2 && $this->hasOnlyCols($this->count()))
			return $this->getItem($col);

		$row=$this->getItem($row);
		if (isset($row)) {
			$col=$row->getItem($col);
		}
		return $col;

	}

	/**
	 * Adds dividers between columns ($vertically=false) or between rows ($vertically=true)
	 * @param boolean $vertically
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function setDivided($vertically=false) {
		$value=($vertically === true) ? "vertically divided" : "divided";
		return $this->addToPropertyCtrl("class", $value, array ("divided" ));
	}

	/**
	 * Divides rows into cells
	 * @param boolean $internally true for internal cells
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function setCelled($internally=false) {
		$value=($internally === true) ? "internally celled" : "celled";
		return $this->addToPropertyCtrl("class", $value, array ("celled","internally celled" ));
	}

	/**
	 * A grid can have its columns centered
	 */
	public function setCentered() {
		return $this->addToPropertyCtrl("class", "centered", array ("centered" ));
	}

	/**
	 * automatically resize all elements to split the available width evenly
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function setEqualWidth() {
		return $this->addToProperty("class", "equal width");
	}

	/**
	 * Adds vertical or/and horizontal gutters
	 * @param string $value
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function setPadded($value=NULL) {
		if (isset($value))
			$this->addToPropertyCtrl("class", $value, array ("vertically","horizontally" ));
		return $this->addToProperty("class", "padded");
	}

	/**
	 *
	 * @param boolean $very
	 * @return \Ajax\semantic\html\collections\HtmlGrid
	 */
	public function setRelaxed($very=false) {
		$value=($very === true) ? "very relaxed" : "relaxed";
		return $this->addToPropertyCtrl("class", $value, array ("relaxed","very relaxed" ));
	}

	public function setVerticalAlignment($value=VerticalAlignment::MIDDLE) {
		return $this->addToPropertyCtrl("class", $value . " aligned", VerticalAlignment::getConstantValues("aligned"));
	}

	/**
	 *
	 * {@inheritDoc}
	 *
	 * @see \Ajax\common\html\HtmlCollection::createItem()
	 */
	protected function createItem($value) {
		if ($this->_createCols === false)
			$value=null;
		$item=new HtmlGridRow($this->identifier . "-row-" . ($this->count() + 1), $value, $this->_colSizing, $this->_implicitRows);
		return $item;
	}

	/**
	 * Sets $values to the grid
	 * @param array $values
	 */
	public function setValues($values, $force=true) {
		$count=$this->count();
		$valuesSize=\sizeof($values);
		if ($this->_createCols === false || $force === true) {
			for($i=$count; $i < $valuesSize; $i++) {
				$colSize=\sizeof($values[$i]);
				$this->addItem(new HtmlGridRow($this->identifier . "-row-" . ($this->count() + 1), $colSize, $this->_colSizing, $this->_implicitRows));
			}
		}
		$count=\min(array ($this->count(),$valuesSize ));
		for($i=0; $i < $count; $i++) {
			$this->content[$i]->setValues($values[$i], $this->_createCols === false);
		}
	}
	
	public function setColWidth($numCol,$width){
		foreach ($this->content as $row){
			$row->getCol($numCol)->setWidth($width);
		}
		return $this;
	}

	/**
	 * stretch the row contents to take up the entire column height
	 * @return \Ajax\semantic\html\content\HtmlGridRow
	 */
	public function setStretched() {
		return $this->addToProperty("class", "stretched");
	}

	public function addDivider($afterColIndex, $vertical=true, $content=NULL) {
		$col=$this->getCell(0, $afterColIndex);
		return $col->addDivider($vertical, $content);
	}
}


1			<?php
2
3			namespace Ajax\semantic\html\collections;
4
5			use Ajax\semantic\html\content\HtmlGridRow;
6			use Ajax\semantic\html\base\constants\Wide;
7			use Ajax\semantic\html\base\constants\VerticalAlignment;
8			use Ajax\semantic\html\base\HtmlSemCollection;
9			use Ajax\semantic\html\base\traits\TextAlignmentTrait;
10			use Ajax\semantic\html\content\HtmlGridCol;
11
12			/**
13			* Semantic Grid component
14			* @see http://semantic-ui.com/collections/grid.html
15			* @author jc
16			* @version 1.001
17			*/
18			class HtmlGrid extends HtmlSemCollection {
19			use TextAlignmentTrait;
20			private $_createCols;
21			private $_colSizing=true;
22			private $_implicitRows=false;
23
24			public function __construct($identifier, $numRows=1, $numCols=NULL, $createCols=true, $implicitRows=false) {
25			parent::__construct($identifier, "div", "ui grid");
26			$this->_implicitRows=$implicitRows;
27			$this->_createCols=$createCols;
28			if (isset($numCols)) {
29			$this->_colSizing=false;
30			$this->setWide($numCols);
31			}
32			if($createCols)
33			$this->setRowsCount($numRows, $numCols);
34			}
35
36			public function asSegment() {
37			return $this->addToPropertyCtrl("class", "segment", array ("segment" ));
38			}
39
40			public function asContainer() {
41			return $this->addToPropertyCtrl("class", "container", array ("container" ));
42			}
43
44			/**
45			* Defines the grid width (alias for setWidth)
46			* @param int $wide
47			*/
48			public function setWide($wide) {
49			if(isset(Wide::getConstants()["W" . $wide])){
50			$wide=Wide::getConstants()["W" . $wide];
51			$this->addToPropertyCtrl("class", $wide, Wide::getConstants());
52			return $this->addToPropertyCtrl("class", "column", array ("column" ));
53			}
54			return $this;
55			}
56
57			/**
58			* Defines the grid width
59			* @param int $width
60			* @return \Ajax\semantic\html\collections\HtmlGrid
61			*/
62			public function setWidth($width) {
63			return $this->setWide($width);
64			}
65
66			/**
67			* Adds a row with $colsCount columns
68			* @param int $colsCount number of columns to create
69			* @return mixed
70			*/
71			public function addRow($colsCount=NULL) {
72			$rowCount=$this->rowCount() + 1;
73			$this->setRowsCount($rowCount, $colsCount, true);
74			return $this->content[$rowCount - 1];
75			}
76
77			/**
78			* Adds a col
79			* @param int $width with of the column to add
80			* @return mixed\|\Ajax\semantic\html\collections\HtmlGrid
81			*/
82			public function addCol($width=NULL) {
83			$colCount=$this->colCount() + 1;
84			$this->setColsCount($colCount, true, $width);
85			if ($this->hasOnlyCols($this->count()))
86			return $this->content[$colCount - 1];
87			return $this;
88			}
89
90			/**
91			*
92			* @param array $sizes array of width of the columns to create
93			* @return \Ajax\semantic\html\collections\HtmlGrid
94			*/
95			public function addCols($sizes=array()) {
96			foreach ( $sizes as $size ) {
97			$this->addCol($size);
98			}
99			return $this;
100			}
101
102			/**
103			* Create $rowsCount rows
104			* @param int $rowsCount
105			* @param int $colsCount
106			* @return \Ajax\semantic\html\collections\HtmlGrid
107			*/
108			public function setRowsCount($rowsCount, $colsCount=NULL, $force=false) {
109			$count=$this->count();
110			if ($rowsCount < 2 && $force === false) {
111			for($i=$count; $i < $colsCount; $i++) {
112			$this->addItem(new HtmlGridCol("col-" . $this->identifier . "-" . $i));
113			}
114			} else {
115			if ($this->hasOnlyCols($count)) {
116			$tmpContent=$this->content;
117			$item=$this->addItem($colsCount);
118			$item->setContent($tmpContent);
119			$this->content=array ();
120			$count=1;
121			}
122			for($i=$count; $i < $rowsCount; $i++) {
123			$this->addItem($colsCount);
124			}
125			}
126			return $this;
127			}
128
129			protected function hasOnlyCols($count) {
130			return $count > 0 && $this->content[0] instanceof HtmlGridCol;
131			}
132
133			/**
134			* Defines the number of columns in the grid
135			* @param int $numCols
136			* @param boolean $toCreate
137			* @param int $width
138			* @return \Ajax\semantic\html\collections\HtmlGrid
139			*/
140			public function setColsCount($numCols, $toCreate=true, $width=NULL) {
141			if (isset($width)===false) {
142			$this->setWide($numCols);
143			}
144			if ($toCreate === true) {
145			$count=$this->count();
146			if ($count == 0 \|\| $this->hasOnlyCols($count)) {
147			for($i=$count; $i < $numCols; $i++) {
148			$this->addItem(new HtmlGridCol("col-" . $this->identifier . "-" . $i, $width));
149			}
150			} else {
151			for($i=0; $i < $count; $i++) {
152			$this->getItem($i)->setColsCount($numCols);
153			}
154			}
155			}
156			return $this;
157			}
158
159			/**
160			* return the row at $index
161			* @param int $index
162			* @return HtmlGridRow
163			*/
164			public function getRow($index) {
165			return $this->getItem($index);
166			}
167
168			/**
169			* @return HtmlGridRow
170			*/
171			public function getItem($index){
172			return parent::getItem($index);
173			}
174
175			/**
176			* Returns the row count
177			* @return int
178			*/
179			public function rowCount() {
180			$count=$this->count();
181			if ($this->hasOnlyCols($count))
182			return 0;
183			return $count;
184			}
185
186			/**
187			* Returns the column count
188			* @return int
189			*/
190			public function colCount() {
191			$count=$this->count();
192			if ($this->hasOnlyCols($count))
193			return $count;
194			if ($count > 0)
195			return $this->getItem(0)->count();
196			return 0;
197			}
198
199			/**
200			* Returns the cell (HtmlGridCol) at position rrow,$col
201			* @param int $row
202			* @param int $col
203			* @return HtmlGridCol
204			*/
205			public function getCell($row, $col) {
206			if ($row < 2 && $this->hasOnlyCols($this->count()))
207			return $this->getItem($col);
			0 ignored issues – show Bug Best Practice introduced 2018-04-03 18:07 UTC by Report Bug Copy Issue Report The expression `return $this->getItem($col)` returns the type `Ajax\semantic\html\content\HtmlGridRow` which is incompatible with the documented return type `Ajax\semantic\html\content\HtmlGridCol`. Loading history...
208			$row=$this->getItem($row);
209			if (isset($row)) {
210			$col=$row->getItem($col);
211			}
212			return $col;
			0 ignored issues – show Bug Best Practice introduced 2018-04-03 18:07 UTC by Report Bug Copy Issue Report The expression `return $col` returns the type `integer` which is incompatible with the documented return type `Ajax\semantic\html\content\HtmlGridCol`. Loading history...
213			}
214
215			/**
216			* Adds dividers between columns ($vertically=false) or between rows ($vertically=true)
217			* @param boolean $vertically
218			* @return \Ajax\semantic\html\collections\HtmlGrid
219			*/
220			public function setDivided($vertically=false) {
221			$value=($vertically === true) ? "vertically divided" : "divided";
222			return $this->addToPropertyCtrl("class", $value, array ("divided" ));
223			}
224
225			/**
226			* Divides rows into cells
227			* @param boolean $internally true for internal cells
228			* @return \Ajax\semantic\html\collections\HtmlGrid
229			*/
230			public function setCelled($internally=false) {
231			$value=($internally === true) ? "internally celled" : "celled";
232			return $this->addToPropertyCtrl("class", $value, array ("celled","internally celled" ));
233			}
234
235			/**
236			* A grid can have its columns centered
237			*/
238			public function setCentered() {
239			return $this->addToPropertyCtrl("class", "centered", array ("centered" ));
240			}
241
242			/**
243			* automatically resize all elements to split the available width evenly
244			* @return \Ajax\semantic\html\collections\HtmlGrid
245			*/
246			public function setEqualWidth() {
247			return $this->addToProperty("class", "equal width");
248			}
249
250			/**
251			* Adds vertical or/and horizontal gutters
252			* @param string $value
253			* @return \Ajax\semantic\html\collections\HtmlGrid
254			*/
255			public function setPadded($value=NULL) {
256			if (isset($value))
257			$this->addToPropertyCtrl("class", $value, array ("vertically","horizontally" ));
258			return $this->addToProperty("class", "padded");
259			}
260
261			/**
262			*
263			* @param boolean $very
264			* @return \Ajax\semantic\html\collections\HtmlGrid
265			*/
266			public function setRelaxed($very=false) {
267			$value=($very === true) ? "very relaxed" : "relaxed";
268			return $this->addToPropertyCtrl("class", $value, array ("relaxed","very relaxed" ));
269			}
270
271			public function setVerticalAlignment($value=VerticalAlignment::MIDDLE) {
272			return $this->addToPropertyCtrl("class", $value . " aligned", VerticalAlignment::getConstantValues("aligned"));
273			}
274
275			/**
276			*
277			* {@inheritDoc}
278			*
279			* @see \Ajax\common\html\HtmlCollection::createItem()
280			*/
281			protected function createItem($value) {
282			if ($this->_createCols === false)
283			$value=null;
284			$item=new HtmlGridRow($this->identifier . "-row-" . ($this->count() + 1), $value, $this->_colSizing, $this->_implicitRows);
285			return $item;
286			}
287
288			/**
289			* Sets $values to the grid
290			* @param array $values
291			*/
292			public function setValues($values, $force=true) {
293			$count=$this->count();
294			$valuesSize=\sizeof($values);
295			if ($this->_createCols === false \|\| $force === true) {
296			for($i=$count; $i < $valuesSize; $i++) {
297			$colSize=\sizeof($values[$i]);
298			$this->addItem(new HtmlGridRow($this->identifier . "-row-" . ($this->count() + 1), $colSize, $this->_colSizing, $this->_implicitRows));
299			}
300			}
301			$count=\min(array ($this->count(),$valuesSize ));
302			for($i=0; $i < $count; $i++) {
303			$this->content[$i]->setValues($values[$i], $this->_createCols === false);
304			}
305			}
306
307			public function setColWidth($numCol,$width){
308			foreach ($this->content as $row){
309			$row->getCol($numCol)->setWidth($width);
310			}
311			return $this;
312			}
313
314			/**
315			* stretch the row contents to take up the entire column height
316			* @return \Ajax\semantic\html\content\HtmlGridRow
317			*/
318			public function setStretched() {
319			return $this->addToProperty("class", "stretched");
320			}
321
322			public function addDivider($afterColIndex, $vertical=true, $content=NULL) {
323			$col=$this->getCell(0, $afterColIndex);
324			return $col->addDivider($vertical, $content);
325			}
326			}
327

phpMv / phpMv-UI

Push — master ( 30b096...92726b )

HtmlGrid::getItem() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like