GridFieldPaginator::getActions() - Code Metrics - Inspection of "API Implement basic preview behaviour" - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5408)

by Damian

created 2016-05-02 03:27 UTC

GridFieldPaginator::getActions() A

↳ Parent: GridFieldPaginator

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	5
rs	9.4285
cc	2
eloc	3
nc	2
nop	1

<?php
/**
 * GridFieldPaginator paginates the {@link GridField} list and adds controls
 * to the bottom of the {@link GridField}.
 *
 * @package forms
 * @subpackage fields-gridfield
 */
class GridFieldPaginator implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider {

	/**
	 * Specifies default items per page
	 *
	 * @config
	 * @var int
	 */
	private static $default_items_per_page = 15;

	/**
	 * @var int
	 */
	protected $itemsPerPage;

	/**
	 * Which template to use for rendering
	 *
	 * @var string
	 */
	protected $itemClass = 'GridFieldPaginator_Row';

	/**
	 * See {@link setThrowExceptionOnBadDataType()}
	 */
	protected $throwExceptionOnBadDataType = true;

	/**
	 *
	 * @param int $itemsPerPage - How many items should be displayed per page
	 */
	public function __construct($itemsPerPage=null) {
		$this->itemsPerPage = $itemsPerPage
			?: Config::inst()->get('GridFieldPaginator', 'default_items_per_page');
	}

	/**
	 * Determine what happens when this component is used with a list that isn't {@link SS_Filterable}.
	 *
	 *  - true: An exception is thrown
	 *  - false: This component will be ignored - it won't make any changes to the GridField.
	 *
	 * By default, this is set to true so that it's clearer what's happening, but the predefined
	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
	 */
	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
	}

	/**
	 * See {@link setThrowExceptionOnBadDataType()}
	 */
	public function getThrowExceptionOnBadDataType() {
		return $this->throwExceptionOnBadDataType;
	}

	/**
	 * Check that this dataList is of the right data type.
	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
	 */
	protected function checkDataType($dataList) {
		if($dataList instanceof SS_Limitable) {
			return true;
		} else {
			if($this->throwExceptionOnBadDataType) {
				throw new LogicException(
					get_class($this) . " expects an SS_Limitable list to be passed to the GridField.");
			}
			return false;
		}
	}

	/**
	 *
	 * @param GridField $gridField
	 * @return array
	 */
	public function getActions($gridField) {
		if(!$this->checkDataType($gridField->getList())) return;

		return array('paginate');
	}

	/**
	 *
	 * @param GridField $gridField
	 * @param string $actionName
	 * @param string $arguments
	 * @param array $data
	 * @return void
	 */
	public function handleAction(GridField $gridField, $actionName, $arguments, $data) {
		if(!$this->checkDataType($gridField->getList())) return;

		if($actionName !== 'paginate') {
			return;
		}
		$state = $this->getGridPagerState($gridField);
		$state->currentPage = (int)$arguments;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
	}

	protected $totalItems = 0;

	/**
	 * Retrieves/Sets up the state object used to store and retrieve information
	 * about the current paging details of this GridField
	 * @param GridField $gridField
	 * @return GridState_Data
	 */
	protected function getGridPagerState(GridField $gridField) {
		$state = $gridField->State->GridFieldPaginator;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

		// Force the state to the initial page if none is set
		$state->currentPage(1);

		return $state;
	}

	/**
	 *
	 * @param GridField $gridField
	 * @param SS_List $dataList
	 * @return SS_List
	 */
	public function getManipulatedData(GridField $gridField, SS_List $dataList) {
		if(!$this->checkDataType($dataList)) return $dataList;

		$state = $this->getGridPagerState($gridField);

		// Update item count prior to filter. GridFieldPageCount will rely on this value
		$this->totalItems = $dataList->count();

		$startRow = $this->itemsPerPage * ($state->currentPage - 1);

		// Prevent visiting a page with an offset higher than the total number of items
		if($startRow >= $this->totalItems) {
			$state->currentPage = 1;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			$startRow = 0;
		}

		if(!($dataList instanceof SS_Limitable) || ($dataList instanceof UnsavedRelationList)) {
			return $dataList;
		}

		return $dataList->limit((int)$this->itemsPerPage, (int)$startRow);
	}

	/**
	 * Determines arguments to be passed to the template for building this field
	 * @return ArrayData|null If paging is available this will be an ArrayData
	 * object of paging details with these parameters:
	 * <ul>
	 *	<li>OnlyOnePage:				boolean - Is there only one page?</li>
	 *  <li>FirstShownRecord:			integer - Number of the first record displayed</li>
	 *  <li>LastShownRecord:			integer - Number of the last record displayed</li>
	 *  <li>NumRecords:					integer - Total number of records</li>
	 *	<li>NumPages:					integer - The number of pages</li>
	 *	<li>CurrentPageNum (optional):	integer - If OnlyOnePage is false, the number of the current page</li>
	 *  <li>FirstPage (optional):		GridField_FormAction - Button to go to the first page</li>
	 *	<li>PreviousPage (optional):	GridField_FormAction - Button to go to the previous page</li>
	 *	<li>NextPage (optional):		GridField_FormAction - Button to go to the next page</li>
	 *	<li>LastPage (optional):		GridField_FormAction - Button to go to last page</li>
	 * </ul>
	 */
	public function getTemplateParameters(GridField $gridField) {
		if(!$this->checkDataType($gridField->getList())) return null;

		$state = $this->getGridPagerState($gridField);

		// Figure out which page and record range we're on
		$totalRows = $this->totalItems;
		if(!$totalRows) return null;

		$totalPages = (int)ceil($totalRows/$this->itemsPerPage);
		if($totalPages == 0)
			$totalPages = 1;
		$firstShownRecord = ($state->currentPage - 1) * $this->itemsPerPage + 1;
		if($firstShownRecord > $totalRows)
			$firstShownRecord = $totalRows;
		$lastShownRecord = $state->currentPage * $this->itemsPerPage;
		if($lastShownRecord > $totalRows)
			$lastShownRecord = $totalRows;

		// If there is only 1 page for all the records in list, we don't need to go further
		// to sort out those first page, last page, pre and next pages, etc
		// we are not render those in to the paginator.
		if($totalPages === 1){
			return new ArrayData(array(
				'OnlyOnePage' => true,
				'FirstShownRecord' => $firstShownRecord,
				'LastShownRecord' => $lastShownRecord,
				'NumRecords' => $totalRows,
				'NumPages' => $totalPages
			));
		} else {
			// First page button
			$firstPage = new GridField_FormAction($gridField, 'pagination_first', 'First', 'paginate', 1);
			$firstPage->addExtraClass('ss-gridfield-firstpage');
			if($state->currentPage == 1)
				$firstPage = $firstPage->performDisabledTransformation();

			// Previous page button
			$previousPageNum = $state->currentPage <= 1 ? 1 : $state->currentPage - 1;
			$previousPage = new GridField_FormAction($gridField, 'pagination_prev', 'Previous',
				'paginate', $previousPageNum);
			$previousPage->addExtraClass('ss-gridfield-previouspage');
			if($state->currentPage == 1)
				$previousPage = $previousPage->performDisabledTransformation();

			// Next page button
			$nextPageNum = $state->currentPage >= $totalPages ? $totalPages : $state->currentPage + 1;
			$nextPage = new GridField_FormAction($gridField, 'pagination_next', 'Next',
				'paginate', $nextPageNum);
			$nextPage->addExtraClass('ss-gridfield-nextpage');
			if($state->currentPage == $totalPages)
				$nextPage = $nextPage->performDisabledTransformation();

			// Last page button
			$lastPage = new GridField_FormAction($gridField, 'pagination_last', 'Last', 'paginate', $totalPages);
			$lastPage->addExtraClass('ss-gridfield-lastpage');
			if($state->currentPage == $totalPages)
				$lastPage = $lastPage->performDisabledTransformation();

			// Render in template
			return new ArrayData(array(
				'OnlyOnePage' => false,
				'FirstPage' => $firstPage,
				'PreviousPage' => $previousPage,
				'CurrentPageNum' => $state->currentPage,
				'NumPages' => $totalPages,
				'NextPage' => $nextPage,
				'LastPage' => $lastPage,
				'FirstShownRecord' => $firstShownRecord,
				'LastShownRecord' => $lastShownRecord,
				'NumRecords' => $totalRows
			));
		}
	}

	/**
	 *
	 * @param GridField $gridField
	 * @return array
	 */
	public function getHTMLFragments($gridField) {

		$forTemplate = $this->getTemplateParameters($gridField);
		if($forTemplate) {
			return array(
				'footer' => $forTemplate->renderWith($this->itemClass,
					array('Colspan'=>count($gridField->getColumns())))
			);
		}
	}

	/**
	 * @param Int
	 */
	public function setItemsPerPage($num) {
		$this->itemsPerPage = $num;
		return $this;
	}

	/**
	 * @return Int
	 */
	public function getItemsPerPage() {
		return $this->itemsPerPage;
	}

}


1			<?php
2			/**
3			* GridFieldPaginator paginates the {@link GridField} list and adds controls
4			* to the bottom of the {@link GridField}.
5			*
6			* @package forms
7			* @subpackage fields-gridfield
8			*/
9			class GridFieldPaginator implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider {
10
11			/**
12			* Specifies default items per page
13			*
14			* @config
15			* @var int
16			*/
17			private static $default_items_per_page = 15;
18
19			/**
20			* @var int
21			*/
22			protected $itemsPerPage;
23
24			/**
25			* Which template to use for rendering
26			*
27			* @var string
28			*/
29			protected $itemClass = 'GridFieldPaginator_Row';
30
31			/**
32			* See {@link setThrowExceptionOnBadDataType()}
33			*/
34			protected $throwExceptionOnBadDataType = true;
35
36			/**
37			*
38			* @param int $itemsPerPage - How many items should be displayed per page
39			*/
40			public function __construct($itemsPerPage=null) {
41			$this->itemsPerPage = $itemsPerPage
42			?: Config::inst()->get('GridFieldPaginator', 'default_items_per_page');
43			}
44
45			/**
46			* Determine what happens when this component is used with a list that isn't {@link SS_Filterable}.
47			*
48			* - true: An exception is thrown
49			* - false: This component will be ignored - it won't make any changes to the GridField.
50			*
51			* By default, this is set to true so that it's clearer what's happening, but the predefined
52			* {@link GridFieldConfig} subclasses set this to false for flexibility.
53			*/
54			public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
55			$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
56			}
57
58			/**
59			* See {@link setThrowExceptionOnBadDataType()}
60			*/
61			public function getThrowExceptionOnBadDataType() {
62			return $this->throwExceptionOnBadDataType;
63			}
64
65			/**
66			* Check that this dataList is of the right data type.
67			* Returns false if it's a bad data type, and if appropriate, throws an exception.
68			*/
69			protected function checkDataType($dataList) {
70			if($dataList instanceof SS_Limitable) {
71			return true;
72			} else {
73			if($this->throwExceptionOnBadDataType) {
74			throw new LogicException(
75			get_class($this) . " expects an SS_Limitable list to be passed to the GridField.");
76			}
77			return false;
78			}
79			}
80
81			/**
82			*
83			* @param GridField $gridField
84			* @return array
85			*/
86			public function getActions($gridField) {
87			if(!$this->checkDataType($gridField->getList())) return;
88
89			return array('paginate');
90			}
91
92			/**
93			*
94			* @param GridField $gridField
95			* @param string $actionName
96			* @param string $arguments
97			* @param array $data
98			* @return void
99			*/
100			public function handleAction(GridField $gridField, $actionName, $arguments, $data) {
101			if(!$this->checkDataType($gridField->getList())) return;
102
103			if($actionName !== 'paginate') {
104			return;
105			}
106			$state = $this->getGridPagerState($gridField);
107			$state->currentPage = (int)$arguments;
			0 ignored issues – show Documentation introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report The property `currentPage` does not exist on `object<GridState_Data>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
108			}
109
110			protected $totalItems = 0;
111
112			/**
113			* Retrieves/Sets up the state object used to store and retrieve information
114			* about the current paging details of this GridField
115			* @param GridField $gridField
116			* @return GridState_Data
117			*/
118			protected function getGridPagerState(GridField $gridField) {
119			$state = $gridField->State->GridFieldPaginator;
			0 ignored issues – show Documentation introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report The property `GridFieldPaginator` does not exist on `object<GridState_Data>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
120
121			// Force the state to the initial page if none is set
122			$state->currentPage(1);
123
124			return $state;
125			}
126
127			/**
128			*
129			* @param GridField $gridField
130			* @param SS_List $dataList
131			* @return SS_List
132			*/
133			public function getManipulatedData(GridField $gridField, SS_List $dataList) {
134			if(!$this->checkDataType($dataList)) return $dataList;
135
136			$state = $this->getGridPagerState($gridField);
137
138			// Update item count prior to filter. GridFieldPageCount will rely on this value
139			$this->totalItems = $dataList->count();
140
141			$startRow = $this->itemsPerPage * ($state->currentPage - 1);
142
143			// Prevent visiting a page with an offset higher than the total number of items
144			if($startRow >= $this->totalItems) {
145			$state->currentPage = 1;
			0 ignored issues – show Documentation introduced 2016-04-29 06:16 UTC by Report Bug Copy Issue Report The property `currentPage` does not exist on `object<GridState_Data>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
146			$startRow = 0;
147			}
148
149			if(!($dataList instanceof SS_Limitable) \|\| ($dataList instanceof UnsavedRelationList)) {
150			return $dataList;
151			}
152
153			return $dataList->limit((int)$this->itemsPerPage, (int)$startRow);
154			}
155
156			/**
157			* Determines arguments to be passed to the template for building this field
158			* @return ArrayData\|null If paging is available this will be an ArrayData
159			* object of paging details with these parameters:
160			* <ul>
161			* <li>OnlyOnePage: boolean - Is there only one page?</li>
162			* <li>FirstShownRecord: integer - Number of the first record displayed</li>
163			* <li>LastShownRecord: integer - Number of the last record displayed</li>
164			* <li>NumRecords: integer - Total number of records</li>
165			* <li>NumPages: integer - The number of pages</li>
166			* <li>CurrentPageNum (optional): integer - If OnlyOnePage is false, the number of the current page</li>
167			* <li>FirstPage (optional): GridField_FormAction - Button to go to the first page</li>
168			* <li>PreviousPage (optional): GridField_FormAction - Button to go to the previous page</li>
169			* <li>NextPage (optional): GridField_FormAction - Button to go to the next page</li>
170			* <li>LastPage (optional): GridField_FormAction - Button to go to last page</li>
171			* </ul>
172			*/
173			public function getTemplateParameters(GridField $gridField) {
174			if(!$this->checkDataType($gridField->getList())) return null;
175
176			$state = $this->getGridPagerState($gridField);
177
178			// Figure out which page and record range we're on
179			$totalRows = $this->totalItems;
180			if(!$totalRows) return null;
181
182			$totalPages = (int)ceil($totalRows/$this->itemsPerPage);
183			if($totalPages == 0)
184			$totalPages = 1;
185			$firstShownRecord = ($state->currentPage - 1) * $this->itemsPerPage + 1;
186			if($firstShownRecord > $totalRows)
187			$firstShownRecord = $totalRows;
188			$lastShownRecord = $state->currentPage * $this->itemsPerPage;
189			if($lastShownRecord > $totalRows)
190			$lastShownRecord = $totalRows;
191
192			// If there is only 1 page for all the records in list, we don't need to go further
193			// to sort out those first page, last page, pre and next pages, etc
194			// we are not render those in to the paginator.
195			if($totalPages === 1){
196			return new ArrayData(array(
197			'OnlyOnePage' => true,
198			'FirstShownRecord' => $firstShownRecord,
199			'LastShownRecord' => $lastShownRecord,
200			'NumRecords' => $totalRows,
201			'NumPages' => $totalPages
202			));
203			} else {
204			// First page button
205			$firstPage = new GridField_FormAction($gridField, 'pagination_first', 'First', 'paginate', 1);
206			$firstPage->addExtraClass('ss-gridfield-firstpage');
207			if($state->currentPage == 1)
208			$firstPage = $firstPage->performDisabledTransformation();
209
210			// Previous page button
211			$previousPageNum = $state->currentPage <= 1 ? 1 : $state->currentPage - 1;
212			$previousPage = new GridField_FormAction($gridField, 'pagination_prev', 'Previous',
213			'paginate', $previousPageNum);
214			$previousPage->addExtraClass('ss-gridfield-previouspage');
215			if($state->currentPage == 1)
216			$previousPage = $previousPage->performDisabledTransformation();
217
218			// Next page button
219			$nextPageNum = $state->currentPage >= $totalPages ? $totalPages : $state->currentPage + 1;
220			$nextPage = new GridField_FormAction($gridField, 'pagination_next', 'Next',
221			'paginate', $nextPageNum);
222			$nextPage->addExtraClass('ss-gridfield-nextpage');
223			if($state->currentPage == $totalPages)
224			$nextPage = $nextPage->performDisabledTransformation();
225
226			// Last page button
227			$lastPage = new GridField_FormAction($gridField, 'pagination_last', 'Last', 'paginate', $totalPages);
228			$lastPage->addExtraClass('ss-gridfield-lastpage');
229			if($state->currentPage == $totalPages)
230			$lastPage = $lastPage->performDisabledTransformation();
231
232			// Render in template
233			return new ArrayData(array(
234			'OnlyOnePage' => false,
235			'FirstPage' => $firstPage,
236			'PreviousPage' => $previousPage,
237			'CurrentPageNum' => $state->currentPage,
238			'NumPages' => $totalPages,
239			'NextPage' => $nextPage,
240			'LastPage' => $lastPage,
241			'FirstShownRecord' => $firstShownRecord,
242			'LastShownRecord' => $lastShownRecord,
243			'NumRecords' => $totalRows
244			));
245			}
246			}
247
248			/**
249			*
250			* @param GridField $gridField
251			* @return array
252			*/
253			public function getHTMLFragments($gridField) {
254
255			$forTemplate = $this->getTemplateParameters($gridField);
256			if($forTemplate) {
257			return array(
258			'footer' => $forTemplate->renderWith($this->itemClass,
259			array('Colspan'=>count($gridField->getColumns())))
260			);
261			}
262			}
263
264			/**
265			* @param Int
266			*/
267			public function setItemsPerPage($num) {
268			$this->itemsPerPage = $num;
269			return $this;
270			}
271
272			/**
273			* @return Int
274			*/
275			public function getItemsPerPage() {
276			return $this->itemsPerPage;
277			}
278
279			}
280

silverstripe / silverstripe-framework

Pull Request — master (#5408)

GridFieldPaginator::getActions() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like