@@ -3,9 +3,7 @@ |
||
3 | 3 | namespace Kunstmaan\AdminListBundle\AdminList; |
4 | 4 | |
5 | 5 | use Kunstmaan\AdminListBundle\AdminList\Configurator\AdminListConfiguratorInterface; |
6 | - |
|
7 | 6 | use Pagerfanta\Pagerfanta; |
8 | - |
|
9 | 7 | use Symfony\Component\HttpFoundation\Request; |
10 | 8 | |
11 | 9 | /** |
@@ -116,7 +116,7 @@ discard block |
||
116 | 116 | } |
117 | 117 | |
118 | 118 | /** |
119 | - * @param mixed $item |
|
119 | + * @param \Kunstmaan\MenuBundle\Entity\MenuItem $item |
|
120 | 120 | * |
121 | 121 | * @return bool |
122 | 122 | */ |
@@ -133,6 +133,11 @@ discard block |
||
133 | 133 | return $this->configurator->canAdd(); |
134 | 134 | } |
135 | 135 | |
136 | + /** |
|
137 | + * @param \Kunstmaan\MenuBundle\Entity\MenuItem $item |
|
138 | + * |
|
139 | + * @return boolean |
|
140 | + */ |
|
136 | 141 | public function canView($item) |
137 | 142 | { |
138 | 143 | return $this->configurator->canView($item); |
@@ -147,7 +152,7 @@ discard block |
||
147 | 152 | } |
148 | 153 | |
149 | 154 | /** |
150 | - * @param mixed $item |
|
155 | + * @param \Kunstmaan\MenuBundle\Entity\MenuItem $item |
|
151 | 156 | * |
152 | 157 | * @return array |
153 | 158 | */ |
@@ -156,13 +161,16 @@ discard block |
||
156 | 161 | return $this->configurator->getEditUrlFor($item); |
157 | 162 | } |
158 | 163 | |
164 | + /** |
|
165 | + * @param \Kunstmaan\MenuBundle\Entity\MenuItem $item |
|
166 | + */ |
|
159 | 167 | public function getViewUrlFor($item) |
160 | 168 | { |
161 | 169 | return $this->configurator->getViewUrlFor($item); |
162 | 170 | } |
163 | 171 | |
164 | 172 | /** |
165 | - * @param mixed $item |
|
173 | + * @param \Kunstmaan\MenuBundle\Entity\MenuItem $item |
|
166 | 174 | * |
167 | 175 | * @return array |
168 | 176 | */ |
@@ -182,7 +190,7 @@ discard block |
||
182 | 190 | } |
183 | 191 | |
184 | 192 | /** |
185 | - * @param mixed $item |
|
193 | + * @param \Kunstmaan\MenuBundle\Entity\MenuItem $item |
|
186 | 194 | * |
187 | 195 | * @return bool |
188 | 196 | */ |
@@ -246,7 +254,7 @@ discard block |
||
246 | 254 | } |
247 | 255 | |
248 | 256 | /** |
249 | - * @return array |
|
257 | + * @return ItemAction\ItemActionInterface[] |
|
250 | 258 | */ |
251 | 259 | public function getItemActions() |
252 | 260 | { |
@@ -270,7 +278,7 @@ discard block |
||
270 | 278 | } |
271 | 279 | |
272 | 280 | /** |
273 | - * @return array |
|
281 | + * @return ListAction\ListActionInterface[] |
|
274 | 282 | */ |
275 | 283 | public function getListActions() |
276 | 284 | { |
@@ -278,7 +286,7 @@ discard block |
||
278 | 286 | } |
279 | 287 | |
280 | 288 | /** |
281 | - * @return array |
|
289 | + * @return BulkAction\BulkActionInterface[] |
|
282 | 290 | */ |
283 | 291 | public function getBulkActions() |
284 | 292 | { |
@@ -24,16 +24,19 @@ discard block |
||
24 | 24 | |
25 | 25 | /** |
26 | 26 | * Configure the fields you can filter on |
27 | + * @return void |
|
27 | 28 | */ |
28 | 29 | public function buildFilters(); |
29 | 30 | |
30 | 31 | /** |
31 | 32 | * Configure the actions for each item |
33 | + * @return void |
|
32 | 34 | */ |
33 | 35 | public function buildItemActions(); |
34 | 36 | |
35 | 37 | /** |
36 | 38 | * Configure the actions that can be executed on the whole list |
39 | + * @return void |
|
37 | 40 | */ |
38 | 41 | public function buildListActions(); |
39 | 42 | |
@@ -94,6 +97,9 @@ discard block |
||
94 | 97 | */ |
95 | 98 | public function canEdit($item); |
96 | 99 | |
100 | + /** |
|
101 | + * @return boolean |
|
102 | + */ |
|
97 | 103 | public function canView($item); |
98 | 104 | /** |
99 | 105 | * Configure if it's possible to delete the given $item |
@@ -226,6 +232,7 @@ discard block |
||
226 | 232 | * Bind request |
227 | 233 | * |
228 | 234 | * @param Request $request |
235 | + * @return void |
|
229 | 236 | */ |
230 | 237 | public function bindRequest(Request $request); |
231 | 238 |
@@ -9,7 +9,6 @@ |
||
9 | 9 | use Kunstmaan\AdminListBundle\AdminList\ItemAction\ItemActionInterface; |
10 | 10 | use Kunstmaan\AdminListBundle\AdminList\ListAction\ListActionInterface; |
11 | 11 | use Pagerfanta\Pagerfanta; |
12 | -use Symfony\Component\Form\AbstractType; |
|
13 | 12 | use Symfony\Component\HttpFoundation\Request; |
14 | 13 | |
15 | 14 | /** |
@@ -6,15 +6,30 @@ |
||
6 | 6 | { |
7 | 7 | public function getExportFields(); |
8 | 8 | |
9 | + /** |
|
10 | + * @param string $header |
|
11 | + */ |
|
9 | 12 | public function addExportField($name, $header); |
10 | 13 | |
14 | + /** |
|
15 | + * @return void |
|
16 | + */ |
|
11 | 17 | public function buildIterator(); |
12 | 18 | |
13 | 19 | public function getIterator(); |
14 | 20 | |
21 | + /** |
|
22 | + * @return void |
|
23 | + */ |
|
15 | 24 | public function buildFilters(); |
16 | 25 | |
26 | + /** |
|
27 | + * @return void |
|
28 | + */ |
|
17 | 29 | public function buildExportFields(); |
18 | 30 | |
31 | + /** |
|
32 | + * @param string $columnName |
|
33 | + */ |
|
19 | 34 | public function getStringValue($item, $columnName); |
20 | 35 | } |
@@ -3,7 +3,6 @@ |
||
3 | 3 | namespace Kunstmaan\AdminListBundle\AdminList; |
4 | 4 | |
5 | 5 | use Kunstmaan\AdminListBundle\AdminList\FilterType\FilterTypeInterface; |
6 | - |
|
7 | 6 | use Symfony\Component\HttpFoundation\Request; |
8 | 7 | |
9 | 8 | /** |
@@ -31,7 +31,7 @@ discard block |
||
31 | 31 | /** |
32 | 32 | * You can override this method to return the correct entity manager when using multiple databases ... |
33 | 33 | * |
34 | - * @return \Doctrine\Common\Persistence\ObjectManager|object |
|
34 | + * @return \Doctrine\Common\Persistence\ObjectManager |
|
35 | 35 | */ |
36 | 36 | protected function getEntityManager() |
37 | 37 | { |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | * Shows the list of entities |
43 | 43 | * |
44 | 44 | * @param AbstractAdminListConfigurator $configurator |
45 | - * @param null|Request $request |
|
45 | + * @param Request $request |
|
46 | 46 | * |
47 | 47 | * @return Response |
48 | 48 | */ |
@@ -94,7 +94,7 @@ discard block |
||
94 | 94 | * |
95 | 95 | * @param AbstractAdminListConfigurator $configurator The adminlist configurator |
96 | 96 | * @param string $type The type to add |
97 | - * @param null|Request $request |
|
97 | + * @param Request $request |
|
98 | 98 | * |
99 | 99 | * @throws AccessDeniedHttpException |
100 | 100 | * |
@@ -197,7 +197,7 @@ discard block |
||
197 | 197 | * |
198 | 198 | * @param AbstractAdminListConfigurator $configurator The adminlist configurator |
199 | 199 | * @param string $entityId The id of the entity that will be edited |
200 | - * @param null|Request $request |
|
200 | + * @param Request $request |
|
201 | 201 | * |
202 | 202 | * @throws NotFoundHttpException |
203 | 203 | * @throws AccessDeniedHttpException |
@@ -358,7 +358,7 @@ discard block |
||
358 | 358 | * |
359 | 359 | * @param AbstractAdminListConfigurator $configurator The adminlist configurator |
360 | 360 | * @param integer $entityId The id to delete |
361 | - * @param null|Request $request |
|
361 | + * @param Request $request |
|
362 | 362 | * |
363 | 363 | * @throws NotFoundHttpException |
364 | 364 | * @throws AccessDeniedHttpException |
@@ -479,6 +479,9 @@ discard block |
||
479 | 479 | ); |
480 | 480 | } |
481 | 481 | |
482 | + /** |
|
483 | + * @param \Doctrine\Common\Persistence\ObjectRepository $repo |
|
484 | + */ |
|
482 | 485 | private function getMaxSortableField($repo, $sort) |
483 | 486 | { |
484 | 487 | $maxWeight = $repo->createQueryBuilder('i') |
@@ -17,7 +17,7 @@ |
||
17 | 17 | /** |
18 | 18 | * You can override this method to return the correct entity manager when using multiple databases ... |
19 | 19 | * |
20 | - * @return \Doctrine\Common\Persistence\ObjectManager|object |
|
20 | + * @return \Doctrine\Common\Persistence\ObjectManager |
|
21 | 21 | */ |
22 | 22 | protected function getEntityManager() |
23 | 23 | { |
@@ -111,7 +111,7 @@ discard block |
||
111 | 111 | } |
112 | 112 | |
113 | 113 | /** |
114 | - * @param $entityClass |
|
114 | + * @param string $entityClass |
|
115 | 115 | * |
116 | 116 | * @return LockableEntity |
117 | 117 | */ |
@@ -135,7 +135,7 @@ discard block |
||
135 | 135 | /** |
136 | 136 | * Set integer |
137 | 137 | * |
138 | - * @param $entityId |
|
138 | + * @param integer $entityId |
|
139 | 139 | * |
140 | 140 | * @return LockableEntity |
141 | 141 | */ |
@@ -4,7 +4,6 @@ |
||
4 | 4 | |
5 | 5 | use Doctrine\ORM\Mapping as ORM; |
6 | 6 | use Kunstmaan\AdminBundle\Entity\AbstractEntity; |
7 | -use Symfony\Component\Validator\Constraints as Assert; |
|
8 | 7 | |
9 | 8 | /** |
10 | 9 | * @ORM\Entity(repositoryClass="Kunstmaan\AdminListBundle\Repository\LockableEntityRepository") |
@@ -26,6 +26,10 @@ discard block |
||
26 | 26 | */ |
27 | 27 | private $lockEnabled; |
28 | 28 | |
29 | + /** |
|
30 | + * @param integer $threshold |
|
31 | + * @param boolean $lockEnabled |
|
32 | + */ |
|
29 | 33 | public function __construct(ObjectManager $em, $threshold, $lockEnabled) |
30 | 34 | { |
31 | 35 | $this->setObjectManager($em); |
@@ -138,7 +142,7 @@ discard block |
||
138 | 142 | * |
139 | 143 | * @param LockableEntity $entity |
140 | 144 | * @param User $userToExclude |
141 | - * @return EntityVersionLock[] |
|
145 | + * @return \Kunstmaan\AdminListBundle\Repository\EntityVersionLock[] |
|
142 | 146 | */ |
143 | 147 | protected function getEntityVersionLocksByLockableEntity(LockableEntity $entity, User $userToExclude = null) |
144 | 148 | { |
@@ -11,6 +11,9 @@ |
||
11 | 11 | { |
12 | 12 | protected $id; |
13 | 13 | |
14 | + /** |
|
15 | + * @param string $id |
|
16 | + */ |
|
14 | 17 | public function __construct($id) |
15 | 18 | { |
16 | 19 | $this->setId($id); |