Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-4929: PHP API reference #1904

Merged
merged 196 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from 177 commits
Commits
Show all changes
196 commits
Select commit Hold shift + click to select a range
5b2d57a
Add a script to generate a PHP API reference
adriendupuis Feb 23, 2023
46cfd75
mkdocs.yml: Add PHP API reference to the API chapter
adriendupuis Feb 23, 2023
dc1da24
Stylize PhpDoc
adriendupuis Mar 9, 2023
d833f70
Stylize PhpDoc
adriendupuis Mar 9, 2023
4b8538c
Stylize PhpDoc
adriendupuis Mar 9, 2023
060038b
PhpDoc config
adriendupuis Mar 9, 2023
645d1b8
php_api.md: Links to PHP API Reference
adriendupuis Mar 9, 2023
d954717
phpdoc.dist.xml: (minor) Add link to doc
adriendupuis Mar 9, 2023
05b8b4e
move paths from phpdoc.sh to phpdoc.dist.xml
adriendupuis Mar 14, 2023
54683cf
phpdoc.dist.xml: Also ignore spec/ directories
adriendupuis Mar 14, 2023
217cd2a
php_api.md: update links to PHP API Reference
adriendupuis Mar 15, 2023
7f860a0
(minor) php_api.md: typo: mv a period out of a link
adriendupuis Mar 15, 2023
31db536
php_api.md: More links to the PHP API Reference instead of GitHub
adriendupuis Mar 15, 2023
ccd63f2
php_api.md: getContentCreateStruct → ContentService::newContentCreate…
adriendupuis Mar 15, 2023
1cc420e
php_api.md: PermissionService link
adriendupuis Mar 15, 2023
cef8a21
php_api.md: Content\Content can't retrieve previous versions
adriendupuis Mar 15, 2023
5d67616
php_api.md: getContentService is available on Repository (and only th…
adriendupuis Mar 15, 2023
2c9d050
php_api.md: typo
adriendupuis Mar 15, 2023
b061c44
php_api.md: Complete Field Types as tagged services example
adriendupuis Mar 15, 2023
03c6e78
php_api.md: Rm and recycle ezconf2018-api, reorder service access
adriendupuis Mar 15, 2023
f7933b4
php_api.md: Link to autowiring; Fix list
adriendupuis Mar 15, 2023
9dae0cb
php_api.md: "auto-wiring" instead of "autowiring"
adriendupuis Mar 15, 2023
7a752e6
php_api.md: Fix links to PHP API Ref
adriendupuis Mar 15, 2023
23bacd9
phpdoc.sh: Add shebang and doc
adriendupuis Mar 15, 2023
d80ac57
phpdoc: Remove "indices/files" menu
adriendupuis Mar 16, 2023
994ff28
phpdoc: Copy file path to clipboard
adriendupuis Mar 16, 2023
48795ae
phpdoc.sh: Move to output dir after "indices/files" removal
adriendupuis Mar 16, 2023
92e23be
phpdoc.sh: Remove file not existing in the currently generated doc
adriendupuis Mar 17, 2023
bde7072
custom.css.twig: Ease SVG disks color maintenance
adriendupuis Mar 17, 2023
748719a
.phpdoc/template/: Fix or Add link to source template
adriendupuis Mar 17, 2023
f2b5717
PHP API Ref: Add minimal edition the element is available in.
adriendupuis Mar 21, 2023
e0a832d
phpdoc.sh: Avoid mapping edition package to inheriting edition
adriendupuis Mar 21, 2023
d9ef4ba
PHP API Ref header-title.html.twig: Ibexa logo links back to doc site
adriendupuis Mar 21, 2023
b397b96
tools/php_api_ref/README.md: About `jq` requirement
adriendupuis Mar 22, 2023
73a3de8
PHP API Reference's favicon.ico
adriendupuis Mar 27, 2023
7eb1e78
phpdoc.dist.xml: Hide private elements
adriendupuis Mar 29, 2023
09bd47e
Set version number in phpdoc.dist.xml from phpdoc.sh
adriendupuis Mar 30, 2023
5980056
.phpdoc/template: `__construct` has no return type
adriendupuis Apr 3, 2023
e5b4ee3
phpdoc sidebar.html.twig: Remove links to errors and markers
adriendupuis Apr 4, 2023
a66fd70
tags.html.twig: Filter out todo tag; Group tags by name
adriendupuis Apr 5, 2023
1c0f442
php_api.md: Add missing sentence end; Fix and add links to Reference
adriendupuis Apr 6, 2023
ba528d4
limitations.md: Link to PHP API Ref instead of GitHub
adriendupuis Apr 7, 2023
dca2a7a
invitations.md: Link to PHP API Ref instead of GitHub
adriendupuis Apr 7, 2023
f99bb36
edition-package-map.twig → package-edition-map.twig as package_editio…
adriendupuis Apr 7, 2023
1eab737
invitations.md limitations.md: Fix links to PHP API Reference
adriendupuis Apr 7, 2023
c555177
search_api.md: Add links to PHP API Reference Contracts, GitHub for o…
adriendupuis Apr 7, 2023
45ef9d9
phpdoc: Add components/menu.html.twig to sort namespaces
adriendupuis Apr 11, 2023
4e88203
php_api.md: Marked `Controller::getRepository()` as not recommended
adriendupuis Apr 13, 2023
621c6c5
phpdoc.sh: Obtained version detection compatible with 3.3
adriendupuis Apr 13, 2023
80c3343
phpdoc.sh: Increase script verbosity
adriendupuis Apr 13, 2023
f7164f2
phpdoc.sh: Increase working directories test
adriendupuis Apr 13, 2023
fd6c0f2
search_api.md: Add links to PHP API Reference in Contracts namespace
adriendupuis Apr 13, 2023
65810fb
oauth_authentication.md: Add links to PHP API Reference in Contracts …
adriendupuis Apr 13, 2023
e6d6bbe
phpdoc.sh: Increase script verbosity
adriendupuis Apr 14, 2023
6d321d6
PHP API Ref: Narrow to Contracts namespace; Add an intro; Hide "Packa…
adriendupuis Apr 18, 2023
a21d4b0
php_api.md: Detail PHP API access
adriendupuis Apr 18, 2023
b7e1b1a
php_api.md: Remove Controller::getRepository dead link
adriendupuis Apr 18, 2023
8c1622d
PHP API Ref templates: Move usesPackages=false to base.html.twig
adriendupuis Apr 19, 2023
3c5c63e
PHP API Ref tags.html.twig: skip @see or @uses if not a link
adriendupuis Apr 19, 2023
3aaa28f
PHP API Ref: Format and document templates
adriendupuis Apr 19, 2023
0259354
phpdoc.sh: Test phpDocumentor success before removing surplus
adriendupuis Apr 19, 2023
9731430
Merge branch 'master' into php_api_ref
adriendupuis Apr 21, 2023
cb02633
php_api.md: Links CorporateAccountService to its PHP API Ref entry
adriendupuis Apr 21, 2023
efc041a
custom.css.twig: Handle multiple <dd> like used in tags.html.twig
adriendupuis Apr 25, 2023
4792b09
phpdoc.sh: Fix obtained version detection need for 4.5.*@dev
adriendupuis Apr 26, 2023
421e971
phpdoc.sh: Get ready for incoming 4.5.*
adriendupuis Apr 26, 2023
c24fc36
Commit the package-edition-map.html.twig generated by phpdoc.sh
adriendupuis Apr 26, 2023
6400c69
PHP API Ref: increase sidebar TOC depth
adriendupuis May 5, 2023
acfc0b7
PHP API Ref: Update package-edition-map.twig for incoming 4.5.0 (usin…
adriendupuis May 5, 2023
b06d9fa
PHP API Ref: Add interfaces, classes and traits to left menu tree
adriendupuis May 23, 2023
77bbb0e
PHP API Ref: PoC/Prototype menu tree animation
adriendupuis May 24, 2023
af9884b
PHP API Ref: Remove ToC from interfaces, classes and traits pages
adriendupuis May 24, 2023
f6d5830
PHP API Ref: Re-add ToC from interfaces, classes and traits pages
adriendupuis May 25, 2023
09dbdbf
Merge branch 'master' into php_api_ref
adriendupuis May 25, 2023
8bf8833
PHP API Ref: phpdoc.sh: Remove more unused outputs
adriendupuis May 25, 2023
6bce627
Merge branch 'master' into php_api_ref
adriendupuis Jul 27, 2023
f2c7483
php_api_ref/…/base.html.twig: Fix current page selection
adriendupuis Jul 27, 2023
a3991b1
rest_responses.md: mv links Github → PHP API Ref
adriendupuis Jul 28, 2023
8d16d3d
language_api.md: mv links Github → PHP API Ref
adriendupuis Jul 28, 2023
ba8cb57
.phpdoc/templates: Smoother tree animation
adriendupuis Jul 28, 2023
889613f
(minor) format custom.css.twig
adriendupuis Jul 28, 2023
c6a9cbb
phpdoc.sh: Get ready for 4.6.0
adriendupuis Aug 1, 2023
f4b3083
phpdoc.sh: Make edition list an important parameter depending on VERSION
adriendupuis Aug 1, 2023
e74658a
Merge branch 'master' into php_api_ref
adriendupuis Sep 8, 2023
5908875
README.md: Use # syntaxt for level 1 heading
adriendupuis Sep 8, 2023
903561c
README.md: Fix style
adriendupuis Sep 8, 2023
af650b1
php_api.md: Links to PHP API Reference
adriendupuis Sep 8, 2023
b5d0b39
phpdoc.sh: VERSION='4.6.*@dev' for future beta or RC
adriendupuis Sep 8, 2023
fb61f35
php_api_ref: Method arguments as a table
adriendupuis Oct 2, 2023
e61f888
php_api_ref: Update package-edition-map.twig for 4.6.0-beta2
adriendupuis Oct 2, 2023
1f4fa35
language_api.md: Fix links to PHP API Ref
adriendupuis Oct 2, 2023
7117ab7
php_api_ref: Method arguments as a table: Rm col when unused
adriendupuis Oct 2, 2023
f4e08ea
PHP API Ref: Custom breadcrumbs = FQCN
adriendupuis Oct 3, 2023
a9f432a
phpdoc.sh: Document arguments and variables
adriendupuis Oct 17, 2023
bf53e53
Fix PHP API Ref ToC scrollbar
adriendupuis Dec 15, 2023
cdff21d
Merge branch 'master' into php_api_ref
adriendupuis Dec 15, 2023
7dd1048
Update package-edition-map.twig
adriendupuis Dec 15, 2023
b74fab5
IBX-4929: PHP API reference: Update to 3.4.3 (#2152)
adriendupuis Dec 18, 2023
675045e
Links to PHP API Reference (WIP)
adriendupuis Dec 19, 2023
55489ae
Links to PHP API Reference (WIP)
adriendupuis Dec 20, 2023
1fd3f84
Links to PHP API Reference (WIP)
adriendupuis Dec 20, 2023
204e509
Links to PHP API Reference (WIP): Fix some relative paths
adriendupuis Dec 20, 2023
0abc759
Links to PHP API Reference (WIP)
adriendupuis Dec 20, 2023
ef70485
Links to PHP API Reference (WIP)
adriendupuis Dec 20, 2023
ab7a0fb
Links to PHP API Reference (WIP)
adriendupuis Dec 20, 2023
c9c29b3
Links to PHP API Reference (End?)
adriendupuis Dec 20, 2023
2574572
Merge branch 'master' into php_api_ref
adriendupuis Dec 21, 2023
b6a766b
Merge branch 'master' into php_api_ref
adriendupuis Mar 11, 2024
8ef2d59
Merge branch 'master' into php_api_ref
adriendupuis Mar 19, 2024
ff0d66e
phpdoc.sh: dev mode
adriendupuis Mar 19, 2024
d67cf7c
phpdoc.sh: dev mode
adriendupuis Mar 21, 2024
7a5ed2e
phpdoc.sh: dev mode: possibility to choose the PHP binary path
adriendupuis Mar 21, 2024
1187dd8
phpdoc.sh: Change PHP_BINARY to avoid deprecated messages due to PHP …
adriendupuis Mar 21, 2024
50adb3a
phpdoc.sh: Change PHP_BINARY to avoid deprecated messages due to PHP …
adriendupuis Mar 21, 2024
7a1749e
phpdoc.sh: Change PHP_BINARY to avoid deprecated messages due to PHP …
adriendupuis Mar 21, 2024
018a5f0
header
GrabowskiM Apr 3, 2024
8c28e6f
images
GrabowskiM Apr 4, 2024
4c5ccff
content
GrabowskiM Apr 5, 2024
46d0531
images, fonts, classes
GrabowskiM Apr 5, 2024
958017c
moved files to template; fixed menu generation; added consts and rest
GrabowskiM Apr 5, 2024
b85f1e2
fix anchor links; added properties; styled method arguments; added me…
GrabowskiM Apr 8, 2024
8ca2d43
menu indents
GrabowskiM Apr 8, 2024
e116a5d
toc tracker
GrabowskiM Apr 9, 2024
c7d7bf7
search
GrabowskiM Apr 9, 2024
ab36f45
added copy; fixed some other things
GrabowskiM Apr 9, 2024
25407af
fixes
GrabowskiM Apr 10, 2024
7e3effd
phpdoc.sh: Move assets to .phpdoc/template/
adriendupuis Apr 10, 2024
6ab03bf
php_api_ref/…/menu.html.twig: Skip empty namespaces
adriendupuis Apr 11, 2024
bb480d1
php_api_ref/…/table-of-contents.html.twig: Skip empty namespaces
adriendupuis Apr 11, 2024
17e7261
diff things
GrabowskiM Apr 15, 2024
a3ed2bf
changed copy to mv
GrabowskiM Apr 15, 2024
b528b5b
Merge remote-tracking branch 'origin/php_api_ref' into php_api_ref
adriendupuis Apr 17, 2024
f9210c0
class-title.html.twig: Fix FQCN
adriendupuis Apr 17, 2024
1c4321e
content-header.html.twig: Hide not existing line "0"
adriendupuis Apr 17, 2024
abcfb08
.gitignore: unignore docs/api/php_api/php_api_reference/*
adriendupuis Apr 17, 2024
b3c50f0
phpdoc.sh: Back to default settings
adriendupuis Apr 17, 2024
6a1ce11
remove namespace.html.twig
adriendupuis Apr 17, 2024
daa7438
remove table-of-contents.html.twig
adriendupuis Apr 17, 2024
ef442c0
namespace page
GrabowskiM Apr 19, 2024
8706f5f
fixed some issues with search and toc
GrabowskiM Apr 24, 2024
80a1700
fixed switcher
GrabowskiM Apr 25, 2024
817261b
edition tag
GrabowskiM Apr 25, 2024
0a60160
fixes to descriptions; constructor returns; tags
GrabowskiM Apr 26, 2024
338997a
remove phpstan
GrabowskiM May 6, 2024
1eb8111
Merge branch 'master' into php_api_ref
adriendupuis May 17, 2024
c1494b8
Apply oauth_authentication.md change to oauth_client.md
adriendupuis May 17, 2024
6fab5b8
phpdoc.sh: set default settings
adriendupuis May 17, 2024
b2eb8f8
menu.html.twig: Fix duplicated `nav_id`
adriendupuis May 17, 2024
2f1a698
Add "title" (tooltip) to visibility icon
adriendupuis May 21, 2024
11ef0ab
Update package-edition-map.twig for 4.6.6
adriendupuis May 21, 2024
8241d07
PHP API Ref: Update favicon
adriendupuis May 21, 2024
59c923a
PHP API Ref: Default cursor on `.content-header__found-in abbr`
adriendupuis May 22, 2024
3e2e39e
content-header.html.twig: No "¶" when "Copy FQCN"
adriendupuis May 22, 2024
dab1f5a
PHP API Ref: Default cursor on `.content-header__subheader abbr`
adriendupuis May 22, 2024
c7c5596
Update public.svg
adriendupuis May 22, 2024
7e3f8d8
PHP API Ref: Fix anchor links to sections ("Properties", "Methods", e…
adriendupuis May 22, 2024
c73301d
PHP API Ref: `pointer` cursor on `.content-header__subheader a abbr`
adriendupuis May 22, 2024
b8e8db8
edition-tag.html.twig: list all editions supporting the feature
adriendupuis May 22, 2024
ac97ec3
edition-tag.html.twig: Skip nonexistent headless pill
adriendupuis May 22, 2024
7afe8b7
menu
GrabowskiM May 23, 2024
6e1da0b
fixed menu; added icons and fixed color to namespace page
GrabowskiM May 23, 2024
e2bd00e
remove listener from search
GrabowskiM May 23, 2024
cc45ad0
php_api.md: Use magic link
adriendupuis May 22, 2024
d36be37
php_api.md: Use magic link
adriendupuis May 22, 2024
3c43861
PHP API Ref: remove docs/…/favicon.png to let phpdoc.sh deal with it
adriendupuis May 23, 2024
10d2984
PHP API Ref index: Use code tag around namespaces
adriendupuis May 24, 2024
ad5709d
(minor) .phpdoc/template/index.html.twig: Add missing EOF new line
adriendupuis May 24, 2024
fb751a3
PHP API Ref: reworks main links
adriendupuis May 24, 2024
48dcac4
PHP API Ref: reworks main links
adriendupuis May 24, 2024
db93e2b
Add class documentation.
adriendupuis May 28, 2024
0efaf6a
PHP API Ref: rework cursor selector
adriendupuis May 28, 2024
bc8d088
PHP API Ref: format layout.html.twig
adriendupuis May 28, 2024
e0c54ef
added vertical line to second level of menu
GrabowskiM May 28, 2024
50029d8
phpdoc.sh: Add comment about how to have a package on a specific bran…
adriendupuis May 28, 2024
af3ad4d
Merge branch 'master' into php_api_ref
adriendupuis May 28, 2024
7a1296b
Rework PHP API intro (#2386) (minor fix)
adriendupuis May 28, 2024
b2a3825
Rework PHP API intro (#2386) (minor fix)
adriendupuis May 28, 2024
109e4cc
Apply suggestions from code review
adriendupuis May 29, 2024
48cf8b5
PHP API Ref's search_custom.js: fix placeholder
adriendupuis May 29, 2024
4217c56
Update tools/php_api_ref/README.md
adriendupuis May 29, 2024
b12407f
phpdoc.sh: Remove `@dev` from DXP_VERSION
adriendupuis May 29, 2024
34cfd54
PHP API Ref: harmonize "Interfaces, classes, and traits" headers
adriendupuis May 29, 2024
d969d80
phpdoc.sh: Get ready for next phpDocumentor version
adriendupuis May 29, 2024
b34e995
phpdoc.sh: phpDocumentor bin version 3.5.0
adriendupuis May 29, 2024
58477cf
phpdoc.sh: Update PHPDOC_TEMPLATE_VERSION to 3.5.0
adriendupuis May 29, 2024
c92d7fd
Clean up phpdoc.dist.xml
adriendupuis May 29, 2024
8c3d25a
Reorder phpdoc.sh variables
adriendupuis May 29, 2024
bbd577f
PHP API Ref active-menu.js: scrollIntoView
adriendupuis May 29, 2024
2009256
Add interface documentation
adriendupuis May 30, 2024
ed9b57b
phpdoc README.md: typo
adriendupuis May 30, 2024
688a13f
PHP API Ref active-menu.js: Avoid error on index
adriendupuis May 30, 2024
75b2662
PHP API Ref's search_custom.js: fix placeholder (inc delay)
adriendupuis May 30, 2024
360a4aa
PHP API Ref's "View on GitHub" more precise.
adriendupuis May 30, 2024
0fde354
PHP API Ref's "View on GitHub" more precise.
adriendupuis May 30, 2024
842017b
phpdoc README.md: enh. PHP_BINARY examples
adriendupuis May 30, 2024
2566dad
IBX-4929: PHP API reference: HTML output (#1972)
adriendupuis May 30, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions docs/api/php_api/php_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,37 +19,37 @@

The full list of available services covers:

- BatchOrderService
- CorporateAccountService (recommended for company creation)
- CompanyService
- [ContentService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/ContentService.php)
- [ContentTypeService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/ContentTypeService.php)
- [FieldTypeService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/FieldTypeService.php)
- [InvitationService](https://github.com/ibexa/user/blob/main/src/contracts/Invitation/InvitationService.php)
- [LanguageService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/LanguageService.php)
- [LocationService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/LocationService.php)
- MemberService
- [NotificationService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/NotificationService.php)
- [ObjectStateService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/ObjectStateService.php)
- [RoleService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/RoleService.php)
- [SearchService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/SearchService.php)
- [SectionService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/SectionService.php)
- ShippingAddressService
- SpreadsheetProcessorInterface (`\Ibexa\Contracts\Cart\FileProcessor\SpreadsheetProcessorInterface`)
- [TaxonomyService](taxonomy_api.md)
- [TranslationService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/TranslationService.php)
- [TrashService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/TrashService.php)
- [URLAliasService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/URLAliasService.php)
- [URLService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/URLService.php)
- [URLWildcardService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/URLWildcardService.php)
- [UserPreferenceService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/UserPreferenceService.php)
- [UserService](https://github.com/ibexa/core/blob/main/src/contracts/Repository/UserService.php)
- [BatchOrderService](php_api_reference/classes/Ibexa-Contracts-Cart-BatchOrderServiceInterface.html)

Check failure on line 22 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L22

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 22, "column": 49}}}, "severity": "ERROR"}
- [CorporateAccountService](php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CorporateAccountService.html) (recommended for company creation)

Check failure on line 23 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L23

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 23, "column": 55}}}, "severity": "ERROR"}
- [CompanyService](php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CompanyService.html)

Check failure on line 24 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L24

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 24, "column": 46}}}, "severity": "ERROR"}
- [ContentService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html)

Check failure on line 25 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L25

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 25, "column": 46}}}, "severity": "ERROR"}
- [ContentTypeService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentTypeService.html)

Check failure on line 26 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L26

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 26, "column": 50}}}, "severity": "ERROR"}
- [FieldTypeService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-FieldTypeService.html)

Check failure on line 27 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L27

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 27, "column": 48}}}, "severity": "ERROR"}
- [InvitationService](php_api_reference/classes/Ibexa-Contracts-User-Invitation-InvitationService.html)

Check failure on line 28 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L28

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 28, "column": 49}}}, "severity": "ERROR"}
- [LanguageService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-LanguageService.html)

Check failure on line 29 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L29

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 29, "column": 47}}}, "severity": "ERROR"}
- [LocationService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html)

Check failure on line 30 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L30

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 30, "column": 47}}}, "severity": "ERROR"}
- [MemberService](php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-MemberService.html)

Check failure on line 31 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L31

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 31, "column": 45}}}, "severity": "ERROR"}
- [NotificationService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html)

Check failure on line 32 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L32

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 32, "column": 51}}}, "severity": "ERROR"}
- [ObjectStateService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-ObjectStateService.html)

Check failure on line 33 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L33

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 33, "column": 50}}}, "severity": "ERROR"}
- [RoleService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-RoleService.html)

Check failure on line 34 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L34

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 34, "column": 43}}}, "severity": "ERROR"}
- [SearchService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-SearchService.html)

Check failure on line 35 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L35

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 35, "column": 45}}}, "severity": "ERROR"}
- [SectionService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-SectionService.html)

Check failure on line 36 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L36

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 36, "column": 46}}}, "severity": "ERROR"}
- [ShippingAddressService](php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-ShippingAddressService.html)

Check failure on line 37 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L37

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 37, "column": 54}}}, "severity": "ERROR"}
- [SpreadsheetProcessorInterface](php_api_reference/classes/Ibexa-Contracts-Cart-FileProcessor-SpreadsheetProcessorInterface.html)

Check failure on line 38 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L38

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 38, "column": 61}}}, "severity": "ERROR"}
- [TaxonomyService](php_api_reference/classes/Ibexa-Contracts-Taxonomy-Service-TaxonomyServiceInterface.html)

Check failure on line 39 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L39

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 39, "column": 47}}}, "severity": "ERROR"}
- [TranslationService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-TranslationService.html)

Check failure on line 40 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L40

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 40, "column": 50}}}, "severity": "ERROR"}
- [TrashService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-TrashService.html)

Check failure on line 41 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L41

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 41, "column": 44}}}, "severity": "ERROR"}
- [URLAliasService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLAliasService.html)

Check failure on line 42 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L42

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 42, "column": 47}}}, "severity": "ERROR"}
- [URLService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLService.html)

Check failure on line 43 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L43

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 43, "column": 42}}}, "severity": "ERROR"}
- [URLWildcardService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-URLWildcardService.html)

Check failure on line 44 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L44

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 44, "column": 50}}}, "severity": "ERROR"}
- [UserPreferenceService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-UserPreferenceService.html)

Check failure on line 45 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L45

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 45, "column": 53}}}, "severity": "ERROR"}
- [UserService](php_api_reference/classes/Ibexa-Contracts-Core-Repository-UserService.html)

Check failure on line 46 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L46

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 46, "column": 43}}}, "severity": "ERROR"}

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

- 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`).
- By using [service parameters]([[=symfony_doc=]]/service_container.html#service-parameters), and service aliases (see `bin/console debug:autowiring | grep ibexa.api`).
- By using the Repository's `get[ServiceName]()` methods: [`Repository::getContentService()`](https://github.com/ibexa/core/blob/v4.6.6/src/contracts/Repository/Repository.php#L46), [`getUserService()`](https://github.com/ibexa/core/blob/v4.6.6/src/contracts/Repository/Repository.php#L111), etc.
- By using the Repository's `get[ServiceName]()` methods: [`Repository::getContentService()`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getContentService), [`getUserService()`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getUserService), etc.
(Prefer injecting several Repository's dedicated services instead of the whole Repository if the Repository itself is not needed.)

!!! caution
Expand All @@ -58,14 +58,14 @@

## Value objects

The services provide interaction with read-only value objects from the [`Ibexa\Contracts\Core\Repository\Values`](https://github.com/ibexa/core/tree/v4.6.6/src/contracts/Repository/Values) namespace.
Those objects are divided into sub-namespaces, such as [`Content`](https://github.com/ibexa/core/tree/v4.6.6/src/contracts/Repository/Values/Content), [`User`](https://github.com/ibexa/core/tree/v4.6.6/src/contracts/Repository/Values/User) or [`ObjectState`](https://github.com/ibexa/core/tree/v4.6.6/src/contracts/Repository/Values/ObjectState).
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.
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).
Each sub-namespace contains a set of value objects,
such as [`Content\Content`](https://github.com/ibexa/core/blob/main/src/contracts/Repository/Values/Content/Content.php) or [`User\Role`](https://github.com/ibexa/core/blob/main/src/contracts/Repository/Values/User/Role.php).
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).

Check failure on line 64 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L64

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 64, "column": 55}}}, "severity": "ERROR"}

Value objects come with their own properties, such as `$content->id` or `$location->hidden`,
as well as with methods that provide access to more related information,
such as [`Content\Relation::getSourceContentInfo()`](https://github.com/ibexa/core/blob/v4.6.6/src/contracts/Repository/Values/Content/Relation.php#L80) or [`User\Role::getPolicies()`](https://github.com/ibexa/core/blob/v4.6.6/src/contracts/Repository/Values/User/Role.php#L60).
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).

### Creating and updating objects

Expand Down Expand Up @@ -139,7 +139,7 @@

!!! tip

`Ibexa\Contracts\Core\Repository\PermissionService` can be injected to have a Service which provides both `PermissionResolver` and `PermissionCriterionResolver`. It supports auto-wiring.
[`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`. It supports auto-wiring.

Check warning on line 142 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L142

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 142, "column": 275}}}, "severity": "WARNING"}

This is not required in template functions or controller code,
as the HTTP layer takes care of identifying the user, and automatically sets it in the repository.
Expand Down Expand Up @@ -182,7 +182,7 @@

Symfony service container uses service tags to dedicate services to a specific purpose. They are usually used for extension points.

[[= product_name =]] exposes multiple features using service tags, for example, Field Types.
[[= product_name =]] exposes multiple features using service tags. For example, Field Types are tagged `ibexa.field_type`.

!!! tip

Expand Down
4 changes: 2 additions & 2 deletions docs/api/rest_api/rest_api_usage/rest_responses.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
Accept-Patch: application/vnd.ibexa.api.ContentUpdate+json
```

Those example `Accept-Path` headers above indicate that the content could be modified by sending a [ContentUpdateStruct](https://github.com/ibexa/core/blob/main/src/contracts/Repository/Values/Content/ContentUpdateStruct.php) in XML or JSON.
Those example `Accept-Path` headers above indicate that the content could be modified by sending a [ContentUpdateStruct](../../php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-ContentUpdateStruct.html) in XML or JSON.

Check failure on line 91 in docs/api/rest_api/rest_api_usage/rest_responses.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/rest_api/rest_api_usage/rest_responses.md#L91

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/rest_api/rest_api_usage/rest_responses.md", "range": {"start": {"line": 91, "column": 162}}}, "severity": "ERROR"}

### Location header

Expand Down Expand Up @@ -162,7 +162,7 @@

The Response body is often a serialization in XML or JSON of an object as it could be retrieved using the Public PHP API.

For example, the resource `/content/objects/52` with the `Accept: application/vnd.ibexa.api.ContentInfo+xml` header returns a serialized version of a [ContentInfo](https://github.com/ibexa/core/blob/main/src/contracts/Repository/Values/Content/ContentInfo.php) object.
For example, the resource `/content/objects/52` with the `Accept: application/vnd.ibexa.api.ContentInfo+xml` header returns a serialized version of a [ContentInfo](../../php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-ContentInfo.html) object.

Check failure on line 165 in docs/api/rest_api/rest_api_usage/rest_responses.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/rest_api/rest_api_usage/rest_responses.md#L165

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/rest_api/rest_api_usage/rest_responses.md", "range": {"start": {"line": 165, "column": 205}}}, "severity": "ERROR"}

```shell
curl https://api.example.com/content/objects/52 --header 'Accept: application/vnd.ibexa.api.ContentInfo+xml';
Expand Down
Loading
Loading