Skip to content

4.6 PHP API Ref + Collaboration #2913

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Sep 23, 2025
Merged

4.6 PHP API Ref + Collaboration #2913

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
12448bc
phpdoc.sh: + collaboration share fieldtype-richtext-rte
adriendupuis Sep 22, 2025
d8eb1c7
phpdoc.sh: + collaboration share
adriendupuis Sep 22, 2025
18c317d
update package-edition-map.twig
adriendupuis Sep 22, 2025
06b390f
phpdoc.sh: + fieldtype-richtext-rte
adriendupuis Sep 23, 2025
d0c3601
update package-edition-map.twig
adriendupuis Sep 23, 2025
1a2d892
4.6 PHP API Ref + Collaboration: HTML (#2914)
adriendupuis Sep 23, 2025
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
114 changes: 61 additions & 53 deletions tools/php_api_ref/.phpdoc/template/package-edition-map.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@
'ibexa/discounts': 'optional',
'ibexa/discounts-codes': 'optional',
'ibexa/product-catalog-symbol-attribute': 'optional',
'ibexa/collaboration': 'optional',
'ibexa/share': 'optional',
} %}
{% set namespace_package_map = {

Expand All @@ -86,25 +88,25 @@
'Ibexa\\Contracts\\DoctrineSchema': 'ibexa/doctrine-schema',
'Ibexa\\SystemInfo': 'ibexa/system-info',
'Ibexa\\Bundle\\SystemInfo': 'ibexa/system-info',
'EzSystems\zSupportTools': 'ibexa/system-info',
'EzSystems\\EzSupportTools': 'ibexa/system-info',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #2912 that should prevent \E character to come back.

'Ibexa\\Contracts\\SystemInfo': 'ibexa/system-info',
'EzSystems\zSupportToolsBundle': 'ibexa/system-info',
'EzSystems\\EzSupportToolsBundle': 'ibexa/system-info',
'Ibexa\\AdminUi': 'ibexa/admin-ui',
'Ibexa\\Bundle\\AdminUi': 'ibexa/admin-ui',
'Ibexa\\Platform\\Assets': 'ibexa/admin-ui',
'Ibexa\\Contracts\\AdminUi': 'ibexa/admin-ui',
'EzSystems\zPlatformAdminUi': 'ibexa/admin-ui',
'EzSystems\\EzPlatformAdminUi': 'ibexa/admin-ui',
'Ibexa\\Platform\\Bundle\\Assets': 'ibexa/admin-ui',
'EzSystems\zPlatformEncoreBundle': 'ibexa/admin-ui',
'EzSystems\zPlatformAdminUiBundle': 'ibexa/admin-ui',
'EzSystems\\EzPlatformEncoreBundle': 'ibexa/admin-ui',
'EzSystems\\EzPlatformAdminUiBundle': 'ibexa/admin-ui',
'Ibexa\\Bundle\\AdminUiAssets': 'ibexa/admin-ui-assets',
'EzSystems\zPlatformAdminUiAssetsBundle': 'ibexa/admin-ui-assets',
'EzSystems\\EzPlatformAdminUiAssetsBundle': 'ibexa/admin-ui-assets',
'Ibexa\\ContentForms': 'ibexa/content-forms',
'Ibexa\\Bundle\\ContentForms': 'ibexa/content-forms',
'Ibexa\\Contracts\\ContentForms': 'ibexa/content-forms',
'EzSystems\zPlatformContentForms': 'ibexa/content-forms',
'EzSystems\zPlatformContentFormsBundle': 'ibexa/content-forms',
'EzSystems\zPlatformContentForms\\Features': 'ibexa/content-forms',
'EzSystems\\EzPlatformContentForms': 'ibexa/content-forms',
'EzSystems\\EzPlatformContentFormsBundle': 'ibexa/content-forms',
'EzSystems\\EzPlatformContentForms\\Features': 'ibexa/content-forms',
'Ibexa\\Core': 'ibexa/core',
'eZ\\Publish\\API': 'ibexa/core',
'eZ\\Publish\\SPI': 'ibexa/core',
Expand All @@ -116,17 +118,17 @@
'Ibexa\\Contracts\\Core': 'ibexa/core',
'eZ\\Publish\\SPI\\Tests': 'ibexa/core',
'Ibexa\\Tests\\Bundle\\Core': 'ibexa/core',
'eZ\\Bundle\zPublishIOBundle': 'ibexa/core',
'eZ\\Bundle\\EzPublishIOBundle': 'ibexa/core',
'Ibexa\\Tests\\Integration\\Core': 'ibexa/core',
'eZ\\Bundle\zPublishCoreBundle': 'ibexa/core',
'eZ\\Bundle\zPublishDebugBundle': 'ibexa/core',
'eZ\\Bundle\\EzPublishCoreBundle': 'ibexa/core',
'eZ\\Bundle\\EzPublishDebugBundle': 'ibexa/core',
'Ibexa\\Bundle\\LegacySearchEngine': 'ibexa/core',
'eZ\\Publish\\API\\Repository\\Tests': 'ibexa/core',
'Ibexa\\Bundle\\RepositoryInstaller': 'ibexa/core',
'EzSystems\\PlatformInstallerBundle': 'ibexa/core',
'eZ\\Bundle\zPublishCoreBundle\\Tests': 'ibexa/core',
'eZ\\Bundle\\EzPublishCoreBundle\\Tests': 'ibexa/core',
'eZ\\Publish\\Core\\Persistence\\Legacy\\Tests': 'ibexa/core',
'eZ\\Bundle\zPublishLegacySearchEngineBundle': 'ibexa/core',
'eZ\\Bundle\\EzPublishLegacySearchEngineBundle': 'ibexa/core',
'eZ\\Publish\\Core\\MVC\\Symfony\\Templating\\Tests': 'ibexa/core',
'Ibexa\\CorePersistence': 'ibexa/core-persistence',
'Ibexa\\Bundle\\CorePersistence': 'ibexa/core-persistence',
Expand All @@ -137,30 +139,30 @@
'Ibexa\\Cron': 'ibexa/cron',
'Ibexa\\Bundle\\Cron': 'ibexa/cron',
'Ibexa\\Contracts\\Cron': 'ibexa/cron',
'EzSystems\zPlatformCronBundle': 'ibexa/cron',
'EzSystems\\EzPlatformCronBundle': 'ibexa/cron',
'Ibexa\\DesignEngine': 'ibexa/design-engine',
'Ibexa\\Bundle\\DesignEngine': 'ibexa/design-engine',
'Ibexa\\Contracts\\DesignEngine': 'ibexa/design-engine',
'EzSystems\zPlatformDesignEngine': 'ibexa/design-engine',
'EzSystems\zPlatformDesignEngineBundle': 'ibexa/design-engine',
'EzSystems\\EzPlatformDesignEngine': 'ibexa/design-engine',
'EzSystems\\EzPlatformDesignEngineBundle': 'ibexa/design-engine',
'Ibexa\\FieldTypeMatrix': 'ibexa/fieldtype-matrix',
'Ibexa\\Bundle\\FieldTypeMatrix': 'ibexa/fieldtype-matrix',
'EzSystems\zPlatformMatrixFieldtype': 'ibexa/fieldtype-matrix',
'EzSystems\zPlatformMatrixFieldtypeBundle': 'ibexa/fieldtype-matrix',
'EzSystems\\EzPlatformMatrixFieldtype': 'ibexa/fieldtype-matrix',
'EzSystems\\EzPlatformMatrixFieldtypeBundle': 'ibexa/fieldtype-matrix',
'Ibexa\\FieldTypeQuery': 'ibexa/fieldtype-query',
'Ibexa\\Bundle\\FieldTypeQuery': 'ibexa/fieldtype-query',
'Ibexa\\Contracts\\FieldTypeQuery': 'ibexa/fieldtype-query',
'EzSystems\zPlatformQueryFieldType': 'ibexa/fieldtype-query',
'EzSystems\\EzPlatformQueryFieldType': 'ibexa/fieldtype-query',
'Ibexa\\FieldTypeRichText': 'ibexa/fieldtype-richtext',
'EzSystems\zPlatformRichText': 'ibexa/fieldtype-richtext',
'EzSystems\\EzPlatformRichText': 'ibexa/fieldtype-richtext',
'Ibexa\\Tests\\FieldTypeRichText': 'ibexa/fieldtype-richtext',
'Ibexa\\Bundle\\FieldTypeRichText': 'ibexa/fieldtype-richtext',
'Ibexa\\Contracts\\FieldTypeRichText': 'ibexa/fieldtype-richtext',
'EzSystems\zPlatformRichTextBundle': 'ibexa/fieldtype-richtext',
'EzSystems\\EzPlatformRichTextBundle': 'ibexa/fieldtype-richtext',
'Ibexa\\GraphQL': 'ibexa/graphql',
'Ibexa\\Bundle\\GraphQL': 'ibexa/graphql',
'Ibexa\\Contracts\\GraphQL': 'ibexa/graphql',
'EzSystems\zPlatformGraphQL': 'ibexa/graphql',
'EzSystems\\EzPlatformGraphQL': 'ibexa/graphql',
'Ibexa\\HttpCache': 'ibexa/http-cache',
'Ibexa\\Bundle\\HttpCache': 'ibexa/http-cache',
'Ibexa\\Contracts\\HttpCache': 'ibexa/http-cache',
Expand All @@ -174,8 +176,8 @@
'Ibexa\\Rest': 'ibexa/rest',
'Ibexa\\Bundle\\Rest': 'ibexa/rest',
'Ibexa\\Contracts\\Rest': 'ibexa/rest',
'EzSystems\zPlatformRest': 'ibexa/rest',
'EzSystems\zPlatformRestBundle': 'ibexa/rest',
'EzSystems\\EzPlatformRest': 'ibexa/rest',
'EzSystems\\EzPlatformRestBundle': 'ibexa/rest',
'Ibexa\\Search': 'ibexa/search',
'Ibexa\\Bundle\\Search': 'ibexa/search',
'Ibexa\\Platform\\Search': 'ibexa/search',
Expand All @@ -185,21 +187,21 @@
'Ibexa\\Bundle\\Solr': 'ibexa/solr',
'Ibexa\\Contracts\\Solr': 'ibexa/solr',
'Ibexa\\Tests\\Solr\\SetupFactory': 'ibexa/solr',
'EzSystems\zPlatformSolrSearchEngine': 'ibexa/solr',
'EzSystems\zPlatformSolrSearchEngineBundle': 'ibexa/solr',
'EzSystems\zPlatformSolrSearchEngine\\Tests\\SetupFactory': 'ibexa/solr',
'EzSystems\\EzPlatformSolrSearchEngine': 'ibexa/solr',
'EzSystems\\EzPlatformSolrSearchEngineBundle': 'ibexa/solr',
'EzSystems\\EzPlatformSolrSearchEngine\\Tests\\SetupFactory': 'ibexa/solr',
'Ibexa\\StandardDesign': 'ibexa/standard-design',
'Ibexa\\Bundle\\StandardDesign': 'ibexa/standard-design',
'Ibexa\\Contracts\\StandardDesign': 'ibexa/standard-design',
'EzSystems\zPlatformStandardDesignBundle': 'ibexa/standard-design',
'EzSystems\\EzPlatformStandardDesignBundle': 'ibexa/standard-design',
'Ibexa\\TwigComponents': 'ibexa/twig-components',
'Ibexa\\Bundle\\TwigComponents': 'ibexa/twig-components',
'Ibexa\\Contracts\\TwigComponents': 'ibexa/twig-components',
'Ibexa\\User': 'ibexa/user',
'Ibexa\\Bundle\\User': 'ibexa/user',
'Ibexa\\Contracts\\User': 'ibexa/user',
'EzSystems\zPlatformUser': 'ibexa/user',
'EzSystems\zPlatformUserBundle': 'ibexa/user',
'EzSystems\\EzPlatformUser': 'ibexa/user',
'EzSystems\\EzPlatformUserBundle': 'ibexa/user',

'Ibexa\\Bundle\\Connect': 'ibexa/connect',
'Ibexa\\Contracts\\Connect': 'ibexa/connect',
Expand Down Expand Up @@ -241,8 +243,8 @@
'Ibexa\\Scheduler': 'ibexa/scheduler',
'Ibexa\\Bundle\\Scheduler': 'ibexa/scheduler',
'Ibexa\\Contracts\\Scheduler': 'ibexa/scheduler',
'EzSystems\zPlatformCalendarBundle': 'ibexa/calendar',
'EzSystems\zPlatformCalendar': 'ibexa/calendar',
'EzSystems\\EzPlatformCalendarBundle': 'ibexa/calendar',
'EzSystems\\EzPlatformCalendar': 'ibexa/calendar',
'Ibexa\\Calendar': 'ibexa/calendar',
'Ibexa\\Bundle\\Calendar': 'ibexa/calendar',
'Ibexa\\Contracts\\Calendar': 'ibexa/calendar',
Expand All @@ -252,12 +254,12 @@
'Ibexa\\Platform\\Bundle\\Connector\\Dam': 'ibexa/connector-dam',
'Ibexa\\Platform\\Contracts\\Connector\\Dam': 'ibexa/connector-dam',
'Ibexa\\Platform\\Connector\\Dam': 'ibexa/connector-dam',
'Ibexa\lasticsearch': 'ibexa/elasticsearch',
'Ibexa\\Bundle\lasticsearch': 'ibexa/elasticsearch',
'Ibexa\\Contracts\lasticsearch': 'ibexa/elasticsearch',
'Ibexa\\Platform\\Bundle\lasticSearchEngine': 'ibexa/elasticsearch',
'Ibexa\\Platform\\Contracts\lasticSearchEngine': 'ibexa/elasticsearch',
'Ibexa\\Platform\lasticSearchEngine': 'ibexa/elasticsearch',
'Ibexa\\Elasticsearch': 'ibexa/elasticsearch',
'Ibexa\\Bundle\\Elasticsearch': 'ibexa/elasticsearch',
'Ibexa\\Contracts\\Elasticsearch': 'ibexa/elasticsearch',
'Ibexa\\Platform\\Bundle\\ElasticSearchEngine': 'ibexa/elasticsearch',
'Ibexa\\Platform\\Contracts\\ElasticSearchEngine': 'ibexa/elasticsearch',
'Ibexa\\Platform\\ElasticSearchEngine': 'ibexa/elasticsearch',
'Ibexa\\Fastly': 'ibexa/fastly',
'Ibexa\\Bundle\\Fastly': 'ibexa/fastly',
'Ibexa\\Contracts\\Fastly': 'ibexa/fastly',
Expand All @@ -274,13 +276,13 @@
'Ibexa\\VersionComparison': 'ibexa/version-comparison',
'Ibexa\\Bundle\\VersionComparison': 'ibexa/version-comparison',
'Ibexa\\Contracts\\VersionComparison': 'ibexa/version-comparison',
'EzSystems\zPlatformVersionComparisonBundle': 'ibexa/version-comparison',
'EzSystems\zPlatformVersionComparison': 'ibexa/version-comparison',
'EzSystems\\EzPlatformVersionComparisonBundle': 'ibexa/version-comparison',
'EzSystems\\EzPlatformVersionComparison': 'ibexa/version-comparison',
'Ibexa\\Workflow': 'ibexa/workflow',
'Ibexa\\Bundle\\Workflow': 'ibexa/workflow',
'Ibexa\\Contracts\\Workflow': 'ibexa/workflow',
'EzSystems\zPlatformWorkflow': 'ibexa/workflow',
'EzSystems\zPlatformWorkflowBundle': 'ibexa/workflow',
'EzSystems\\EzPlatformWorkflow': 'ibexa/workflow',
'EzSystems\\EzPlatformWorkflowBundle': 'ibexa/workflow',
'Ibexa\\Bundle\\Taxonomy': 'ibexa/taxonomy',
'Ibexa\\Contracts\\Taxonomy': 'ibexa/taxonomy',
'Ibexa\\Taxonomy': 'ibexa/taxonomy',
Expand All @@ -305,24 +307,24 @@
'Ibexa\\Bundle\\ActivityLog': 'ibexa/activity-log',
'Ibexa\\Contracts\\ActivityLog': 'ibexa/activity-log',
'Ibexa\\ActivityLog': 'ibexa/activity-log',
'EzSystems\zPlatformFormBuilderBundle': 'ibexa/form-builder',
'EzSystems\zPlatformFormBuilder': 'ibexa/form-builder',
'EzSystems\\EzPlatformFormBuilderBundle': 'ibexa/form-builder',
'EzSystems\\EzPlatformFormBuilder': 'ibexa/form-builder',
'Ibexa\\FormBuilder': 'ibexa/form-builder',
'Ibexa\\Bundle\\FormBuilder': 'ibexa/form-builder',
'Ibexa\\Contracts\\FormBuilder': 'ibexa/form-builder',
'Ibexa\\PageBuilder': 'ibexa/page-builder',
'Ibexa\\Bundle\\PageBuilder': 'ibexa/page-builder',
'Ibexa\\Contracts\\PageBuilder': 'ibexa/page-builder',
'EzSystems\zPlatformPageBuilderBundle': 'ibexa/page-builder',
'EzSystems\zPlatformPageBuilder': 'ibexa/page-builder',
'EzSystems\\EzPlatformPageBuilderBundle': 'ibexa/page-builder',
'EzSystems\\EzPlatformPageBuilder': 'ibexa/page-builder',
'Ibexa\\FieldTypeAddress': 'ibexa/fieldtype-address',
'Ibexa\\Bundle\\FieldTypeAddress': 'ibexa/fieldtype-address',
'Ibexa\\Contracts\\FieldTypeAddress': 'ibexa/fieldtype-address',
'Ibexa\\FieldTypePage': 'ibexa/fieldtype-page',
'Ibexa\\Bundle\\FieldTypePage': 'ibexa/fieldtype-page',
'Ibexa\\Contracts\\FieldTypePage': 'ibexa/fieldtype-page',
'EzSystems\zPlatformPageFieldType': 'ibexa/fieldtype-page',
'EzSystems\zPlatformPageFieldTypeBundle': 'ibexa/fieldtype-page',
'EzSystems\\EzPlatformPageFieldType': 'ibexa/fieldtype-page',
'EzSystems\\EzPlatformPageFieldTypeBundle': 'ibexa/fieldtype-page',
'Ibexa\\Bundle\\Dashboard': 'ibexa/dashboard',
'Ibexa\\Contracts\\Dashboard': 'ibexa/dashboard',
'Ibexa\\Dashboard': 'ibexa/dashboard',
Expand All @@ -338,8 +340,8 @@
'Ibexa\\Platform\\Segmentation': 'ibexa/segmentation',
'Ibexa\\Platform\\Bundle\\Segmentation': 'ibexa/segmentation',
'Ibexa\\Platform\\Contracts\\Segmentation': 'ibexa/segmentation',
'EzSystems\zPlatformSiteFactoryBundle': 'ibexa/site-factory',
'EzSystems\zPlatformSiteFactory': 'ibexa/site-factory',
'EzSystems\\EzPlatformSiteFactoryBundle': 'ibexa/site-factory',
'EzSystems\\EzPlatformSiteFactory': 'ibexa/site-factory',
'Ibexa\\SiteFactory': 'ibexa/site-factory',
'Ibexa\\Bundle\\SiteFactory': 'ibexa/site-factory',
'Ibexa\\Contracts\\SiteFactory': 'ibexa/site-factory',
Expand Down Expand Up @@ -380,8 +382,8 @@
'Ibexa\\AutomatedTranslation': 'ibexa/automated-translation',
'Ibexa\\Bundle\\AutomatedTranslation': 'ibexa/automated-translation',
'Ibexa\\Contracts\\AutomatedTranslation': 'ibexa/automated-translation',
'EzSystems\zPlatformAutomatedTranslation': 'ibexa/automated-translation',
'EzSystems\zPlatformAutomatedTranslationBundle': 'ibexa/automated-translation',
'EzSystems\\EzPlatformAutomatedTranslation': 'ibexa/automated-translation',
'EzSystems\\EzPlatformAutomatedTranslationBundle': 'ibexa/automated-translation',
'Ibexa\\Bundle\\ProductCatalogDateTimeAttribute': 'ibexa/product-catalog-date-time-attribute',
'Ibexa\\Contracts\\ProductCatalogDateTimeAttribute': 'ibexa/product-catalog-date-time-attribute',
'Ibexa\\ProductCatalogDateTimeAttribute': 'ibexa/product-catalog-date-time-attribute',
Expand All @@ -396,5 +398,11 @@
'Ibexa\\Bundle\\ProductCatalogSymbolAttribute': 'ibexa/product-catalog-symbol-attribute',
'Ibexa\\Contracts\\ProductCatalogSymbolAttribute': 'ibexa/product-catalog-symbol-attribute',
'Ibexa\\ProductCatalogSymbolAttribute': 'ibexa/product-catalog-symbol-attribute',
'Ibexa\\Bundle\\Collaboration': 'ibexa/collaboration',
'Ibexa\\Contracts\\Collaboration': 'ibexa/collaboration',
'Ibexa\\Collaboration': 'ibexa/collaboration',
'Ibexa\\Bundle\\Share': 'ibexa/share',
'Ibexa\\Contracts\\Share': 'ibexa/share',
'Ibexa\\Share': 'ibexa/share',
} %}
{% block content %}{% endblock %}
2 changes: 1 addition & 1 deletion tools/php_api_ref/phpdoc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ OUTPUT_DIR=${2:-./docs/api/php_api/php_api_reference}; # Path to the directory w

DXP_EDITION='commerce'; # Edition from and for which the Reference is built
DXP_VERSION='4.6.*'; # Version from and for which the Reference is built
DXP_ADD_ONS=(connector-ai connector-openai automated-translation product-catalog-date-time-attribute rector discounts discounts-codes product-catalog-symbol-attribute); # Packages not included in $DXP_EDITION but added to the Reference, listed without their vendor "ibexa"
DXP_ADD_ONS=(connector-ai connector-openai automated-translation product-catalog-date-time-attribute rector discounts discounts-codes product-catalog-symbol-attribute collaboration share); # Packages not included in $DXP_EDITION but added to the Reference, listed without their vendor "ibexa"
DXP_EDITIONS=(oss headless experience commerce); # Available editions ordered by ascending capabilities
SF_VERSION='5.4'; # Symfony version used by Ibexa DXP
PHPDOC_VERSION='3.8.0'; # Version of phpDocumentor used to build the Reference
Expand Down
Loading