|
1 | 1 | <?php namespace Gitlab\Api; |
2 | 2 |
|
| 3 | +use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException; |
| 4 | +use Symfony\Component\OptionsResolver\Exception\UndefinedOptionsException; |
| 5 | + |
3 | 6 | class Projects extends AbstractApi |
4 | 7 | { |
5 | | - const ORDER_BY = 'created_at'; |
6 | | - const SORT = 'asc'; |
7 | | - |
8 | | - /** |
9 | | - * @param int $page |
10 | | - * @param int $per_page |
11 | | - * @param string $order_by |
12 | | - * @param string $sort |
13 | | - * @return mixed |
14 | | - */ |
15 | | - public function all($page = 1, $per_page = self::PER_PAGE, $order_by = self::ORDER_BY, $sort = self::SORT) |
16 | | - { |
17 | | - return $this->get('projects/all', array( |
18 | | - 'page' => $page, |
19 | | - 'per_page' => $per_page, |
20 | | - 'order_by' => $order_by, |
21 | | - 'sort' => $sort |
22 | | - )); |
23 | | - } |
24 | | - |
25 | 8 | /** |
26 | | - * @param int $page |
27 | | - * @param int $per_page |
28 | | - * @param string $order_by |
29 | | - * @param string $sort |
30 | | - * @return mixed |
31 | | - */ |
32 | | - public function accessible($page = 1, $per_page = self::PER_PAGE, $order_by = self::ORDER_BY, $sort = self::SORT) |
33 | | - { |
34 | | - return $this->get('projects', array( |
35 | | - 'page' => $page, |
36 | | - 'per_page' => $per_page, |
37 | | - 'order_by' => $order_by, |
38 | | - 'sort' => $sort |
39 | | - )); |
40 | | - } |
41 | | - |
42 | | - /** |
43 | | - * Get projects owned by the current user |
44 | | - * @param int $page |
45 | | - * @param int $per_page |
46 | | - * @param string $order_by |
47 | | - * @param string $sort |
48 | | - * @return mixed |
49 | | - */ |
50 | | - public function owned($page = 1, $per_page = self::PER_PAGE, $order_by = self::ORDER_BY, $sort = self::SORT) |
51 | | - { |
52 | | - return $this->get('projects?owned=1', array( |
53 | | - 'page' => $page, |
54 | | - 'per_page' => $per_page, |
55 | | - 'order_by' => $order_by, |
56 | | - 'sort' => $sort |
57 | | - )); |
58 | | - } |
59 | | - |
60 | | - /** |
61 | | - * @param string $query |
62 | | - * @param int $page |
63 | | - * @param int $per_page |
64 | | - * @param string $order_by |
65 | | - * @param string $sort |
66 | | - * @return mixed |
67 | | - */ |
68 | | - public function search($query, $page = 1, $per_page = self::PER_PAGE, $order_by = self::ORDER_BY, $sort = self::SORT) |
69 | | - { |
70 | | - return $this->get('projects/search/'.$this->encodePath($query), array( |
71 | | - 'page' => $page, |
72 | | - 'per_page' => $per_page, |
73 | | - 'order_by' => $order_by, |
74 | | - 'sort' => $sort |
75 | | - )); |
| 9 | + * @param array $parameters { |
| 10 | + * |
| 11 | + * @var bool $archived Limit by archived status. |
| 12 | + * @var string $visibility Limit by visibility public, internal, or private. |
| 13 | + * @var string $order_by Return projects ordered by id, name, path, created_at, updated_at, |
| 14 | + * or last_activity_at fields. Default is created_at. |
| 15 | + * @var string $sort Return projects sorted in asc or desc order. Default is desc. |
| 16 | + * @var string $search Return list of projects matching the search criteria. |
| 17 | + * @var bool $simple Return only the ID, URL, name, and path of each project. |
| 18 | + * @var bool $owned Limit by projects owned by the current user. |
| 19 | + * @var bool $membership Limit by projects that the current user is a member of. |
| 20 | + * @var bool $starred Limit by projects starred by the current user. |
| 21 | + * @var bool $statistics Include project statistics. |
| 22 | + * @var bool $with_issues_enabled Limit by enabled issues feature. |
| 23 | + * @var bool $with_merge_requests_enabled Limit by enabled merge requests feature. |
| 24 | + * } |
| 25 | + * |
| 26 | + * @throws UndefinedOptionsException If an option name is undefined |
| 27 | + * @throws InvalidOptionsException If an option doesn't fulfill the |
| 28 | + * specified validation rules |
| 29 | + * |
| 30 | + * @return mixed |
| 31 | + */ |
| 32 | + public function all(array $parameters = []) |
| 33 | + { |
| 34 | + $resolver = $this->createOptionsResolver(); |
| 35 | + $booleanNormalizer = function ($value) { |
| 36 | + return $value ? 'true' : 'false'; |
| 37 | + }; |
| 38 | + $resolver->setDefined('archived') |
| 39 | + ->setAllowedTypes('archived', 'bool') |
| 40 | + ->setNormalizer('archived', $booleanNormalizer) |
| 41 | + ; |
| 42 | + $resolver->setDefined('visibility') |
| 43 | + ->setAllowedValues('visibility', ['public', 'internal', 'private']) |
| 44 | + ; |
| 45 | + $resolver->setDefined('order_by') |
| 46 | + ->setAllowedValues('order_by', ['id', 'name', 'path', 'created_at', 'updated_at', 'last_activity_at']) |
| 47 | + ; |
| 48 | + $resolver->setDefined('search'); |
| 49 | + $resolver->setDefined('simple') |
| 50 | + ->setAllowedTypes('simple', 'bool') |
| 51 | + ->setNormalizer('simple', $booleanNormalizer) |
| 52 | + ; |
| 53 | + $resolver->setDefined('owned') |
| 54 | + ->setAllowedTypes('owned', 'bool') |
| 55 | + ->setNormalizer('owned', $booleanNormalizer) |
| 56 | + ; |
| 57 | + $resolver->setDefined('membership') |
| 58 | + ->setAllowedTypes('membership', 'bool') |
| 59 | + ->setNormalizer('membership', $booleanNormalizer) |
| 60 | + ; |
| 61 | + $resolver->setDefined('starred') |
| 62 | + ->setAllowedTypes('starred', 'bool') |
| 63 | + ->setNormalizer('starred', $booleanNormalizer) |
| 64 | + ; |
| 65 | + $resolver->setDefined('statistics') |
| 66 | + ->setAllowedTypes('statistics', 'bool') |
| 67 | + ->setNormalizer('statistics', $booleanNormalizer) |
| 68 | + ; |
| 69 | + $resolver->setDefined('with_issues_enabled') |
| 70 | + ->setAllowedTypes('with_issues_enabled', 'bool') |
| 71 | + ->setNormalizer('with_issues_enabled', $booleanNormalizer) |
| 72 | + ; |
| 73 | + $resolver->setDefined('with_merge_requests_enabled') |
| 74 | + ->setAllowedTypes('with_merge_requests_enabled', 'bool') |
| 75 | + ->setNormalizer('with_merge_requests_enabled', $booleanNormalizer) |
| 76 | + ; |
| 77 | + |
| 78 | + return $this->get('projects', $resolver->resolve($parameters)); |
76 | 79 | } |
77 | 80 |
|
78 | 81 | /** |
|
0 commit comments