[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Widget / PaginateViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers\Widget;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16 use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
17 use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
18 use TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper;
19
20 /**
21 * This ViewHelper renders a Pagination of objects.
22 *
23 * = Examples =
24 *
25 * <code title="required arguments">
26 * <f:widget.paginate objects="{blogs}" as="paginatedBlogs">
27 * use {paginatedBlogs} as you used {blogs} before, most certainly inside
28 * a <f:for> loop.
29 * </f:widget.paginate>
30 * </code>
31 *
32 * <code title="full configuration">
33 * <f:widget.paginate objects="{blogs}" as="paginatedBlogs" configuration="{itemsPerPage: 5, insertAbove: 1, insertBelow: 0, maximumNumberOfLinks: 10}">
34 * use {paginatedBlogs} as you used {blogs} before, most certainly inside
35 * a <f:for> loop.
36 * </f:widget.paginate>
37 * </code>
38 *
39 * = Performance characteristics =
40 *
41 * In the above examples, it looks like {blogs} contains all Blog objects, thus
42 * you might wonder if all objects were fetched from the database.
43 * However, the blogs are NOT fetched from the database until you actually use them,
44 * so the paginate ViewHelper will adjust the query sent to the database and receive
45 * only the small subset of objects.
46 * So, there is no negative performance overhead in using the Paginate Widget.
47 */
48 class PaginateViewHelper extends AbstractWidgetViewHelper
49 {
50 /**
51 * @var \TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController
52 */
53 protected $controller;
54
55 /**
56 * @param \TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController $controller
57 */
58 public function injectPaginateController(\TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController $controller)
59 {
60 $this->controller = $controller;
61 }
62
63 /**
64 * Initialize arguments.
65 *
66 * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
67 */
68 public function initializeArguments()
69 {
70 parent::initializeArguments();
71 $this->registerArgument('objects', 'mixed', 'Object', true);
72 $this->registerArgument('as', 'string', 'as', true);
73 $this->registerArgument('configuration', 'array', 'configuration', false, ['itemsPerPage' => 10, 'insertAbove' => false, 'insertBelow' => true, 'maximumNumberOfLinks' => 99]);
74 }
75
76 /**
77 * @return string
78 * @throws \UnexpectedValueException
79 */
80 public function render()
81 {
82 $objects = $this->arguments['objects'];
83
84 if (!($objects instanceof QueryResultInterface || $objects instanceof ObjectStorage || is_array($objects))) {
85 throw new \UnexpectedValueException('Supplied file object type ' . get_class($objects) . ' must be QueryResultInterface or ObjectStorage or be an array.', 1454510731);
86 }
87 return $this->initiateSubRequest();
88 }
89 }