PCBC-831 implement search index management (#115)

* Implement options

* Implement API from cluster

* Implement SearchIndexManager

* Add SearchIndexManagerTest

* shorten return type

* Linting

* update package.xml

* Use wrap exception for VariousTasks test

* update package.xml again

Author: Matt-Woz

Couchbase/Cluster.php

@@ -189,11 +189,10 @@ public function queryIndexes(): QueryIndexManager
      * Creates a new search index manager object for managing search query indexes.
      *
      * @return SearchIndexManager
-     * @throws UnsupportedOperationException
      */
     public function searchIndexes(): SearchIndexManager
     {
-        throw new UnsupportedOperationException();
+        return new SearchIndexManager($this->core);
     }
 
     /**

Couchbase/Management/AllowQueryingSearchIndexOptions.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * Copyright 2014-Present Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace Couchbase\Management;
+
+class AllowQueryingSearchIndexOptions
+{
+    private ?int $timeoutMilliseconds;
+
+    /**
+     * Static helper to make code more readable
+     *
+     * @return AllowQueryingSearchIndexOptions
+     *
+     * @since 4.1.5
+     */
+    public static function build(): AllowQueryingSearchIndexOptions
+    {
+        return new AllowQueryingSearchIndexOptions();
+    }
+
+    /**
+     * Sets the operation timeout in milliseconds
+     * @param int $milliseconds
+     * @return $this
+     *
+     * @since 4.1.5
+     */
+    public function timeout(int $milliseconds): AllowQueryingSearchIndexOptions
+    {
+        $this->timeoutMilliseconds = $milliseconds;
+        return $this;
+    }
+
+    /**
+     * @param AllowQueryingSearchIndexOptions|null $options
+     * @return array
+     * @internal
+     * @since 4.1.5
+     */
+    public static function export(?AllowQueryingSearchIndexOptions $options): array
+    {
+        if ($options == null) {
+            return [];
+        }
+        return [
+            'timeoutMilliseconds' => $options->timeoutMilliseconds,
+        ];
+    }
+}

Couchbase/Management/AnalyzeDocumentOptions.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * Copyright 2014-Present Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace Couchbase\Management;
+
+class AnalyzeDocumentOptions
+{
+    private ?int $timeoutMilliseconds;
+
+    /**
+     * Static helper to make code more readable
+     *
+     * @return AnalyzeDocumentOptions
+     *
+     * @since 4.1.5
+     */
+    public static function build(): AnalyzeDocumentOptions
+    {
+        return new AnalyzeDocumentOptions();
+    }
+
+    /**
+     * Sets the operation timeout in milliseconds
+     * @param int $milliseconds
+     * @return $this
+     *
+     * @since 4.1.5
+     */
+    public function timeout(int $milliseconds): AnalyzeDocumentOptions
+    {
+        $this->timeoutMilliseconds = $milliseconds;
+        return $this;
+    }
+
+    /**
+     * @param AnalyzeDocumentOptions|null $options
+     * @return array
+     * @internal
+     * @since 4.1.5
+     */
+    public static function export(?AnalyzeDocumentOptions $options): array
+    {
+        if ($options == null) {
+            return [];
+        }
+        return [
+            'timeoutMilliseconds' => $options->timeoutMilliseconds,
+        ];
+    }
+}

Couchbase/Management/DisallowQueryingSearchIndexOptions.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * Copyright 2014-Present Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace Couchbase\Management;
+
+class DisallowQueryingSearchIndexOptions
+{
+    private ?int $timeoutMilliseconds;
+
+    /**
+     * Static helper to make code more readable
+     *
+     * @return DisallowQueryingSearchIndexOptions
+     *
+     * @since 4.1.5
+     */
+    public static function build(): DisallowQueryingSearchIndexOptions
+    {
+        return new DisallowQueryingSearchIndexOptions();
+    }
+
+    /**
+     * Sets the operation timeout in milliseconds
+     * @param int $milliseconds
+     * @return $this
+     *
+     * @since 4.1.5
+     */
+    public function timeout(int $milliseconds): DisallowQueryingSearchIndexOptions
+    {
+        $this->timeoutMilliseconds = $milliseconds;
+        return $this;
+    }
+
+    /**
+     * @param DisallowQueryingSearchIndexOptions|null $options
+     * @return array
+     * @internal
+     * @since 4.1.5
+     */
+    public static function export(?DisallowQueryingSearchIndexOptions $options): array
+    {
+        if ($options == null) {
+            return [];
+        }
+        return [
+            'timeoutMilliseconds' => $options->timeoutMilliseconds,
+        ];
+    }
+}

Couchbase/Management/DropSearchIndexOptions.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * Copyright 2014-Present Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace Couchbase\Management;
+
+class DropSearchIndexOptions
+{
+    private ?int $timeoutMilliseconds;
+
+    /**
+     * Static helper to make code more readable
+     *
+     * @return DropSearchIndexOptions
+     *
+     * @since 4.1.5
+     */
+    public static function build(): DropSearchIndexOptions
+    {
+        return new DropSearchIndexOptions();
+    }
+
+    /**
+     * Sets the operation timeout in milliseconds
+     * @param int $milliseconds
+     * @return $this
+     *
+     * @since 4.1.5
+     */
+    public function timeout(int $milliseconds): DropSearchIndexOptions
+    {
+        $this->timeoutMilliseconds = $milliseconds;
+        return $this;
+    }
+
+    /**
+     * @param DropSearchIndexOptions|null $options
+     * @return array
+     * @internal
+     * @since 4.1.5
+     */
+    public static function export(?DropSearchIndexOptions $options): array
+    {
+        if ($options == null) {
+            return [];
+        }
+        return [
+            'timeoutMilliseconds' => $options->timeoutMilliseconds,
+        ];
+    }
+}

Couchbase/Management/FreezePlanSearchIndexOptions.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * Copyright 2014-Present Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace Couchbase\Management;
+
+class FreezePlanSearchIndexOptions
+{
+    private ?int $timeoutMilliseconds;
+
+    /**
+     * Static helper to make code more readable
+     *
+     * @return FreezePlanSearchIndexOptions
+     *
+     * @since 4.1.5
+     */
+    public static function build(): FreezePlanSearchIndexOptions
+    {
+        return new FreezePlanSearchIndexOptions();
+    }
+
+    /**
+     * Sets the operation timeout in milliseconds
+     * @param int $milliseconds
+     * @return $this
+     *
+     * @since 4.1.5
+     */
+    public function timeout(int $milliseconds): FreezePlanSearchIndexOptions
+    {
+        $this->timeoutMilliseconds = $milliseconds;
+        return $this;
+    }
+
+    /**
+     * @param FreezePlanSearchIndexOptions|null $options
+     * @return array
+     * @internal
+     * @since 4.1.5
+     */
+    public static function export(?FreezePlanSearchIndexOptions $options): array
+    {
+        if ($options == null) {
+            return [];
+        }
+        return [
+            'timeoutMilliseconds' => $options->timeoutMilliseconds,
+        ];
+    }
+}