Skip to content

Commit 2e4c122

Browse files
committed
php_api.md: Use absolute links to PHP API Ref
1 parent f9b8e24 commit 2e4c122

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

docs/api/php_api/php_api.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ page_type: reference
55

66
# PHP API
77

8-
The [public PHP API](../php_api_reference/) enables you to interact with [[= product_name =]]'s Repository and content model from your PHP code.
8+
The [public PHP API](/api/php_api/php_api_reference/index.html) enables you to interact with [[= product_name =]]'s Repository and content model from your PHP code.
99

1010
You can use it to create, read, update, manage, and delete all objects available in [[= product_name =]], namely content and related objects such as sections, locations, content types, or languages.
1111

@@ -18,37 +18,37 @@ The API provides access to content, user, content types, and other features thro
1818

1919
The full list of available services covers:
2020

21-
- [BatchOrderService](php_api_reference/classes/Ibexa-Contracts-Cart-BatchOrderServiceInterface.html)
22-
- [CorporateAccountService](php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CorporateAccountService.html) (recommended for company creation)
23-
- [CompanyService](php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CompanyService.html)
24-
- [ContentService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html)
25-
- [ContentTypeService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentTypeService.html)
26-
- [FieldTypeService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-FieldTypeService.html)
27-
- [InvitationService](php_api_reference/classes/Ibexa-Contracts-User-Invitation-InvitationService.html)
28-
- [LanguageService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-LanguageService.html)
29-
- [LocationService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html)
30-
- [MemberService](php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-MemberService.html)
31-
- [NotificationService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html)
32-
- [ObjectStateService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-ObjectStateService.html)
33-
- [RoleService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-RoleService.html)
34-
- [SearchService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-SearchService.html)
35-
- [SectionService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-SectionService.html)
36-
- [ShippingAddressService](php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-ShippingAddressService.html)
37-
- [SpreadsheetProcessorInterface](php_api_reference/classes/Ibexa-Contracts-Cart-FileProcessor-SpreadsheetProcessorInterface.html)
38-
- [TaxonomyService](php_api_reference/classes/Ibexa-Contracts-Taxonomy-Service-TaxonomyServiceInterface.html)
39-
- [TranslationService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-TranslationService.html)
40-
- [TrashService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-TrashService.html)
41-
- [URLAliasService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLAliasService.html)
42-
- [URLService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLService.html)
43-
- [URLWildcardService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLWildcardService.html)
44-
- [UserPreferenceService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-UserPreferenceService.html)
45-
- [UserService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-UserService.html)
21+
- [BatchOrderService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cart-BatchOrderServiceInterface.html)
22+
- [CorporateAccountService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CorporateAccountService.html) (recommended for company creation)
23+
- [CompanyService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CompanyService.html)
24+
- [ContentService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html)
25+
- [ContentTypeService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentTypeService.html)
26+
- [FieldTypeService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-FieldTypeService.html)
27+
- [InvitationService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-User-Invitation-InvitationService.html)
28+
- [LanguageService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-LanguageService.html)
29+
- [LocationService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html)
30+
- [MemberService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-MemberService.html)
31+
- [NotificationService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html)
32+
- [ObjectStateService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ObjectStateService.html)
33+
- [RoleService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-RoleService.html)
34+
- [SearchService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SearchService.html)
35+
- [SectionService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SectionService.html)
36+
- [ShippingAddressService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-ShippingAddressService.html)
37+
- [SpreadsheetProcessorInterface](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cart-FileProcessor-SpreadsheetProcessorInterface.html)
38+
- [TaxonomyService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Taxonomy-Service-TaxonomyServiceInterface.html)
39+
- [TranslationService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-TranslationService.html)
40+
- [TrashService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-TrashService.html)
41+
- [URLAliasService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLAliasService.html)
42+
- [URLService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLService.html)
43+
- [URLWildcardService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLWildcardService.html)
44+
- [UserPreferenceService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-UserPreferenceService.html)
45+
- [UserService](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-UserService.html)
4646

4747
You can access the PHP API by injecting relevant services into your code:
4848

4949
- By using [auto-wiring]([[= symfony_doc =]]/service_container/autowiring.html), and the service classname in the `Ibexa\Contracts` namespace (see `bin/console debug:autowiring | grep Ibexa.Contracts`).
5050
- By using [service parameters]([[= symfony_doc =]]/service_container.html#service-parameters), and service aliases (see `bin/console debug:autowiring | grep ibexa.api`).
51-
- By using the repository's `get[ServiceName]()` methods, for example, [`Repository::getContentService()`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getContentService), or [`getUserService()`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getUserService).
51+
- By using the repository's `get[ServiceName]()` methods, for example, [`Repository::getContentService()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getContentService), or [`getUserService()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getUserService).
5252
(Prefer injecting several Repository's dedicated services instead of the whole Repository if the Repository itself isn't needed.)
5353

5454
!!! caution
@@ -57,12 +57,12 @@ You can access the PHP API by injecting relevant services into your code:
5757

5858
## Value objects
5959

60-
The services provide interaction with read-only value objects from the [`Ibexa\Contracts\Core\Repository\Values`](php_api_reference/namespaces/ibexa-contracts-core-repository-values.html) namespace.
61-
Those objects are divided into sub-namespaces, such as [`Content`](php_api_reference/namespaces/ibexa-contracts-core-repository-values-content.html), [`User`](php_api_reference/namespaces/ibexa-contracts-core-repository-values-user.html) or [`ObjectState`](php_api_reference/namespaces/ibexa-contracts-core-repository-values-objectstate.html).
60+
The services provide interaction with read-only value objects from the [`Ibexa\Contracts\Core\Repository\Values`](/api/php_api/php_api_reference/namespaces/ibexa-contracts-core-repository-values.html) namespace.
61+
Those objects are divided into sub-namespaces, such as [`Content`](/api/php_api/php_api_reference/namespaces/ibexa-contracts-core-repository-values-content.html), [`User`](/api/php_api/php_api_reference/namespaces/ibexa-contracts-core-repository-values-user.html) or [`ObjectState`](/api/php_api/php_api_reference/namespaces/ibexa-contracts-core-repository-values-objectstate.html).
6262
Each sub-namespace contains a set of value objects,
63-
such as [`Content\Content`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Content.html) or [`User\Role`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-User-Role.html).
63+
such as [`Content\Content`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Content.html) or [`User\Role`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-User-Role.html).
6464

65-
Value objects come with their own properties, such as `$content->id` or `$location->hidden`, and with methods that provide access to more related information, such as [`Content\Relation::getSourceContentInfo()`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Relation.html#method_getSourceContentInfo) or [`User\Role::getPolicies()`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-User-Role.html#method_getPolicies).
65+
Value objects come with their own properties, such as `$content->id` or `$location->hidden`, and with methods that provide access to more related information, such as [`Content\Relation::getSourceContentInfo()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Relation.html#method_getSourceContentInfo) or [`User\Role::getPolicies()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-User-Role.html#method_getPolicies).
6666

6767
### Creating and updating objects
6868

@@ -131,7 +131,7 @@ To identify as a different user, you need to use the `UserService` together with
131131

132132
!!! tip
133133

134-
[`Ibexa\Contracts\Core\Repository\PermissionService`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-PermissionService.html) can be injected to have a Service which provides both `PermissionResolver` and `PermissionCriterionResolver`.
134+
[`Ibexa\Contracts\Core\Repository\PermissionService`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-PermissionService.html) can be injected to have a Service which provides both `PermissionResolver` and `PermissionCriterionResolver`.
135135
It supports auto-wiring.
136136

137137
This isn't required in template functions or controller code, as the HTTP layer takes care of identifying the user, and automatically sets it in the repository.

0 commit comments

Comments
 (0)