"Public API" → "public PHP API": Doc 3.3 (#2169)

Author: adriendupuis

docs/api/field_type_api.md

@@ -35,7 +35,7 @@ On the top layer, the Field Type needs to provide conversion from and to a simpl
 
 [[= include_file('docs/snippets/simple_hash_value_caution.md') =]]
 
-Below that, the Field Type must support the **Public API** implementation regarding:
+Below that, the Field Type must support the **public PHP API** implementation regarding:
 
 - Settings definition for `FieldDefinition`
 - Value creation and validation

docs/api/field_type_type_and_value.md

@@ -24,7 +24,7 @@ The Type class of a Field Type provides an implementation of the [`eZ\Publish\SP
 
 A custom Field Type is used in a Field definition of a custom Content Type.
 You can additionally provide [settings for the Field Type](#field-type-settings) and a [validator configuration](field_type_validation.md).
-Since the Public API cannot know anything about these, their handling is delegated to the Field Type itself through the following methods:
+Since the public PHP API cannot know anything about these, their handling is delegated to the Field Type itself through the following methods:
 
 #### `getFieldTypeIdentifier()`
 
@@ -33,15 +33,15 @@ By convention it should be prefixed by a unique vendor shortcut (e.g. `ibexa` fo
 
 #### `getSettingsSchema()`
 
-This method retrieves via Public API a schema for the Field Type settings. A typical setting would be e.g. default value. The settings structure defined by this schema is stored in the `FieldDefinition`. Since it is not possible to define a generic format for such a schema, the Field Type is free to return any serializable data structure from this method.
+This method retrieves via public PHP API a schema for the Field Type settings. A typical setting would be e.g. default value. The settings structure defined by this schema is stored in the `FieldDefinition`. Since it is not possible to define a generic format for such a schema, the Field Type is free to return any serializable data structure from this method.
 
 #### `getValidatorConfigurationSchema()`
 
 In addition to normal settings, the Field Type should provide schema settings for its validation process. The schema describes what kind of validation can be performed by the Field Type and which settings the user can specify to these validation methods. For example, the `ezstring` type can validate minimum and maximum length of the string. It therefore provides a schema to indicate to the user that they might specify the corresponding restrictions, when creating a `FieldDefinition` with this type. The schema does not underlie any regulations, except for that it must be serializable.
 
 #### `validateFieldSettings()`
 
-The type is asked to validate the settings (provided by the user) before the Public API stores those settings for the Field Type in a `FieldDefinition`. As a result, the Field Type must return if the given settings comply to the schema defined by `getSettingsSchema()`.
+The type is asked to validate the settings (provided by the user) before the public PHP API stores those settings for the Field Type in a `FieldDefinition`. As a result, the Field Type must return if the given settings comply to the schema defined by `getSettingsSchema()`.
 
 #### `validateValidatorConfiguration()`
 
@@ -62,7 +62,7 @@ To generate Content item name or URL alias the Field Type name must be a part of
 
 ## Value handling
 
-A Field Type needs to deal with the custom value format provided by it. In order for the public API to work properly, it delegates working with such custom Field values to the corresponding Field Type. The `ez\Publish\SPI\FieldType\FieldType` interface therefore provides the following methods:
+A Field Type needs to deal with the custom value format provided by it. In order for the public PHP API to work properly, it delegates working with such custom Field values to the corresponding Field Type. The `ez\Publish\SPI\FieldType\FieldType` interface therefore provides the following methods:
 
 #### `acceptValue()`
 

docs/api/public_php_api.md

@@ -66,7 +66,7 @@ while `Content` enables you to retrieve Fields, Content Type, or previous versio
 
 !!! note
 
-    The Public API value objects should not be serialized.
+    The public PHP API value objects should not be serialized.
 
     Serialization of value objects, for example, `eZ\Publish\API\Repository\Values\Content\ContentInfo` /  `eZ\Publish\API\Repository\Values\Content\VersionInfo` 
     or `eZ\Publish\API\Repository\Values\Content\Location` results in memory limit exceeded error.

docs/guide/architecture.md

@@ -7,29 +7,29 @@ description: Ibexa DXP architecture is structured in multiple layers connected b
 [[= product_name =]] architecture is based on the philosophy to **use APIs** that will be maintained in the long term. This **makes upgrades easier and provides lossless couplings** between all parts of the architecture, at the same time improving the migration capabilities of the system.
 
 The structure of an [[= product_name =]] app is based on the Symfony framework
-but content management functions rely on the Public API.
-Other applications integrate with [[= product_name =]] via REST API, which also relies on the Public API.
+but content management functions rely on the public PHP API.
+Other applications integrate with [[= product_name =]] via REST API, which also relies on the public PHP API.
 
 ![Architecture](img/architecture.png "Architecture")
 
 The architecture of [[= product_name =]] is layered and uses clearly defined APIs between the layers.
 
-|Layer|Description|
-|-----|-----------|
-|[Back Office](../extending/config_back_office.md)|Back Office contains all the necessary parts to run the [[= product_name =]] Back Office interface.|
-|[HTTP Cache](cache/http_cache.md))|Symfony HTTP cache is used to manage content "view" cache with an expiration model. In addition it is extended by using FOSHttpCache to add several advanced features.|
-|[Controllers](content_rendering/queries_and_controllers/controllers.md)|Controllers created by you to read information from a Request object, create and return a Response objects.|
-|[Twig templates](content_rendering/twig_function_reference/twig_functions_reference.md)|Set of custom and built-in Twig templates. User interfaces are developed with the Twig template engine and query the Public API directly.|
-|[REST API v2](../api/rest_api_usage.md)|The REST API v2 enables you to interact with an [[= product_name =]] installation using the HTTP protocol, following a REST interaction model.|
-|[GraphQL](../api/graphql.md)|GraphQL for [[= product_name =]] exposes the domain model using the Repository, based on Content Type groups, Content Types and Field definitions.|
-|[Public API](../api/public_php_api.md)|Public API exposes the Repository which enables you to create, read, update, manage and delete all objects available in [[= product_name =]].|
-|Business Logic|The business logic is defined in the kernel. This business logic is exposed to applications via an API. It is used to organize development of the user interface layer.|
-|[SPI](repository.md#spi)|Service Provider Interface which defines contracts for implementing various parts of the system, including persistence layer (`SPI\Persistence`), custom Field Types, custom Limitations, etc.|
-|[Persistence cache](persistence_cache.md)|The implementation of SPI\Persistence that decorates the main backend implementation.|
-|[Search](search/search.md)|Search API that allows both full-text search and querying the content.|
-|[SQL Storage Engine](search/search.md#legacy-search-engine)|Legacy search engine is SQL-based and uses Doctrine's database connection.|
-|[Solr Storage Engine](search/solr.md)|Transparent drop-in replacement for the SQL-based Legacy search engine.|
-|[IO](file_management/file_management.md#native-io-handler)|The IO API is organized around two types of handlers, both used by the IOService.|
-|[IO Handler](clustering.md#dfs-io-handler)|The IO Handler manipulates metadata, making up for the potential inconsistency of network-based filesystems.|
-|[Recommendation](personalization/recommendation_client.md#enabling-recommendations)|Recommendation API.|
-|[Recommendation Engine](personalization/recommendation_client.md#enabling-recommendations)|Recommendation Engine allows displaying recommendations on your website.|
+| Layer                                                                                      | Description                                                                                                                                                                                    |
+|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Back Office](../extending/config_back_office.md)                                          | Back Office contains all the necessary parts to run the [[= product_name =]] Back Office interface.                                                                                            |
+| [HTTP Cache](cache/http_cache.md))                                                         | Symfony HTTP cache is used to manage content "view" cache with an expiration model. In addition it is extended by using FOSHttpCache to add several advanced features.                         |
+| [Controllers](content_rendering/queries_and_controllers/controllers.md)                    | Controllers created by you to read information from a Request object, create and return a Response objects.                                                                                    |
+| [Twig templates](content_rendering/twig_function_reference/twig_functions_reference.md)    | Set of custom and built-in Twig templates. User interfaces are developed with the Twig template engine and query the public PHP API directly.                                                  |
+| [REST API v2](../api/rest_api_usage.md)                                                    | The REST API v2 enables you to interact with an [[= product_name =]] installation using the HTTP protocol, following a REST interaction model.                                                 |
+| [GraphQL](../api/graphql.md)                                                               | GraphQL for [[= product_name =]] exposes the domain model using the Repository, based on Content Type groups, Content Types and Field definitions.                                             |
+| [Public PHP API](../api/public_php_api.md)                                                 | Public PHP API exposes the Repository which enables you to create, read, update, manage and delete all objects available in [[= product_name =]].                                              |
+| Business Logic                                                                             | The business logic is defined in the kernel. This business logic is exposed to applications via an API. It is used to organize development of the user interface layer.                        |
+| [SPI](repository.md#spi)                                                                   | Service Provider Interface which defines contracts for implementing various parts of the system, including persistence layer (`SPI\Persistence`), custom Field Types, custom Limitations, etc. |
+| [Persistence cache](persistence_cache.md)                                                  | The implementation of SPI\Persistence that decorates the main backend implementation.                                                                                                          |
+| [Search](search/search.md)                                                                 | Search API that allows both full-text search and querying the content.                                                                                                                         |
+| [SQL Storage Engine](search/search.md#legacy-search-engine)                                | Legacy search engine is SQL-based and uses Doctrine's database connection.                                                                                                                     |
+| [Solr Storage Engine](search/solr.md)                                                      | Transparent drop-in replacement for the SQL-based Legacy search engine.                                                                                                                        |
+| [IO](file_management/file_management.md#native-io-handler)                                 | The IO API is organized around two types of handlers, both used by the IOService.                                                                                                              |
+| [IO Handler](clustering.md#dfs-io-handler)                                                 | The IO Handler manipulates metadata, making up for the potential inconsistency of network-based filesystems.                                                                                   |
+| [Recommendation](personalization/recommendation_client.md#enabling-recommendations)        | Recommendation API.                                                                                                                                                                            |
+| [Recommendation Engine](personalization/recommendation_client.md#enabling-recommendations) | Recommendation Engine allows displaying recommendations on your website.                                                                                                                       |

docs/guide/content_management.md

@@ -247,7 +247,7 @@ These Fields allow you to select one or more other Content items in the Field va
 
 *Relations at Content item level* can be of three different types:
 
-- *Common Relations* are created between two Content items using the Public API.
+- *Common Relations* are created between two Content items using the public PHP API.
 - *RichText linked Relations* are created using a Field of the RichText type.
 When an internal link (a link to another Location or Content item) is placed in a RichText Field,
 the system automatically creates a Relation.

docs/guide/file_management/binary_media_download.md

@@ -32,6 +32,6 @@ Optional parameter `inLanguage` may be used to specify File content translation.
 
 ## REST API: `uri` property
 
-The `uri` property of Binary Fields in REST contains a valid download URL, of the same format as the Public API, prefixed with the same host as the REST Request.
+The `uri` property of Binary Fields in REST contains a valid download URL, of the same format as the public PHP API, prefixed with the same host as the REST Request.
 
 For [more information about REST API see the documentation](../../api/rest_api_guide).

docs/guide/file_management/handling_file_url.md

@@ -42,7 +42,7 @@ ibexa:
 
 ## `io.url_prefix`
 
-Any BinaryFile returned by the public API is prefixed with the value of this setting, internally stored as `ibexa.site_access.config.<scope>.io.url_prefix`.
+Any BinaryFile returned by the public PHP API is prefixed with the value of this setting, internally stored as `ibexa.site_access.config.<scope>.io.url_prefix`.
 
 ### `io.url_prefix` dynamic service container setting
 

docs/guide/limitation_reference.md

@@ -255,7 +255,7 @@ A Limitation to specify that only the owner of the Content item gets the selecte
 |Value|UI value|Description|
 |------|------|------|
 |`1`|"self"|Only the User who is the owner gets access|
-|`2`|"session"|Deprecated and works exactly like "self" in Public API since it has no knowledge of user Sessions|
+|`2`|"session"|Deprecated and works exactly like "self" in public PHP API since it has no knowledge of user Sessions|
 
 ## Owner of Parent Limitation
 
@@ -274,7 +274,7 @@ A Limitation to specify that only the Users who own all parent Locations of a Co
 |Value|UI value|Description|
 |------|------|------|
 |`1`|"self"|Only the User who is the owner of all parent Locations gets access|
-|`2`|"session"|Deprecated and works exactly like "self" in Public API since it has no knowledge of user Sessions|
+|`2`|"session"|Deprecated and works exactly like "self" in public PHP API since it has no knowledge of user Sessions|
 
 ## Parent Depth Limitation
 
@@ -350,7 +350,7 @@ A Limitation to specify to which SiteAccesses a certain permission applies, used
 
 ### Legacy compatibility notes
 
-`SiteAccess` Limitation is deprecated and is not used actively in Public API, but is allowed for being able to read / create Limitations for legacy.
+`SiteAccess` Limitation is deprecated and is not used actively in public PHP API, but is allowed for being able to read / create Limitations for legacy.
 
 ## Subtree of Location Limitation
 

docs/guide/repository.md

@@ -6,9 +6,9 @@ description: Ibexa DXP's content Repository stores all content and its related i
 
 The content Repository is where all your content is stored.
 
-## Services: Public API
+## Services: public PHP API
 
-The Public API exposes Symfony services for all of its Repository services.
+The public PHP API exposes Symfony services for all of its Repository services.
 
 | Service ID                             | Type                                             |
 |----------------------------------------|--------------------------------------------------|
@@ -32,7 +32,7 @@ The Public API exposes Symfony services for all of its Repository services.
 
 ## API
 
-Every Public API Service interface and value object defined in `eZ\Publish\API` namespace strictly follows [Semantic Versioning](https://semver.org/) backward compatibility (BC) promise for API consumers.
+Every public PHP API Service interface and value object defined in `eZ\Publish\API` namespace strictly follows [Semantic Versioning](https://semver.org/) backward compatibility (BC) promise for API consumers.
 It means that every usage of API (API call) is guaranteed to work between minor releases.
 
 What can change between minor releases is the API method signature. Because of that, implementation of API interfaces by third party packages (except for the ones implemented with built-in bundles) is not directly supported.

docs/guide/url_management.md

@@ -231,7 +231,7 @@ Also, you can decide whether the user sees the content at the address that uses
 For example, a URL wildcard called `pictures/*/*` can use `media/images/{1}/{2}` as destination.
 In this case, accessing `<yourdomain>/pictures/home/photo/` loads `<yourdomain>/media/images/home/photo/`.
 
-You can configure URL wildcards either in the Back Office, or with the Public API.
+You can configure URL wildcards either in the Back Office, or with the public PHP API.
 
 Before you configure URL wildcards, you must enable the feature in configuration in the `config/packages/ezplatform.yaml` file:
 
@@ -250,9 +250,9 @@ The URL wildcards tab contains all the information about each URL wildcard. You
     To be able to modify wildcard support settings in the user interface, you must have the `content/urltranslator` Policy. For more information about permissions, see [Permissions](permissions.md).
 
 
-### Configuring URL wildcards with the Public API
+### Configuring URL wildcards with the public PHP API
 
-You can create URL wildcards with the Public API by using the `URLWildcardService` service:
+You can create URL wildcards with the public PHP API by using the `URLWildcardService` service:
 
 ``` php
 $source = 'pictures/*/*';