IBX-4929: PHP API reference #1904

adriendupuis · 2023-02-23T08:50:31Z

Question	Answer
JIRA Ticket	IBX-4929
Versions	master, 4.6, ~~4.x, 3.3~~
Edition	Commerce (All)

Generate and serve a PHP API reference
Links to this PHP API reference instead of GitHub

TODO:

The whole generated reference has been updated and committed (see IBX-4929: PHP API reference: HTML output #1972).

Checklist

Text renders correctly
Text has been checked with vale
Description metadata is up to date
Redirects cover removed/moved pages
Code samples are working
PHP code samples have been fixed with PHP CS fixer
Added link to this PR in relevant JIRA ticket or code PR

The classes in the following directories do not seem useful for final customer - vendor/ibexa/fieldtype-query/spec - vendor/ibexa/graphql/spec - vendor/ibexa/http-cache/spec

…Struct() w/ link

It is done by ContentService::loadVersions(ContentInfo $contentInfo, int $status=null): VersionInfo[]

…ere)

WARNING - Documentation file 'api/php_api/php_api.md' contains a link to 'api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CompanyService.html' which is not found in the documentation files.

Avoid `mkdocs serve` to crash during removal with such error: `FileNotFoundError: [Errno 2] No such file or directory: 'docs/api/php_api/php_api_reference/files/vendor-ibexa-admin-ui-assets-src-bundle-ibexaadminuiassetsbundle.html'`

…ch for test purpose

# Conflicts: # docs/api/php_api/php_api.md

--------- Co-authored-by: Tomasz Dąbrowski <[email protected]>

dabrt

Please consider applying my suggested changes.

tools/php_api_ref/.phpdoc/template/index.html.twig

Co-authored-by: Tomasz Dąbrowski <[email protected]>

Only space changes. `git diff --ignore-all-space --ignore-blank-lines docs/api/php_api/php_api_reference` doesn't find any changes.

Cannot read properties of undefined (reading 'scrollIntoView')

--------- Co-authored-by: Adrien Dupuis <[email protected]> Co-authored-by: Michał Grabowski <[email protected]> Co-authored-by: Tomasz Dąbrowski <[email protected]> Co-authored-by: julitafalcondusza <[email protected]>

* Add a script to generate a PHP API reference * Generate PHP API reference's HTML * Add PHP API reference to the API chapter * Links to PHP API reference --------- Co-authored-by: Adrien Dupuis <[email protected]> Co-authored-by: Michał Grabowski <[email protected]> Co-authored-by: Tomasz Dąbrowski <[email protected]> Co-authored-by: julitafalcondusza <[email protected]> (cherry picked from commit 939daf1)

adriendupuis added 30 commits February 23, 2023 09:42

Add a script to generate a PHP API reference

5b2d57a

mkdocs.yml: Add PHP API reference to the API chapter

46cfd75

Stylize PhpDoc

dc1da24

Stylize PhpDoc

d833f70

Stylize PhpDoc

4b8538c

PhpDoc config

060038b

php_api.md: Links to PHP API Reference

645d1b8

phpdoc.dist.xml: (minor) Add link to doc

d954717

move paths from phpdoc.sh to phpdoc.dist.xml

05b8b4e

phpdoc.dist.xml: Also ignore spec/ directories

54683cf

The classes in the following directories do not seem useful for final customer - vendor/ibexa/fieldtype-query/spec - vendor/ibexa/graphql/spec - vendor/ibexa/http-cache/spec

php_api.md: update links to PHP API Reference

217cd2a

(minor) php_api.md: typo: mv a period out of a link

7f860a0

php_api.md: More links to the PHP API Reference instead of GitHub

31db536

php_api.md: getContentCreateStruct → ContentService::newContentCreate…

ccd63f2

…Struct() w/ link

php_api.md: PermissionService link

1cc420e

php_api.md: Content\Content can't retrieve previous versions

cef8a21

It is done by ContentService::loadVersions(ContentInfo $contentInfo, int $status=null): VersionInfo[]

php_api.md: getContentService is available on Repository (and only th…

5d67616

…ere)

php_api.md: typo

2c9d050

php_api.md: Complete Field Types as tagged services example

b061c44

php_api.md: Rm and recycle ezconf2018-api, reorder service access

03c6e78

php_api.md: Link to autowiring; Fix list

f7933b4

php_api.md: "auto-wiring" instead of "autowiring"

9dae0cb

php_api.md: Fix links to PHP API Ref

7a752e6

WARNING - Documentation file 'api/php_api/php_api.md' contains a link to 'api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CompanyService.html' which is not found in the documentation files.

phpdoc.sh: Add shebang and doc

23bacd9

phpdoc: Remove "indices/files" menu

d80ac57

phpdoc: Copy file path to clipboard

994ff28

phpdoc.sh: Remove file not existing in the currently generated doc

92e23be

custom.css.twig: Ease SVG disks color maintenance

bde7072

.phpdoc/template/: Fix or Add link to source template

748719a

GrabowskiM and others added 5 commits May 28, 2024 15:09

added vertical line to second level of menu

e0c54ef

phpdoc.sh: Add comment about how to have a package on a specific bran…

50029d8

…ch for test purpose

Merge branch 'master' into php_api_ref

af3ad4d

# Conflicts: # docs/api/php_api/php_api.md

Rework PHP API intro (#2386) (minor fix)

7a1296b

--------- Co-authored-by: Tomasz Dąbrowski <[email protected]>

Rework PHP API intro (#2386) (minor fix)

b2a3825

--------- Co-authored-by: Tomasz Dąbrowski <[email protected]>

dabrt reviewed May 29, 2024

View reviewed changes

tools/php_api_ref/.phpdoc/template/index.html.twig Outdated Show resolved Hide resolved

tools/php_api_ref/.phpdoc/template/index.html.twig Outdated Show resolved Hide resolved

adriendupuis and others added 19 commits May 29, 2024 09:21

Apply suggestions from code review

109e4cc

Co-authored-by: Tomasz Dąbrowski <[email protected]>

PHP API Ref's search_custom.js: fix placeholder

48cf8b5

Update tools/php_api_ref/README.md

4217c56

phpdoc.sh: Remove @dev from DXP_VERSION

b12407f

PHP API Ref: harmonize "Interfaces, classes, and traits" headers

34cfd54

phpdoc.sh: Get ready for next phpDocumentor version

d969d80

phpdoc.sh: phpDocumentor bin version 3.5.0

b34e995

phpdoc.sh: Update PHPDOC_TEMPLATE_VERSION to 3.5.0

58477cf

Only space changes. `git diff --ignore-all-space --ignore-blank-lines docs/api/php_api/php_api_reference` doesn't find any changes.

Clean up phpdoc.dist.xml

c92d7fd

Reorder phpdoc.sh variables

8c3d25a

PHP API Ref active-menu.js: scrollIntoView

bbd577f

Add interface documentation

2009256

phpdoc README.md: typo

ed9b57b

PHP API Ref active-menu.js: Avoid error on index

688a13f

Cannot read properties of undefined (reading 'scrollIntoView')

PHP API Ref's search_custom.js: fix placeholder (inc delay)

75b2662

PHP API Ref's "View on GitHub" more precise.

360a4aa

PHP API Ref's "View on GitHub" more precise.

0fde354

phpdoc README.md: enh. PHP_BINARY examples

842017b

IBX-4929: PHP API reference: HTML output (#1972)

2566dad

--------- Co-authored-by: Adrien Dupuis <[email protected]> Co-authored-by: Michał Grabowski <[email protected]> Co-authored-by: Tomasz Dąbrowski <[email protected]> Co-authored-by: julitafalcondusza <[email protected]>

adriendupuis marked this pull request as ready for review May 30, 2024 18:29

adriendupuis added the Ready for MERGE label May 30, 2024

adriendupuis merged commit 939daf1 into master May 31, 2024
2 of 3 checks passed

adriendupuis deleted the php_api_ref branch May 31, 2024 07:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IBX-4929: PHP API reference #1904

IBX-4929: PHP API reference #1904

adriendupuis commented Feb 23, 2023 •

edited

Loading

dabrt left a comment

IBX-4929: PHP API reference #1904

IBX-4929: PHP API reference #1904

Conversation

adriendupuis commented Feb 23, 2023 • edited Loading

Checklist

dabrt left a comment

Choose a reason for hiding this comment

adriendupuis commented Feb 23, 2023 •

edited

Loading