GridRowsExtension

Complexity

Total Complexity

10

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

92.5%

Importance

Changes	2
Bugs	1	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
B	SplitDataListIntoGridRows()	0	24	5
A	SplitClassNameDataListIntoGridRows()	0	7	1
B	createGrid()	0	24	4

<?php
/**
 * Helper methods to lay out DataObjects in a grid of rows and colums to a
 * required size.  These methods are intended to be called from a template
 */
class GridRowsExtension extends DataExtension

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
	/*
	If you are laying out using some form of grid, e.g. HTML table (ugh) or
	bootstraps span classes it is useful to have the DataList split by row.
	Here the DataList is generated from a method accessible to the current
	controller

	See README.md for a worked example

	*/
	public function SplitDataListIntoGridRows($itemsInGridMethod, $numberOfCols)

Method name "GridRowsExtension::SplitDataListIntoGridRows" is not in camel caps format

	{
		$methodFound = false;
		$itemsInGrid = null;

		// Check first the controller and then the model for the method to call
		if ($this->owner->hasMethod($itemsInGridMethod)) {
			$itemsInGrid = $this->owner->$itemsInGridMethod();
			$methodFound = true;
		}

		if (!$methodFound && method_exists($this->owner->model, $itemsInGridMethod)) {
			$itemsInGrid = $this->owner->model->$itemsInGridMethod();
			$methodFound = true;

$methodFound is not used, you could remove the assignment.

		}

		if ($itemsInGrid == null) {
			$message = 'Method not found.  A grid cannot be formed from the '
					 . 'method ' . $itemsInGridMethod;
			throw new InvalidArgumentException($message);
		}

		return $this->createGrid($itemsInGrid, $numberOfCols);
	}

	/*
	If you are laying out using some form of grid, e.g. HTML table (ugh) or
	bootstraps span classes it is useful to have the DataList split by row.
	This is what this method does.

	See USAGE.md for a worked example

	*/
	public function SplitClassNameDataListIntoGridRows(

Method name "GridRowsExtension::SplitClassNameDataListIntoGridRows" is not in camel caps format

		$className, $numberOfCols, $limit = 10, $sort = 'LastEdited DESC')

Multi-line function declarations must define one parameter per line

The closing parenthesis of a multi-line function declaration must be on a new line

	{

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

		$clazz = Injector::inst()->create($className);
		$itemsInGrid = $clazz->get()->limit($limit)->sort($sort);
		return $this->createGrid($itemsInGrid, $numberOfCols);
	}

	/*
	The actual method that splits the DataList into an ArrayList of rows that
	contain an ArrayList of Columns
	*/
	private function createGrid($itemsInGrid, $numberOfCols)
	{
		$position = 1;
		$columns = new ArrayList();
		$result = new ArrayList();
		foreach ($itemsInGrid as $key => $item) {
			$columns->push($item);
			if (($position) >= $numberOfCols) {
				$position = 1;
				$row = new ArrayList();
				$row->Columns = $columns;
				$result->push($row);
				$columns = new ArrayList();
			} else {
				$position = $position + 1;
			}
		}
		if ($columns->Count() > 0) {
			$row = new ArrayList();
			$row->Columns = $columns;
			$result->push($row);
		}
		return $result;
	}
}