| 1: | <?php |
| 2: | |
| 3: | declare(strict_types=1); |
| 4: | |
| 5: | /** |
| 6: | * Copyright OpenSearch Contributors |
| 7: | * SPDX-License-Identifier: Apache-2.0 |
| 8: | * |
| 9: | * OpenSearch PHP client |
| 10: | * |
| 11: | * @link https://github.com/opensearch-project/opensearch-php/ |
| 12: | * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co) |
| 13: | * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 |
| 14: | * @license https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1 |
| 15: | * |
| 16: | * Licensed to Elasticsearch B.V under one or more agreements. |
| 17: | * Elasticsearch B.V licenses this file to you under the Apache 2.0 License or |
| 18: | * the GNU Lesser General Public License, Version 2.1, at your option. |
| 19: | * See the LICENSE file in the project root for more information. |
| 20: | */ |
| 21: | |
| 22: | namespace OpenSearch\Namespaces; |
| 23: | |
| 24: | use OpenSearch\Serializers\SerializerInterface; |
| 25: | use OpenSearch\Transport; |
| 26: | use OpenSearch\TransportInterface; |
| 27: | |
| 28: | interface NamespaceBuilderInterface |
| 29: | { |
| 30: | /** |
| 31: | * Returns the name of the namespace. This is what users will call, e.g. the name |
| 32: | * "foo" will be invoked by the user as `$client->foo()` |
| 33: | */ |
| 34: | public function getName(): string; |
| 35: | |
| 36: | /** |
| 37: | * Returns the actual namespace object which contains your custom methods. The transport |
| 38: | * and serializer objects are provided so that your namespace may do whatever custom |
| 39: | * logic is required. |
| 40: | * |
| 41: | * @param Transport|TransportInterface $transport |
| 42: | * @param SerializerInterface $serializer |
| 43: | * @return Object |
| 44: | * |
| 45: | * @phpstan-ignore parameter.deprecatedClass |
| 46: | */ |
| 47: | public function getObject(Transport|TransportInterface $transport, SerializerInterface $serializer); |
| 48: | } |
| 49: |