[11.9] Add support for Advanced Search API

src/Api/Projects.php

@@ -78,6 +78,8 @@ public function all(array $parameters = [])
             'id', 'name', 'path', 'created_at', 'updated_at', 'last_activity_at',
             'repository_size', 'storage_size', 'packages_size', 'wiki_size',
         ];
+        $resolver->setDefined('pagination');
+        $resolver->setDefined('per_page');
         $resolver->setDefined('order_by')
             ->setAllowedValues('order_by', $orderBy)
         ;

src/Api/Search.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Gitlab API library.
+ *
+ * (c) Matt Humphrey <[email protected]>
+ * (c) Graham Campbell <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gitlab\Api;
+
+use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
+use Symfony\Component\OptionsResolver\Exception\UndefinedOptionsException;
+use Symfony\Component\OptionsResolver\Options;
+
+class Search extends AbstractApi
+{
+    /**
+     * @param array $parameters {
+     *
+     *     @var string             $scope                       The scope to search in
+     *     @var string             $search                      The search query
+     *     @var string             $state                  	    Filter by state. Issues and merge requests are supported; it is ignored for other scopes.
+     *     @var bool               $confidential                Filter by confidentiality. Issues scope is supported; it is ignored for other scopes.
+     *     @var string             $order_by                    Allowed values are created_at only. If this is not set, the results are either sorted by created_at in descending order for basic search, or by the most relevant documents when using advanced search.
+     *     @var string             $sort                        Return projects sorted in asc or desc order (default is desc)
+     * }
+     *
+     * @throws UndefinedOptionsException If an option name is undefined
+     * @throws InvalidOptionsException   If an option doesn't fulfill the
+     *                                   specified validation rules
+     *
+     * @return mixed
+     */
+    public function all(array $parameters = [])
+    {
+        $resolver = $this->createOptionsResolver();
+        $booleanNormalizer = function (Options $resolver, $value): string {
+            return $value ? 'true' : 'false';
+        };
+        $resolver->setDefined('confidential')
+            ->setAllowedTypes('confidential', 'bool')
+            ->setNormalizer('confidential', $booleanNormalizer);
+        $scope = [
+            'projects',
+            'issues',
+            'merge_requests',
+            'milestones',
+            'snippet_titles',
+            'users',
+        ];
+        $resolver->setDefined('scope')
+            ->setAllowedValues('scope', $scope);
+        $resolver->setDefined('search');
+        $resolver->setDefined('order_by')
+            ->setAllowedValues('order_by', ['created_at']);
+        $resolver->setDefined('sort')
+            ->setAllowedValues('sort', ['asc', 'desc']);
+
+        return $this->get('search', $resolver->resolve($parameters));
+    }
+}

src/Client.php

@@ -39,6 +39,7 @@
 use Gitlab\Api\ResourceStateEvents;
 use Gitlab\Api\ResourceWeightEvents;
 use Gitlab\Api\Schedules;
+use Gitlab\Api\Search;
 use Gitlab\Api\Snippets;
 use Gitlab\Api\SystemHooks;
 use Gitlab\Api\Tags;
@@ -335,6 +336,14 @@ public function repositoryFiles(): RepositoryFiles
         return new RepositoryFiles($this);
     }
 
+    /**
+     * @return Search
+     */
+    public function search(): Search
+    {
+        return new Search($this);
+    }
+
     /**
      * @return Schedules
      */

tests/Api/SearchTest.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Gitlab API library.
+ *
+ * (c) Matt Humphrey <[email protected]>
+ * (c) Graham Campbell <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gitlab\Tests\Api;
+
+use Gitlab\Api\Search;
+
+class SearchTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldGetAll(): void
+    {
+        $expectedArray = [
+            ['id' => 6, 'name' => 'Project 6 bla'],
+            ['id' => 7, 'name' => 'Project 7 bla'],
+            ['id' => 8, 'name' => 'Project 8 bla'],
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('search', [
+                'scope' => 'projects',
+                'confidential' => 'false',
+                'search' => 'bla',
+                'order_by' => 'created_at',
+                'sort' => 'desc',
+            ])
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->all([
+            'scope' => 'projects',
+            'confidential' => false,
+            'search' => 'bla',
+            'order_by' => 'created_at',
+            'sort' => 'desc',
+        ]));
+    }
+
+    protected function getApiClass()
+    {
+        return Search::class;
+    }
+}