Skip to content

Commit 4950e69

Browse files
ketkee-aryamaneketkee-aryamane
authored
Merge pull request #1472 from ketkee-aryamane/sync-php-client-landing-page-with-git-php-readme
sync the Git page and the docs page for PHP client overview
2 parents 83c728c + 0bd4797 commit 4950e69

File tree

2 files changed

+35
-17
lines changed

2 files changed

+35
-17
lines changed

‎docs/docset.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ toc:
99
- toc: release-notes
1010
subs:
1111
es: "Elasticsearch"
12+
es-serverless: "Elasticsearch Serverless"
13+
serverless-short: "Serverless"

‎docs/reference/index.md‎

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,52 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html
44
- https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/overview.html
5+
navigation_title: PHP
56
---
67

7-
# PHP [overview]
8+
# {{es}} PHP client overview [overview]
89

9-
This is the official PHP client for {{es}}. It is designed to be a low-level client that does not stray from the REST API.
10+
The {{es}} PHP client is designed to be a low-level client. All methods closely match the REST API and the method structure of other language clients. This makes it easier to get started with a client and switch from one language to another.
1011

11-
All methods closely match the REST API, and furthermore, match the method structure of other language clients (Ruby, Python, and so on). We hope that this consistency makes it easy to get started with a client and to seamlessly switch from one language to the next with minimal effort.
12+
It provides a response-handling layer that makes it easier to access HTTP responses in different formats. The PSR-18 HTTP response can be accessed as a PHP array, object, or a raw string. For more details, refer to [blog post for {{es}} PHP client](https://www.elastic.co/blog/introducing-the-new-php-client-for-elasticsearch-8).
13+
Additionally, the client provides helpers to map an ES|QL result directly to a PHP object. For more information, refer to [map php result to an object](https://www.elastic.co/search-labs/blog/esql-php-map-object-class).
1214

13-
The client is designed to facilitate the API call using different way to read the results using associative array, object, string or [PSR-7](https://www.php-fig.org/psr/psr-7/).
14-
15-
Refer to the [*Getting started*](/reference/getting-started.md) page for a step-by-step quick start with the PHP client.
15+
The client allows you to make API calls and read the response in multiple formats: associative array, object, raw string, or [PSR-7](https://www.php-fig.org/psr/psr-7/) response.
1616

17+
For a step-by-step quickstart with the client, refer to the [Getting started guide](/reference/getting-started.md) .
1718

1819
## PSR 7 standard [psr-7-standard]
1920

2021
The {{es}} PHP client uses the [PSR](https://www.php-fig.org/psr/) 7 standard. This standard is a community effort that contains a set of interfaces defined by the PHP Framework Interop Group. For more information, refer to the [PSR 7 standard documentation](https://www.php-fig.org/psr/psr-7/).
2122

2223

23-
## {{es}} and PHP version Compatibility [version-compatibility]
24-
25-
The {{es}} client is compatible with currently maintained PHP versions.
24+
## {{es}} and PHP client version compatibility [version-compatibility]
2625

27-
Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of {{es}} without breaking. It does not mean that the client automatically supports new features of newer {{es}} versions; it is only possible after a release of a new client version. For example, a 8.12 client version won’t automatically support the new features of the 8.13 version of {{es}}, the 8.13 client version is required for that. {{es}} language clients are only backwards compatible with default distributions and without guarantees made.
26+
The {{es}} PHP client is compatible with PHP versions that are currently maintained and supported.
2827

29-
| Elasticsearch Version | Elasticsearch-PHP Branch | Supported |
30-
| --- | --- | --- |
31-
| main | main | |
32-
| 8.x | 8.x | 8.x |
33-
| 7.x | 7.x | 7.17 |
34-
35-
* [Breaking changes from 7.x](https://www.elastic.co/guide/en/elasticsearch/client/php-api/7.17/breaking_changes.html)
28+
{{es}} language clients are forward compatible. This ensures that the client remains compatible with {{es}} instances running the same or newer minor versions, preventing any breaking changes. However, for all new features in the newer {{es}} versions, the client will support them only after a new client version is released. For example, the `8.12` {{es}} PHP client does not support new features in
29+
{{es}} `8.13`. You must upgrade to the `8.13` version of the {{es}} PHP client to use them.
3630

31+
{{es}} language clients are backward-compatible only with default distributions and there are no guarantees for customized or modified versions. The following table provides the compatibility information between {{es}} and {{es}} PHP client:
3732

33+
| Elasticsearch Version | Elasticsearch-PHP Branch | Supported |
34+
|-----------------------|--------------------------|-----------|
35+
| main | main | |
36+
| 9.x | 9.x | 9.x |
37+
| 8.x | 8.x | 8.x |
38+
39+
## Changes and compatibility notes for {{es}} PHP client 9.x
40+
41+
The `elasticsearch-php` client version `9.x` follows the same architecture as `8.x`. It continues to support [PSR-7](https://www.php-fig.org/psr/psr-7/) for HTTP messages and [PSR-18](https://www.php-fig.org/psr/psr-18/) for HTTP client communications.
42+
43+
Although we've worked to keep `9.x` backward compatible, the following important changes may impact your setup:
44+
- Compatibility with {{es}} `9.x`: All changes and additions to {{es}} APIs `9.x` release are reflected in the `elasticsearch-php` client release. You must use `elasticsearch-php` client version `9.x` to access all new endpoints in {{es}} `9.x`. Using an older client version will break your code.
45+
- Compatibility with {{es-serverless}}:
46+
- The `elastic/elasticsearch-serverless` is deprecated, and all its functionality has been merged into the `elasticsearch-php` client. This doesn't have any impact on the default working of the client.
47+
- If you use any endpoint available in {{serverless-short}}, you'll see that the corresponding PHP function contains a `@group serverless` phpdoc attribute.
48+
- If you use any endpoint that is not available in {{serverless-short}}, you'll get a `410` HTTP error with the message: `This endpoint exists but is not available when running in serverless mode`.
49+
- If you use a URL managed by Elastic, for example `*.elastic.cloud`, the `9.x` client will recognize that it is communicating with a serverless instance.
50+
- If you are using a proxy, the `9.x` client will recognize that the host is serverless from the first response. Alternatively, you can explicitly specify that the host is serverless using the `Client::setServerless(true)` function. The argument to this function is set to `false` by default.
51+
- New transport library with PSR-18 cURL client as default: We've removed the `Guzzle` dependency from the client. The built-in cURL-based HTTP client will be used by default if no other PSR-18 compatible clients are detected. See release [9.0.0](https://github.com/elastic/elastic-transport-php/releases/tag/v9.0.0) of elastic-transport-php.
52+
53+
For detailed information on all the breaking changes, refer to [breaking changes.](https://github.com/elastic/elasticsearch-php/blob/main/BREAKING_CHANGES.md)

0 commit comments

Comments
 (0)