diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index 5ee8ee3d63..9bb72b7b99 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -39,6 +39,8 @@ config: blanks-around-lists: true no-trailing-punctuation: punctuation: [".", ":", ";",] + no-emphasis-as-heading: true + table-column-count: true ignores: - "docs/snippets/**" diff --git a/docs/administration/admin_panel/roles_admin_panel.md b/docs/administration/admin_panel/roles_admin_panel.md index ba27d7ee2e..5950744000 100644 --- a/docs/administration/admin_panel/roles_admin_panel.md +++ b/docs/administration/admin_panel/roles_admin_panel.md @@ -10,7 +10,7 @@ To give users an access to your website you need to assign them roles in the **A Each role consists of: -**Policies** +## Policies ![Policies](admin_panel_policies.png "Policies") @@ -27,7 +27,7 @@ See [example use case](permission_use_cases.md#restrict-editing-to-part-of-the-t For more information, see [Limitation reference](limitation_reference.md). -**Assignments** +## Assignments ![Assignments](admin_panel_assignments.png "Assignments") diff --git a/docs/administration/back_office/back_office_elements/add_dropdowns.md b/docs/administration/back_office/back_office_elements/add_dropdowns.md index 811f3fd3b7..68e3beed7e 100644 --- a/docs/administration/back_office/back_office_elements/add_dropdowns.md +++ b/docs/administration/back_office/back_office_elements/add_dropdowns.md @@ -106,15 +106,15 @@ The following attributes are available: |Name|Values|Definition| |---|------|----------| -|`source`| - |What is currently defined in the `` input header.| +|`choices`| |Elements listed in the drop-down.| +|`preferred_choices`| | Elements listed at the top of the list with a separator.| |`value`|-|The currently selected element. It is an object with a key `value`. | |`multiple`| true
false|Boolean. To allow users to select multiple items.| |`translation_domain`|true
false|Used for translating choices and placeholder.| |`custom_form`|true
false|For custom form must be set to true.| -|`class`| - |Additional classes for the element with `ibexa-dropdown` class.| -|`placeholder`|Placeholder displayed when no option is selected.| +|`class`| |Additional classes for the element with `ibexa-dropdown` class.| +|`placeholder`| | Placeholder displayed when no option is selected.| |`custom_init`|true
false|By default set to `false`. If set to `true`, requires manually initializing drop-down in JavaScript.| |`is_disabled`|true
false|Disables drop-down.| |`is_hidden`|true
false|Hides the whole widget.| diff --git a/docs/administration/back_office/back_office_elements/reusable_components.md b/docs/administration/back_office/back_office_elements/reusable_components.md index b289cf1b39..826bf6c71b 100644 --- a/docs/administration/back_office/back_office_elements/reusable_components.md +++ b/docs/administration/back_office/back_office_elements/reusable_components.md @@ -54,7 +54,7 @@ Variables: |Name|Type|Values| |----|----|-----------| |`headline` (optional)|string|if not specified, the header isn't rendered| -|`headline_items`|array| +|`headline_items`|array| | |`view_mode`|string|`vertical`, default set to `''`| |`items`|hash|{`label`, `content_raw`, `content`}| diff --git a/docs/api/event_reference/content_events.md b/docs/api/event_reference/content_events.md index 4d9f7f6b09..7eb8db3f2b 100644 --- a/docs/api/event_reference/content_events.md +++ b/docs/api/event_reference/content_events.md @@ -7,19 +7,19 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateContentDraftEvent`|`ContentService::createContentDraft`|`ContentInfo $contentInfo`
`VersionInfo $versionInfo`
`User $creator`
`Language|null $language`
`Content|null $contentDraft`| -|`CreateContentDraftEvent`|`ContentService::createContentDraft`|`Content $contentDraft`
`ContentInfo $contentInfo`
`VersionInfo $versionInfo`
`User $creator`
`Language|null $language`| -|`BeforeCreateContentEvent`|`ContentService::createContent`|`ContentCreateStruct $contentCreateStruct`
`array $locationCreateStructs`
`Content|null $content`
`string[]|null $fieldIdentifiersToValidate`| -|`CreateContentEvent`|`ContentService::createContent`|`ContentCreateStruct $contentCreateStruct`
`array $locationCreateStructs`
`Content $content`
`string[]|null $fieldIdentifiersToValidate`| -|`BeforeUpdateContentEvent`|`ContentService::updateContent`|`VersionInfo $versionInfo`
`ContentUpdateStruct $contentUpdateStruct`
`Content|null $content`
`string[]|null $fieldIdentifiersToValidate`| -|`UpdateContentEvent`|`ContentService::updateContent`|`Content $content`
`VersionInfo $versionInfo`
`ContentUpdateStruct $contentUpdateStruct`
`string[]|null $fieldIdentifiersToValidate`| -|`BeforeUpdateContentMetadataEvent`|`ContentService::updateContentMetadata`|`ContentInfo $contentInfo`
`ContentMetadataUpdateStruct $contentMetadataUpdateStruct`
`Content|null $content`| +|`BeforeCreateContentDraftEvent`|`ContentService::createContentDraft`|`ContentInfo $contentInfo`
`VersionInfo $versionInfo`
`User $creator`
`?Language $language`
`?Content $contentDraft`| +|`CreateContentDraftEvent`|`ContentService::createContentDraft`|`Content $contentDraft`
`ContentInfo $contentInfo`
`VersionInfo $versionInfo`
`User $creator`
`?Language $language`| +|`BeforeCreateContentEvent`|`ContentService::createContent`|`ContentCreateStruct $contentCreateStruct`
`array $locationCreateStructs`
`?Content $content`
`string[] or null $fieldIdentifiersToValidate`| +|`CreateContentEvent`|`ContentService::createContent`|`ContentCreateStruct $contentCreateStruct`
`array $locationCreateStructs`
`Content $content`
`string[] or null $fieldIdentifiersToValidate`| +|`BeforeUpdateContentEvent`|`ContentService::updateContent`|`VersionInfo $versionInfo`
`ContentUpdateStruct $contentUpdateStruct`
`?Content $content`
`string[] or null $fieldIdentifiersToValidate`| +|`UpdateContentEvent`|`ContentService::updateContent`|`Content $content`
`VersionInfo $versionInfo`
`ContentUpdateStruct $contentUpdateStruct`
`string[] or null $fieldIdentifiersToValidate`| +|`BeforeUpdateContentMetadataEvent`|`ContentService::updateContentMetadata`|`ContentInfo $contentInfo`
`ContentMetadataUpdateStruct $contentMetadataUpdateStruct`
`?Content $content`| |`UpdateContentMetadataEvent`|`ContentService::updateContentMetadata`|`Content $content`
`ContentInfo $contentInfo`
`ContentMetadataUpdateStruct $contentMetadataUpdateStruct`| -|`BeforeCopyContentEvent`|`ContentService::copyContent`|`ContentInfo $contentInfo`
`LocationCreateStruct $destinationLocationCreateStruct`
`VersionInfo $versionInfo`
`Content|null $content`| +|`BeforeCopyContentEvent`|`ContentService::copyContent`|`ContentInfo $contentInfo`
`LocationCreateStruct $destinationLocationCreateStruct`
`VersionInfo $versionInfo`
`?Content $content`| |`CopyContentEvent`|`ContentService::copyContent`|`Content $content`
`ContentInfo $contentInfo`
`LocationCreateStruct $destinationLocationCreateStruct`
`VersionInfo $versionInfo`| -|`BeforePublishVersionEvent`|`ContentService::publishVersion`|`VersionInfo $versionInfo`
`Content|null $content`
`string[] $translations`| +|`BeforePublishVersionEvent`|`ContentService::publishVersion`|`VersionInfo $versionInfo`
`?Content $content`
`string[] $translations`| |`PublishVersionEvent`|`ContentService::publishVersion`|`Content $content`
`VersionInfo $versionInfo`
`string[] $translations`| -|`BeforeDeleteContentEvent`|`ContentService::deleteContent`|`ContentInfo $contentInfo`
`array|null $locations`| +|`BeforeDeleteContentEvent`|`ContentService::deleteContent`|`ContentInfo $contentInfo`
`array or null $locations`| |`DeleteContentEvent`|`ContentService::deleteContent`|`array $locations`
`ContentInfo $contentInfo`| |`BeforeDeleteVersionEvent`|`ContentService::deleteVersion`|`VersionInfo $versionInfo`| |`DeleteVersionEvent`|`ContentService::deleteVersion`|`VersionInfo $versionInfo`| @@ -28,7 +28,7 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeAddRelationEvent`|`ContentService::addRelation`|`VersionInfo $sourceVersion`
`ContentInfo $destinationContent`
`Relation|null $relation`| +|`BeforeAddRelationEvent`|`ContentService::addRelation`|`VersionInfo $sourceVersion`
`ContentInfo $destinationContent`
`?Relation $relation`| |`AddRelationEvent`|`ContentService::addRelation`|`Relation $relation`
`VersionInfo $sourceVersion`
`ContentInfo $destinationContent`| |`BeforeDeleteRelationEvent`|`ContentService::deleteRelation`|`VersionInfo $sourceVersion`
`ContentInfo $destinationContent`| |`DeleteRelationEvent`|`ContentService::deleteRelation`|`VersionInfo $sourceVersion`
`ContentInfo $destinationContent`| diff --git a/docs/api/event_reference/content_type_events.md b/docs/api/event_reference/content_type_events.md index ac62cdb89c..8c64392ae1 100644 --- a/docs/api/event_reference/content_type_events.md +++ b/docs/api/event_reference/content_type_events.md @@ -7,13 +7,13 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateContentTypeDraftEvent`|`ContentTypeService::createContentTypeDraft`|`ContentType $contentType`
`ContentTypeDraft|null $contentTypeDraft`| +|`BeforeCreateContentTypeDraftEvent`|`ContentTypeService::createContentTypeDraft`|`ContentType $contentType`
`?ContentTypeDraft $contentTypeDraft`| |`CreateContentTypeDraftEvent`|`ContentTypeService::createContentTypeDraft`|`ContentTypeDraft $contentTypeDraft`
`ContentType $contentType`| -|`BeforeCreateContentTypeEvent`|`ContentTypeService::createContentType`|`ContentTypeCreateStruct $contentTypeCreateStruct`
`array $contentTypeGroups`
`ContentTypeDraft|null $contentTypeDraft`| +|`BeforeCreateContentTypeEvent`|`ContentTypeService::createContentType`|`ContentTypeCreateStruct $contentTypeCreateStruct`
`array $contentTypeGroups`
`?ContentTypeDraft $contentTypeDraft`| |`CreateContentTypeEvent`|`ContentTypeService::createContentType`|`ContentTypeDraft $contentTypeDraft`
`ContentTypeCreateStruct $contentTypeCreateStruct`
`array $contentTypeGroups`| |`BeforeUpdateContentTypeDraftEvent`|`ContentTypeService::updateContentTypeDraft`|`ContentTypeDraft $contentTypeDraft`
`ContentTypeUpdateStruct $contentTypeUpdateStruct`| |`UpdateContentTypeDraftEvent`|`ContentTypeService::updateContentTypeDraft`|`ContentTypeDraft $contentTypeDraft`
`ContentTypeUpdateStruct $contentTypeUpdateStruct`| -|`BeforeCopyContentTypeEvent`|`ContentTypeService::copyContentType`|`ContentType $contentType`
`User $creator`
`ContentType|null $contentTypeCopy`| +|`BeforeCopyContentTypeEvent`|`ContentTypeService::copyContentType`|`ContentType $contentType`
`User $creator`
`?ContentType $contentTypeCopy`| |`CopyContentTypeEvent`|`ContentTypeService::copyContentType`|`ContentType $contentTypeCopy`
`ContentType $contentType`
`User $creator`| |`BeforePublishContentTypeDraftEvent`|`ContentTypeService::publishContentTypeDraft`|`ContentTypeDraft $contentTypeDraft`| |`PublishContentTypeDraftEvent`|`ContentTypeService::publishContentTypeDraft`|`ContentTypeDraft $contentTypeDraft`| @@ -24,7 +24,7 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateContentTypeGroupEvent`|`ContentTypeService::createContentTypeGroup`|`ContentTypeCreateStruct $contentTypeCreateStruct`
`array $contentTypeGroups`
`ContentTypeDraft|null $contentTypeDraft`| +|`BeforeCreateContentTypeGroupEvent`|`ContentTypeService::createContentTypeGroup`|`ContentTypeCreateStruct $contentTypeCreateStruct`
`array $contentTypeGroups`
`?ContentTypeDraft $contentTypeDraft`| |`CreateContentTypeGroupEvent`|`ContentTypeService::createContentTypeGroup`|`ContentTypeGroup $contentTypeGroup`
`ContentTypeGroupCreateStruct $contentTypeGroupCreateStruct`| |`BeforeUpdateContentTypeGroupEvent`|`ContentTypeService::updateContentTypeGroup`|`ContentTypeGroup $contentTypeGroup`
`ContentTypeGroupUpdateStruct $contentTypeGroupUpdateStruct`| |`UpdateContentTypeGroupEvent`|`ContentTypeService::updateContentTypeGroup`|`ContentTypeGroup $contentTypeGroup`
`ContentTypeGroupUpdateStruct $contentTypeGroupUpdateStruct`| @@ -35,7 +35,7 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeRemoveContentTypeTranslationEvent`|`ContentTypeService::removeContentTypeTranslation`|`ContentTypeDraft $contentTypeDraft`
`string $languageCode`
`ContentTypeDraft|null $newContentTypeDraft`| +|`BeforeRemoveContentTypeTranslationEvent`|`ContentTypeService::removeContentTypeTranslation`|`ContentTypeDraft $contentTypeDraft`
`string $languageCode`
`?ContentTypeDraft $newContentTypeDraft`| |`RemoveContentTypeTranslationEvent`|`ContentTypeService::removeContentTypeTranslation`|`ContentTypeDraft $newContentTypeDraft`
`ContentTypeDraft $contentTypeDraft`
`string $languageCode`| ## Field definitions diff --git a/docs/api/event_reference/language_events.md b/docs/api/event_reference/language_events.md index f2d323b603..5f3c378d07 100644 --- a/docs/api/event_reference/language_events.md +++ b/docs/api/event_reference/language_events.md @@ -7,9 +7,9 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateLanguageEvent`|`LanguageService::createLanguage`|`LanguageCreateStruct $languageCreateStruct`
`Language|null $language`| +|`BeforeCreateLanguageEvent`|`LanguageService::createLanguage`|`LanguageCreateStruct $languageCreateStruct`
`?Language $language`| |`CreateLanguageEvent`|`LanguageService::createLanguage`|`Language $language`
`LanguageCreateStruct $languageCreateStruct`| -|`BeforeUpdateLanguageNameEvent`|`LanguageService::updateLanguageName`|`Language $language`
`string $newName`
`Language|null $updatedLanguage`| +|`BeforeUpdateLanguageNameEvent`|`LanguageService::updateLanguageName`|`Language $language`
`string $newName`
`?Language $updatedLanguage`| |`UpdateLanguageNameEvent`|`LanguageService::updateLanguageName`|`Language $updatedLanguage`
`Language $language`
`string $newName`| |`BeforeDeleteLanguageEvent`|`LanguageService::deleteLanguage`|`Language $language`| |`DeleteLanguageEvent`|`LanguageService::deleteLanguage`|`Language $language`| @@ -18,7 +18,7 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeEnableLanguageEvent`|`LanguageService::enableLanguage`|`Language $language`
`Language|null $enabledLanguage`| +|`BeforeEnableLanguageEvent`|`LanguageService::enableLanguage`|`Language $language`
`?Language $enabledLanguage`| |`EnableLanguageEvent`|`LanguageService::enableLanguage`|`Language $enabledLanguage`
`Language $language`| -|`BeforeDisableLanguageEvent`|`LanguageService::disableLanguage`|`Language $language`
`Language|null $disabledLanguage`| +|`BeforeDisableLanguageEvent`|`LanguageService::disableLanguage`|`Language $language`
`?Language $disabledLanguage`| |`DisableLanguageEvent`|`LanguageService::disableLanguage`|`Language $disabledLanguage`
`Language $language`| diff --git a/docs/api/event_reference/location_events.md b/docs/api/event_reference/location_events.md index 3d84c98906..ecc463cc89 100644 --- a/docs/api/event_reference/location_events.md +++ b/docs/api/event_reference/location_events.md @@ -7,9 +7,9 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateLocationEvent`|`LocationService::createLocation`|`ContentInfo $contentInfo`
`LocationCreateStruct $locationCreateStruct`
`Location|null $location`| +|`BeforeCreateLocationEvent`|`LocationService::createLocation`|`ContentInfo $contentInfo`
`LocationCreateStruct $locationCreateStruct`
`?Location $location`| |`CreateLocationEvent`|`LocationService::createLocation`|`Location $location`
`ContentInfo $contentInfo`
`LocationCreateStruct $locationCreateStruct`| -|`BeforeUpdateLocationEvent`|`LocationService::updateLocation`|`Location $location`
`LocationUpdateStruct $locationUpdateStruct`
`Location|null $updatedLocation`| +|`BeforeUpdateLocationEvent`|`LocationService::updateLocation`|`Location $location`
`LocationUpdateStruct $locationUpdateStruct`
`?Location $updatedLocation`| |`UpdateLocationEvent`|`LocationService::updateLocation`|`Location $updatedLocation`
`Location $location`
`LocationUpdateStruct $locationUpdateStruct`| |`BeforeDeleteLocationEvent`|`LocationService::deleteLocation`|`Location $location`| |`DeleteLocationEvent`|`LocationService::deleteLocation`|`Location $location`| @@ -18,16 +18,16 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeHideLocationEvent`|`LocationService::hideLocation`|`Location $location`
`Location|null $hiddenLocation`| +|`BeforeHideLocationEvent`|`LocationService::hideLocation`|`Location $location`
`?Location $hiddenLocation`| |`HideLocationEvent`|`LocationService::hideLocation`|`Location $hiddenLocation`
`Location $location`| -|`BeforeUnhideLocationEvent`|`LocationService::unhideLocation`|`Location $location`
`Location|null $revealedLocation`| +|`BeforeUnhideLocationEvent`|`LocationService::unhideLocation`|`Location $location`
`?Location $revealedLocation`| |`UnhideLocationEvent`|`LocationService::unhideLocation`|`Location $revealedLocation`
`Location $location`| ## Subtree and Location management | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCopySubtreeEvent`|`LocationService::copySubtree`|`Location $subtree`
`Location $targetParentLocation`
`Location|null $location`| +|`BeforeCopySubtreeEvent`|`LocationService::copySubtree`|`Location $subtree`
`Location $targetParentLocation`
`?Location $location`| |`CopySubtreeEvent`|`LocationService::copySubtree`|`Location $location`
`Location $subtree`
`Location $targetParentLocation`| |`BeforeMoveSubtreeEvent`|`LocationService::moveSubtree`|`Location $location`
`Location $newParentLocation`| |`MoveSubtreeEvent`|`LocationService::moveSubtree`|`Location $location`
`Location $newParentLocation`| diff --git a/docs/api/event_reference/object_state_events.md b/docs/api/event_reference/object_state_events.md index fdbd724b29..6d286ad244 100644 --- a/docs/api/event_reference/object_state_events.md +++ b/docs/api/event_reference/object_state_events.md @@ -7,9 +7,9 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateObjectStateEvent`|`ObjectStateService::createObjectState`|`ObjectStateGroup $objectStateGroup`
`ObjectStateCreateStruct $objectStateCreateStruct`
`ObjectState|null $objectState`| +|`BeforeCreateObjectStateEvent`|`ObjectStateService::createObjectState`|`ObjectStateGroup $objectStateGroup`
`ObjectStateCreateStruct $objectStateCreateStruct`
`?ObjectState $objectState`| |`CreateObjectStateEvent`|`ObjectStateService::createObjectState`|`ObjectState $objectState`
`ObjectStateGroup $objectStateGroup`
`ObjectStateCreateStruct $objectStateCreateStruct`| -|`BeforeUpdateObjectStateEvent`|`ObjectStateService::updateObjectState`|`ObjectState $objectState`
`ObjectStateUpdateStruct $objectStateUpdateStruct`
`ObjectState|null $updatedObjectState`| +|`BeforeUpdateObjectStateEvent`|`ObjectStateService::updateObjectState`|`ObjectState $objectState`
`ObjectStateUpdateStruct $objectStateUpdateStruct`
`?ObjectState $updatedObjectState`| |`UpdateObjectStateEvent`|`ObjectStateService::updateObjectState`|`ObjectState $updatedObjectState`
`ObjectState $objectState`
`ObjectStateUpdateStruct $objectStateUpdateStruct`| |`BeforeDeleteObjectStateEvent`|`ObjectStateService::deleteObjectState`|`ObjectState $objectState`| |`DeleteObjectStateEvent`|`ObjectStateService::deleteObjectState`|`ObjectState $objectState`| @@ -18,9 +18,9 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateObjectStateGroupEvent`|`ObjectStateService::createObjectStateGroup`|`ObjectStateGroupCreateStruct $objectStateGroupCreateStruct`
`ObjectStateGroup|null $objectStateGroup`| +|`BeforeCreateObjectStateGroupEvent`|`ObjectStateService::createObjectStateGroup`|`ObjectStateGroupCreateStruct $objectStateGroupCreateStruct`
`?ObjectStateGroup $objectStateGroup`| |`CreateObjectStateGroupEvent`|`ObjectStateService::createObjectStateGroup`|`ObjectStateGroup $objectStateGroup`
`ObjectStateGroupCreateStruct $objectStateGroupCreateStruct`| -|`BeforeUpdateObjectStateGroupEvent`|`ObjectStateService::updateObjectStateGroup`|`ObjectStateGroup $objectStateGroup`
`ObjectStateGroupUpdateStruct $objectStateGroupUpdateStruct`
`ObjectStateGroup|null $updatedObjectStateGroup`| +|`BeforeUpdateObjectStateGroupEvent`|`ObjectStateService::updateObjectStateGroup`|`ObjectStateGroup $objectStateGroup`
`ObjectStateGroupUpdateStruct $objectStateGroupUpdateStruct`
`?ObjectStateGroup $updatedObjectStateGroup`| |`UpdateObjectStateGroupEvent`|`ObjectStateService::updateObjectStateGroup`|`ObjectStateGroup $updatedObjectStateGroup`
`ObjectStateGroup $objectStateGroup`
`ObjectStateGroupUpdateStruct $objectStateGroupUpdateStruct`| |`BeforeDeleteObjectStateGroupEvent`|`ObjectStateService::deleteObjectStateGroup`|`ObjectStateGroup $objectStateGroup`| |`DeleteObjectStateGroupEvent`|`ObjectStateService::deleteObjectStateGroup`|`ObjectStateGroup $objectStateGroup`| diff --git a/docs/api/event_reference/other_events.md b/docs/api/event_reference/other_events.md index 792c2ed781..3b4a289f4d 100644 --- a/docs/api/event_reference/other_events.md +++ b/docs/api/event_reference/other_events.md @@ -23,7 +23,7 @@ The following events refer to [notifications displayed in the user menu](notific | Event | Dispatched by | Properties | |---|---|---| -|[`BeforeCreateNotificationEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Events-Notification-BeforeCreateNotificationEvent.html)|[`NotificationService::createNotification`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html#method_createNotification)|`CreateStruct $createStruct`
`Notification|null $notification`| +|[`BeforeCreateNotificationEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Events-Notification-BeforeCreateNotificationEvent.html)|[`NotificationService::createNotification`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html#method_createNotification)|`CreateStruct $createStruct`
`?Notification $notification`| |[`CreateNotificationEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Events-Notification-CreateNotificationEvent.html)|[`NotificationService::createNotification`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html#method_createNotification)|`Notification $notification`
`CreateStruct $createStruct`| |[`BeforeDeleteNotificationEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Events-Notification-BeforeDeleteNotificationEvent.html)|[`NotificationService::deleteNotification`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html#method_deleteNotification)|`Notification $notification`| |[`DeleteNotificationEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Events-Notification-DeleteNotificationEvent.html)|[`NotificationService::deleteNotification`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html#method_deleteNotification)|`Notification $notification`| @@ -38,9 +38,9 @@ The following events refer to key/value application-wide settings in database. | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateSettingEvent`|`SettingService::createSetting`|`SettingCreateStruct $settingCreateStruct`
`Setting|null $setting`| +|`BeforeCreateSettingEvent`|`SettingService::createSetting`|`SettingCreateStruct $settingCreateStruct`
`?Setting $setting`| |`CreateSettingEvent`|`SettingService::createSetting`|`Setting $setting`
`SettingCreateStruct $settingCreateStruct`| -|`BeforeUpdateSettingEvent`|`SettingService::updateSetting`|`Setting $setting`
`SettingUpdateStruct $settingUpdateStruct`
`Setting|null $updatedSetting`| +|`BeforeUpdateSettingEvent`|`SettingService::updateSetting`|`Setting $setting`
`SettingUpdateStruct $settingUpdateStruct`
`?Setting $updatedSetting`| |`UpdateSettingEvent`|`SettingService::updateSetting`|`Setting $updatedSetting`
`Setting $setting`
`SettingUpdateStruct $settingUpdateStruct`| |`BeforeDeleteSettingEvent`|`SettingService::deleteSetting`|`Setting $setting`| |`DeleteSettingEvent`|`SettingService::deleteSetting`|`Setting $setting`| diff --git a/docs/api/event_reference/page_events.md b/docs/api/event_reference/page_events.md index c9c74c2231..bea60ff38f 100644 --- a/docs/api/event_reference/page_events.md +++ b/docs/api/event_reference/page_events.md @@ -8,12 +8,12 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`AttributeSerializationEvent`|`AttributeSerializationDispatcher::serialize`|`LandingPage\Model\BlockValue $blockValue`
`string $attributeIdentifier`
`mixed|null $serializedValue`
`mixed $deserializedValue`| -|`BlockContextEvent`|`BlockService::createBlockContextFromRequest`|`Request $request`
`BlockContextInterface|null $blockContext`| -|`BlockFragmentRenderEvent`|`BlockRenderOptionsFragmentRenderer::dispatchFragmentRenderEvent`|`Content $content`
`Location|null $location`
`LandingPage\Model\Page $page`
`LandingPage\Model\BlockValue $blockValue`
`ControllerReference $uri`
`Request $request`
`array $options`| +|`AttributeSerializationEvent`|`AttributeSerializationDispatcher::serialize`|`LandingPage\Model\BlockValue $blockValue`
`string $attributeIdentifier`
`mixed $serializedValue`
`mixed $deserializedValue`| +|`BlockContextEvent`|`BlockService::createBlockContextFromRequest`|`Request $request`
`?BlockContextInterface $blockContext`| +|`BlockFragmentRenderEvent`|`BlockRenderOptionsFragmentRenderer::dispatchFragmentRenderEvent`|`Content $content`
`?Location $location`
`LandingPage\Model\Page $page`
`LandingPage\Model\BlockValue $blockValue`
`ControllerReference $uri`
`Request $request`
`array $options`| |`BlockResponseEvent`|`BlockResponseSubscriber::getSubscribedEvents`|`BlockContextInterface $blockContext`
`LandingPage\Model\BlockValue $blockValue`
`Request $request`
`Response $response`| |`CollectBlockRelationsEvent`|`CollectRelationsSubscriber::onCollectBlockRelations`|`LandingPage\Value $fieldValue`
`LandingPage\Model\BlockValue $blockValue`
`int[] $relations`| -|`PageRenderEvent`|`PageService::dispatchRenderPageEvent`|`Content $content`
`Location|null $location`
`LandingPage\Model\Page $page`
`Request $request`| +|`PageRenderEvent`|`PageService::dispatchRenderPageEvent`|`Content $content`
`?Location $location`
`LandingPage\Model\Page $page`
`Request $request`| ## Page Builder diff --git a/docs/api/event_reference/role_events.md b/docs/api/event_reference/role_events.md index 7f21faf1de..f0374ff983 100644 --- a/docs/api/event_reference/role_events.md +++ b/docs/api/event_reference/role_events.md @@ -7,13 +7,13 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateRoleDraftEvent`|`RoleService::createRoleDraft`|`Role $role`
`RoleDraft|null $roleDraft`| +|`BeforeCreateRoleDraftEvent`|`RoleService::createRoleDraft`|`Role $role`
`?RoleDraft $roleDraft`| |`CreateRoleDraftEvent`|`RoleService::createRoleDraft`|`Role $role`
`RoleDraft $roleDraft`| -|`BeforeCreateRoleEvent`|`RoleService::createRole`|`RoleCreateStruct $roleCreateStruct`
`RoleDraft|null $roleDraft`| +|`BeforeCreateRoleEvent`|`RoleService::createRole`|`RoleCreateStruct $roleCreateStruct`
`?RoleDraft $roleDraft`| |`CreateRoleEvent`|`RoleService::createRole`|`RoleCreateStruct $roleCreateStruct`
`RoleDraft $roleDraft`| -|`BeforeUpdateRoleDraftEvent`|`RoleService::updateRoleDraft`|`RoleDraft $roleDraft`
`RoleUpdateStruct $roleUpdateStruct`
`RoleDraft|null $updatedRoleDraft`| +|`BeforeUpdateRoleDraftEvent`|`RoleService::updateRoleDraft`|`RoleDraft $roleDraft`
`RoleUpdateStruct $roleUpdateStruct`
`?RoleDraft $updatedRoleDraft`| |`UpdateRoleDraftEvent`|`RoleService::updateRoleDraft`|`RoleDraft $roleDraft`
`RoleUpdateStruct $roleUpdateStruct`
`RoleDraft $updatedRoleDraft`| -|`BeforeCopyRoleEvent`|`RoleService::copyRole`|`Role $role`
`RoleCopyStruct $roleCopyStruct`
`Role|null $copiedRole`| +|`BeforeCopyRoleEvent`|`RoleService::copyRole`|`Role $role`
`RoleCopyStruct $roleCopyStruct`
`?Role $copiedRole`| |`CopyRoleEvent`|`RoleService::copyRole`|`Role $copiedRole`
`Role $role`
`RoleCopyStruct $roleCopyStruct`| |`BeforePublishRoleDraftEvent`|`RoleService::publishRoleDraft`|`RoleDraft $roleDraft`| |`PublishRoleDraftEvent`|`RoleService::publishRoleDraft`|`RoleDraft $roleDraft`| @@ -26,11 +26,11 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeAddPolicyByRoleDraftEvent`|`RoleService::addPolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyCreateStruct $policyCreateStruct`
`RoleDraft|null $updatedRoleDraft`| +|`BeforeAddPolicyByRoleDraftEvent`|`RoleService::addPolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyCreateStruct $policyCreateStruct`
`?RoleDraft $updatedRoleDraft`| |`AddPolicyByRoleDraftEvent`|`RoleService::addPolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyCreateStruct $policyCreateStruct`
`private $updatedRoleDraft`| -|`BeforeUpdatePolicyByRoleDraftEvent`|`RoleService::updatePolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyDraft $policy`
`PolicyUpdateStruct $policyUpdateStruct`
`PolicyDraft|null $updatedPolicyDraft`| +|`BeforeUpdatePolicyByRoleDraftEvent`|`RoleService::updatePolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyDraft $policy`
`PolicyUpdateStruct $policyUpdateStruct`
`?PolicyDraft $updatedPolicyDraft`| |`UpdatePolicyByRoleDraftEvent`|`RoleService::updatePolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyDraft $policy`
`PolicyUpdateStruct $policyUpdateStruct`
`PolicyDraft $updatedPolicyDraft`| -|`BeforeRemovePolicyByRoleDraftEvent`|`RoleService::removePolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyDraft $policyDraft`
`RoleDraft|null $updatedRoleDraft`| +|`BeforeRemovePolicyByRoleDraftEvent`|`RoleService::removePolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyDraft $policyDraft`
`?RoleDraft $updatedRoleDraft`| |`RemovePolicyByRoleDraftEvent`|`RoleService::removePolicyByRoleDraft`|`RoleDraft $roleDraft`
`PolicyDraft $policyDraft`
`RoleDraft $updatedRoleDraft`| ## Assigning roles diff --git a/docs/api/event_reference/section_events.md b/docs/api/event_reference/section_events.md index dfc7234992..10921a0d3d 100644 --- a/docs/api/event_reference/section_events.md +++ b/docs/api/event_reference/section_events.md @@ -7,11 +7,11 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateSectionEvent`|`SectionService::createSection`|`SectionCreateStruct $sectionCreateStruct`
`Section|null $section`| +|`BeforeCreateSectionEvent`|`SectionService::createSection`|`SectionCreateStruct $sectionCreateStruct`
`?Section $section`| |`CreateSectionEvent`|`SectionService::createSection`|`SectionCreateStruct $sectionCreateStruct`
`Section $section`| |`BeforeDeleteSectionEvent`|`SectionService::deleteSection`|`Section $section`| |`DeleteSectionEvent`|`SectionService::deleteSection`|`Section $section`| -|`BeforeUpdateSectionEvent`|`SectionService::updateSection`|`Section $section`
`SectionUpdateStruct $sectionUpdateStruct`
`Section|null $updatedSection`| +|`BeforeUpdateSectionEvent`|`SectionService::updateSection`|`Section $section`
`SectionUpdateStruct $sectionUpdateStruct`
`?Section $updatedSection`| |`UpdateSectionEvent`|`SectionService::updateSection`|`Section $section`
`SectionUpdateStruct $sectionUpdateStruct`
`Section $updatedSection`| ## Assigning sections diff --git a/docs/api/event_reference/site_events.md b/docs/api/event_reference/site_events.md index af4373b2c4..7910c81f5b 100644 --- a/docs/api/event_reference/site_events.md +++ b/docs/api/event_reference/site_events.md @@ -12,7 +12,7 @@ The following events are dispatched when managing [Sites](site_factory.md). |---|---|---| |`BeforeCreateSiteEvent`|`SiteService::createSite`|`SiteCreateStruct $siteCreateStruct`
`Site $site`| |`CreateSiteEvent`|`SiteService::createSite`|`Site $site`
`SiteCreateStruct $siteCreateStruct`| -|`BeforeUpdateSiteEvent`|`SiteService::updateSite`|`Site $site`
`SiteUpdateStruct $siteUpdateStruct`
`Site|null $updatedSite`| +|`BeforeUpdateSiteEvent`|`SiteService::updateSite`|`Site $site`
`SiteUpdateStruct $siteUpdateStruct`
`?Site $updatedSite`| |`UpdateSiteEvent`|`SiteService::updateSite`|`Site $updatedSite`
`Site $site`
`SiteUpdateStruct $siteUpdateStruct`| |`BeforeDeleteSiteEvent`|`SiteService::deleteSite`|`Site $site`| |`DeleteSiteEvent`|`SiteService::deleteSite`|`Site $site`| diff --git a/docs/api/event_reference/trash_events.md b/docs/api/event_reference/trash_events.md index 626988c0e8..87356e2e72 100644 --- a/docs/api/event_reference/trash_events.md +++ b/docs/api/event_reference/trash_events.md @@ -9,11 +9,11 @@ The following events are dispatched when managing Trash. | Event | Dispatched by | Properties | |---|---|---| -|`BeforeDeleteTrashItemEvent`|`TrashService::deleteTrashItem`|`TrashItem $trashItem`
`TrashItemDeleteResult|null $result`| +|`BeforeDeleteTrashItemEvent`|`TrashService::deleteTrashItem`|`TrashItem $trashItem`
`?TrashItemDeleteResult $result`| |`DeleteTrashItemEvent`|`TrashService::deleteTrashItem`|`TrashItem $trashItem`
`TrashItemDeleteResult $result`| -|`BeforeEmptyTrashEvent`|`TrashService::emptyTrash`|`TrashItemDeleteResultList|null $resultList`| +|`BeforeEmptyTrashEvent`|`TrashService::emptyTrash`|`?TrashItemDeleteResultList $resultList`| |`EmptyTrashEvent`|`TrashService::emptyTrash`|`TrashItemDeleteResultList $resultList`| -|`BeforeRecoverEvent`|`TrashService::recover`|`TrashItem $trashItem`
`Location $newParentLocation`
`Location|null $location`| +|`BeforeRecoverEvent`|`TrashService::recover`|`TrashItem $trashItem`
`Location $newParentLocation`
`?Location $location`| |`RecoverEvent`|`TrashService::recover`|`TrashItem $trashItem`
`Location $newParentLocation`
`Location $location`| -|`BeforeTrashEvent`|`TrashService::trash`|`Location $location`
`TrashItem|null $result`
`bool $resultSet = false`| -|`TrashEvent`|`TrashService::trash`|`Location $location`
`TrashItem|null $trashItem`| +|`BeforeTrashEvent`|`TrashService::trash`|`Location $location`
`?TrashItem $result`
`bool $resultSet = false`| +|`TrashEvent`|`TrashService::trash`|`Location $location`
`?TrashItem $trashItem`| diff --git a/docs/api/event_reference/url_events.md b/docs/api/event_reference/url_events.md index 4b7cce5010..e6b236809b 100644 --- a/docs/api/event_reference/url_events.md +++ b/docs/api/event_reference/url_events.md @@ -9,7 +9,7 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeUpdateUrlEvent`|`URLService::updateUrl`|`URL $url`
`URLUpdateStruct $struct`
`URL|null $updatedUrl`| +|`BeforeUpdateUrlEvent`|`URLService::updateUrl`|`URL $url`
`URLUpdateStruct $struct`
`?URL $updatedUrl`| |`UpdateUrlEvent`|`URLService::updateUrl`|`URL $url`
`URLUpdateStruct $struct`
`URL $updatedUrl`| ## URL aliases @@ -18,9 +18,9 @@ The following events are dispatched when creating and managing [URL aliases](url | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateGlobalUrlAliasEvent`|`URLAliasService::createGlobalUrlAlias`|`private $resource`
`private $path`
`private $languageCode`
`private $forwarding`
`private $alwaysAvailable`
`URLAlias|null $urlAlias`| +|`BeforeCreateGlobalUrlAliasEvent`|`URLAliasService::createGlobalUrlAlias`|`private $resource`
`private $path`
`private $languageCode`
`private $forwarding`
`private $alwaysAvailable`
`?URLAlias $urlAlias`| |`CreateGlobalUrlAliasEvent`|`URLAliasService::createGlobalUrlAlias`|`private $resource`
`private $path`
`private $languageCode`
`private $forwarding`
`private $alwaysAvailable`
`URLAlias $urlAlias`| -|`BeforeCreateUrlAliasEvent`|`URLAliasService::createUrlAlias`|`Location $location`
`private $path`
`private $languageCode`
`private $forwarding`
`private $alwaysAvailable`
`URLAlias|null $urlAlias`| +|`BeforeCreateUrlAliasEvent`|`URLAliasService::createUrlAlias`|`Location $location`
`private $path`
`private $languageCode`
`private $forwarding`
`private $alwaysAvailable`
`?URLAlias $urlAlias`| |`CreateUrlAliasEvent`|`URLAliasService::createUrlAlias`|`Location $location`
`private $path`
`private $languageCode`
`private $forwarding`
`private $alwaysAvailable`
`URLAlias $urlAlias`| |`BeforeRefreshSystemUrlAliasesForLocationEvent`|`URLAliasService::refreshSystemUrlAliasesForLocation`|`Location $location`| |`RefreshSystemUrlAliasesForLocationEvent`|`URLAliasService::refreshSystemUrlAliasesForLocation`|`Location $location`| @@ -33,11 +33,11 @@ The following events are dispatched when creating and managing [URL wildcards](u | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateEvent`|`URLWildcardService::create`|`private $sourceUrl`
`private $destinationUrl`
`private $forward`
`URLWildcard|null $urlWildcard`| +|`BeforeCreateEvent`|`URLWildcardService::create`|`private $sourceUrl`
`private $destinationUrl`
`private $forward`
`?URLWildcard $urlWildcard`| |`CreateEvent`|`URLWildcardService::create`|`private $sourceUrl`
`private $destinationUrl`
`private $forward`
`URLWildcard $urlWildcard`| |`BeforeUpdateEvent`|`URLWildcardService::update`|`URLWildcard $urlWildcard`
`URLWildcardUpdateStruct $updateStruct`| |`UpdateEvent`|`URLWildcardService::update`|`URLWildcard $urlWildcard`
`URLWildcardUpdateStruct $updateStruct`| -|`BeforeTranslateEvent`|`URLWildcardService::translate`|`private $url`
`URLWildcardTranslationResult|null $result`| +|`BeforeTranslateEvent`|`URLWildcardService::translate`|`private $url`
`?URLWildcardTranslationResult $result`| |`TranslateEvent`|`URLWildcardService::translate`|`private $url`
`URLWildcardTranslationResult $result`| |`BeforeRemoveEvent`|`URLWildcardService::remove`|`URLWildcard $urlWildcard`| |`RemoveEvent`|`URLWildcardService::remove`|`URLWildcard $urlWildcard`| diff --git a/docs/api/event_reference/user_events.md b/docs/api/event_reference/user_events.md index 29d83c0e50..790561aeba 100644 --- a/docs/api/event_reference/user_events.md +++ b/docs/api/event_reference/user_events.md @@ -7,22 +7,22 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateUserEvent`|`UserService::createUser`|`UserCreateStruct $userCreateStruct`
`array $parentGroups`
`User|null $user`| +|`BeforeCreateUserEvent`|`UserService::createUser`|`UserCreateStruct $userCreateStruct`
`array $parentGroups`
`?User $user`| |`CreateUserEvent`|`UserService::createUser`|`UserCreateStruct $userCreateStruct`
`array $parentGroups`
`User $user`| -|`BeforeUpdateUserEvent`|`UserService::updateUser`|`User $user`
`UserUpdateStruct $userUpdateStruct`
`User|null $updatedUser`| +|`BeforeUpdateUserEvent`|`UserService::updateUser`|`User $user`
`UserUpdateStruct $userUpdateStruct`
`?User $updatedUser`| |`UpdateUserEvent`|`UserService::updateUser`|`User $user`
`UserUpdateStruct $userUpdateStruct`
`User $updatedUser`| -|`BeforeDeleteUserEvent`|`UserService::deleteUser`|`User $user`
`array|null $locations`| +|`BeforeDeleteUserEvent`|`UserService::deleteUser`|`User $user`
`array or null $locations`| |`DeleteUserEvent`|`UserService::deleteUser`|`User $user`
`array $locations`| ## User groups | Event | Dispatched by | Properties | |---|---|---| -|`BeforeCreateUserGroupEvent`|`UserService::createUserGroup`|`UserGroupCreateStruct $userGroupCreateStruct`
`UserGroup $parentGroup`
`UserGroup|null $userGroup`| +|`BeforeCreateUserGroupEvent`|`UserService::createUserGroup`|`UserGroupCreateStruct $userGroupCreateStruct`
`UserGroup $parentGroup`
`?UserGroup $userGroup`| |`CreateUserGroupEvent`|`UserService::createUserGroup`|`UserGroupCreateStruct $userGroupCreateStruct`
`UserGroup $parentGroup`
`UserGroup $userGroup`| -|`BeforeUpdateUserGroupEvent`|`UserService::updateUserGroup`|`UserGroup $userGroup`
`UserGroupUpdateStruct $userGroupUpdateStruct`
`UserGroup|null $updatedUserGroup`| +|`BeforeUpdateUserGroupEvent`|`UserService::updateUserGroup`|`UserGroup $userGroup`
`UserGroupUpdateStruct $userGroupUpdateStruct`
`?UserGroup $updatedUserGroup`| |`UpdateUserGroupEvent`|`UserService::updateUserGroup`|`UserGroup $userGroup`
`UserGroupUpdateStruct $userGroupUpdateStruct`| -|`BeforeDeleteUserGroupEvent`|`UserService::deleteUserGroup`|`UserGroup $userGroup`
`array|null $locations`| +|`BeforeDeleteUserGroupEvent`|`UserService::deleteUserGroup`|`UserGroup $userGroup`
`array or null $locations`| |`DeleteUserGroupEvent`|`UserService::deleteUserGroup`|`UserGroup $userGroup`
`array $locations`| |`BeforeMoveUserGroupEvent`|`UserService::moveUserGroup`|`UserGroup $userGroup`
`UserGroup $newParent`| |`MoveUserGroupEvent`|`UserService::moveUserGroup`|`UserGroup $userGroup`
`UserGroup $newParent`| @@ -40,7 +40,7 @@ page_type: reference | Event | Dispatched by | Properties | |---|---|---| -|`BeforeUpdateUserPasswordEvent`|`UserService::updateUserPassword`|`User $user`
`string $newPassword`
`User|null $updatedUser`| +|`BeforeUpdateUserPasswordEvent`|`UserService::updateUserPassword`|`User $user`
`string $newPassword`
`?User $updatedUser`| |`UpdateUserPasswordEvent`|`UserService::updateUserPassword`|`User $user`
`string $newPassword`
`User $updatedUser`| -|`BeforeUpdateUserTokenEvent`|`UserService::updateUserToken`|`User $user`
`UserTokenUpdateStruct $userTokenUpdateStruct`
`User|null $updatedUser`| +|`BeforeUpdateUserTokenEvent`|`UserService::updateUserToken`|`User $user`
`UserTokenUpdateStruct $userTokenUpdateStruct`
`?User $updatedUser`| |`UpdateUserTokenEvent`|`UserService::updateUserToken`|`User $user`
`UserTokenUpdateStruct $userTokenUpdateStruct`
`User $updatedUser`| diff --git a/docs/api/rest_api/rest_api_authentication.md b/docs/api/rest_api/rest_api_authentication.md index bfe112d350..d86fbc17f4 100644 --- a/docs/api/rest_api/rest_api_authentication.md +++ b/docs/api/rest_api/rest_api_authentication.md @@ -365,7 +365,7 @@ For details, see [RFC 2617](https://datatracker.ietf.org/doc/html/rfc2617). Most HTTP client libraries and REST libraries support this method. [Creating content with binary attachments](rest_requests.md#creating-content-with-binary-attachments) is an example of using basic authentication with [cURL](https://www.php.net/manual/en/book.curl.php) and its `CURLOPT_USERPWD`. -**Raw HTTP request with basic authentication** +See the following raw HTTP request with basic authentication example: ```http GET / HTTP/1.1 diff --git a/docs/commerce/storefront/extend_storefront.md b/docs/commerce/storefront/extend_storefront.md index 1ee79ccdbb..a94b09bf00 100644 --- a/docs/commerce/storefront/extend_storefront.md +++ b/docs/commerce/storefront/extend_storefront.md @@ -11,8 +11,8 @@ With the `ibexa/storefront` package come the following built-in menus: | Item | Value | Description | |------------|----------|---------| -| [Breadcrumbs](#breadcrumbs-menu)| - | Renders breadcrumbs for content tree root, Taxonomy Entry, product, user settings, and user settings group | -| [Taxonomy](#taxonomy-menu)| - | It can render a menu for product categories or tags | +| [Breadcrumbs](#breadcrumbs-menu)| | Renders breadcrumbs for content tree root, Taxonomy Entry, product, user settings, and user settings group | +| [Taxonomy](#taxonomy-menu)| | It can render a menu for product categories or tags | | Currency| `currency_menu` | Renders a menu to change the active currency | | Language| `language_menu` | Renders a menu to change the active language | | Region | `region_menu` | Renders a menu to change the active region | diff --git a/docs/commerce/transactional_emails/transactional_emails_parameters.md b/docs/commerce/transactional_emails/transactional_emails_parameters.md index 13e2fef59e..e76f85f953 100644 --- a/docs/commerce/transactional_emails/transactional_emails_parameters.md +++ b/docs/commerce/transactional_emails/transactional_emails_parameters.md @@ -11,32 +11,32 @@ If this extensive list of variables isn't sufficient, you can [extend it to incl |Category|Variable|Description|Example values|Notes| |:----|:----|:----|:----|:----| -|Order processing|orderId|Order numerical ID|123| -| |orderIdentifier|Order identifier|660575f7-aa75-47af-b4d3-db2693f7e37c| -| |orderCurrency|Currency code|EUR| -| |orderSource|Order source|storefront| -| |orderValueNet|Total value (net)|€700,00| -| |orderValueGross|Total value (gross)|€749,50| -| |orderValueVat|Vat value|€49,50| -| |shippingAddressCountry|Country code|US| -| |shippingAddressRegion|Region|California| -| |shippingAddressLocality|City|Los Angeles| -| |shippingAddressStreet|Street|10250 Santa Monica Blvd| -| |shippingAddressPostalCode|Postal code|90067| -| |shippingAddressFirstName|Addressee's first name|John| -| |shippingAddressLastName|Addressee's last name|Doe| -| |shippingAddressEmail|E-mail address|user@example.com| -| |shippingAddressPhoneNumber|Phone number|123456789| -| |billingAddressCountry|Country code|US| -| |billingAddressTaxId|Tax Identification Number i.e. VAT|12345678| -| |billingAddressRegion|Region|California| -| |billingAddressLocality|City|Los Angeles| -| |billingAddressStreet|Street|10250 Santa Monica Blvd| -| |billingAddressPostalCode|Postal code|90067| -| |billingAddressFirstName|Payer's first name|John| -| |billingAddressLastName|Payer's last name|Doe| -| |billingAddressEmail|E-mail address|user@example.com| -| |billingAddressPhoneNumber|Phone number|123456789| +|Order processing|orderId|Order numerical ID|123| | +| |orderIdentifier|Order identifier|660575f7-aa75-47af-b4d3-db2693f7e37c| | +| |orderCurrency|Currency code|EUR| | +| |orderSource|Order source|storefront| | +| |orderValueNet|Total value (net)|€700,00| | +| |orderValueGross|Total value (gross)|€749,50| | +| |orderValueVat|Vat value|€49,50| | +| |shippingAddressCountry|Country code|US| | +| |shippingAddressRegion|Region|California| | +| |shippingAddressLocality|City|Los Angeles| | +| |shippingAddressStreet|Street|10250 Santa Monica Blvd| | +| |shippingAddressPostalCode|Postal code|90067| | +| |shippingAddressFirstName|Addressee's first name|John| | +| |shippingAddressLastName|Addressee's last name|Doe| | +| |shippingAddressEmail|E-mail address|user@example.com| | +| |shippingAddressPhoneNumber|Phone number|123456789| | +| |billingAddressCountry|Country code|US| | +| |billingAddressTaxId|Tax Identification Number i.e. VAT|12345678| | +| |billingAddressRegion|Region|California| | +| |billingAddressLocality|City|Los Angeles| | +| |billingAddressStreet|Street|10250 Santa Monica Blvd| | +| |billingAddressPostalCode|Postal code|90067| | +| |billingAddressFirstName|Payer's first name|John| | +| |billingAddressLastName|Payer's last name|Doe| | +| |billingAddressEmail|E-mail address|user@example.com| | +| |billingAddressPhoneNumber|Phone number|123456789| | |Payment|paymentMethodIdentifier|Technical identifier of payment method| | | | |paymentMethodName|Human readable name of payment method| | | | |paymentMethodDescription|Human readable description of payment method|Prepaid cards and gift cards (offline version)| | @@ -47,19 +47,19 @@ If this extensive list of variables isn't sufficient, you can [extend it to incl | |shippingMethodDescription|Human readable description of shipping method| | | | |shippingMethodTypeName|Technical name of shipping method type| | | | |shipmentStatus|Technical identifier of shipment status| |Only available in ShipmentStatusChange notification| -|Product information|products.id|Product numerical ID|123| -| |products.code|Product code (SKU)|123456| -| |products.name|Product name|iPhone 15 Pro 256GB Space Gray| -| |products.url|Product view URL|https://example.com/product/iphone-15-pro-256gb-space-gray/| -| |products.thumbnail|Product thumbnail URL|https://example.com/assets/images/iphone-15-pro-256gb-space-gray.jpg| -| |products.quantity|Quantity|5| -| |products.unitPriceNet|Unit price (net)|€700,00| -| |products.unitPriceGross|Unit Price (gross)|€749,50| -| |products.subtotalPriceNet|Subtotal price (net), quantity * unit price (net)|€2700,00| -| |products.subtotalPriceGross|Subtotal price (gross), quantity * unit price (gross)|€2749,50| -|User information|userId|Numerical ID|255| -| |userLogin|User login|john.doe| -| |userEmail|User e-mail address|john.doe@example.com| -| |userName|User name|John Doe| -|Password reset|token|Token used to reset password|5bcc871f1a966db58c06187369813447| -| |passwordResetUrl|Absolute URL to reset password|http://example.com/user/reset-password/5bcc871f1a966db58c06187369813447| +|Product information|products.id|Product numerical ID|123| | +| |products.code|Product code (SKU)|123456| | +| |products.name|Product name|iPhone 15 Pro 256GB Space Gray| | +| |products.url|Product view URL|https://example.com/product/iphone-15-pro-256gb-space-gray/| | +| |products.thumbnail|Product thumbnail URL|https://example.com/assets/images/iphone-15-pro-256gb-space-gray.jpg| | +| |products.quantity|Quantity|5| | +| |products.unitPriceNet|Unit price (net)|€700,00| | +| |products.unitPriceGross|Unit Price (gross)|€749,50| | +| |products.subtotalPriceNet|Subtotal price (net), quantity * unit price (net)|€2700,00| | +| |products.subtotalPriceGross|Subtotal price (gross), quantity * unit price (gross)|€2749,50| | +|User information|userId|Numerical ID|255| | +| |userLogin|User login|john.doe| | +| |userEmail|User e-mail address|john.doe@example.com| | +| |userName|User name|John Doe| | +|Password reset|token|Token used to reset password|5bcc871f1a966db58c06187369813447| | +| |passwordResetUrl|Absolute URL to reset password|http://example.com/user/reset-password/5bcc871f1a966db58c06187369813447| | diff --git a/docs/content_management/field_types/field_type_reference/dateandtimefield.md b/docs/content_management/field_types/field_type_reference/dateandtimefield.md index 35678d5902..60e16aba48 100644 --- a/docs/content_management/field_types/field_type_reference/dateandtimefield.md +++ b/docs/content_management/field_types/field_type_reference/dateandtimefield.md @@ -74,11 +74,11 @@ This field type doesn't perform any special validation of the input value. The field definition of this field type can be configured with several options: -| Name | Type | Default value | Description | -|----------------|-----------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------| -| `useSeconds` | `boolean` | `false` | Used to control displaying of seconds in the output. | -| `defaultType` | `mixed` | `Type::DEFAULT_EMPTY` | One of the `DEFAULT_*` constants, used by the administration interface for setting the default field value. See below for more details. | -| `dateInterval` | `null | \DateInterval` | `null` |This setting complements `defaultType` setting and can be used only when the latter is set to `Type::DEFAULT_CURRENT_DATE_ADJUSTED`. In that case the default input value when using administration interface is adjusted by the given `\DateInterval`.| +| Name | Type | Default value | Description | +|----------------|------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| `useSeconds` | `boolean` | `false` | Used to control displaying of seconds in the output. | +| `defaultType` | `mixed` | `Type::DEFAULT_EMPTY` | One of the `DEFAULT_*` constants, used by the administration interface for setting the default field value. See below for more details. | +| `dateInterval` | `?\DateInterval` | `null` | This setting complements `defaultType` setting and can be used only when the latter is set to `Type::DEFAULT_CURRENT_DATE_ADJUSTED`. In that case the default input value when using administration interface is adjusted by the given `\DateInterval`.| Following `defaultType` default value options are available as constants in the `Ibexa\Core\FieldType\DateAndTime\Type` class: diff --git a/docs/content_management/field_types/field_type_reference/keywordfield.md b/docs/content_management/field_types/field_type_reference/keywordfield.md index ddc515b93a..bec29adda9 100644 --- a/docs/content_management/field_types/field_type_reference/keywordfield.md +++ b/docs/content_management/field_types/field_type_reference/keywordfield.md @@ -2,9 +2,9 @@ This field type stores one or several comma-separated keywords as a string or array of strings. -| Name | Internal name | Expected input | -|-----------|-----------------|-------------------| -| `Keyword` | `ibexa_keyword` | `string[]|string` | +| Name | Internal name | Expected input | +|-----------|-----------------|------------------------| +| `Keyword` | `ibexa_keyword` | `string[]` or `string` | ## PHP API field type diff --git a/docs/content_management/field_types/field_type_reference/maplocationfield.md b/docs/content_management/field_types/field_type_reference/maplocationfield.md index 6687a22988..274920add4 100644 --- a/docs/content_management/field_types/field_type_reference/maplocationfield.md +++ b/docs/content_management/field_types/field_type_reference/maplocationfield.md @@ -53,15 +53,15 @@ $MapLocationValue = new MapLocation\Value( The template called by [the `ibexa_render_field()` Twig function](field_twig_functions.md#ibexa_render_field) while rendering a Map location field accepts the following parameters: -| Parameter | Type | Default | Description | -|---------------|------------|---------|----------------------------------------------------------------------------------------------------------------| -| `draggable` | `boolean` | `true` | Whether to enable a draggable map. | -| `height` | `string | false` | `"200px"` |The height of the rendered map with its unit (for example "200px" or "20em"), set to false to not set any height style inline.| -| `scrollWheel` | `boolean` | `true` | Allows you to disable scroll wheel starting to zoom when mouse comes over the map as user scrolls down a page. | -| `showInfo` | `booolean` | `true` | Whether to show a latitude, longitude and the address outside of the map. | -| `showMap` | `boolean` | `true` | Whether to show the OpenStreetMap. | -| `width` | `string | false` | `"500px"` |The width of the rendered map with its unit (for example "500px" or "50em"), set to false to not set any width style inline.| -| `zoom` | `integer` | `13` | The initial zoom level on the map. | +| Parameter | Type | Default | Description | +|---------------|---------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------| +| `draggable` | `boolean` | `true` | Whether to enable a draggable map. | +| `height` | `string` or `false` | `"200px"` | The height of the rendered map with its unit (for example "200px" or "20em"), set to false to not set any height style inline. | +| `scrollWheel` | `boolean` | `true` | Allows you to disable scroll wheel starting to zoom when mouse comes over the map as user scrolls down a page. | +| `showInfo` | `booolean` | `true` | Whether to show a latitude, longitude and the address outside of the map. | +| `showMap` | `boolean` | `true` | Whether to show the OpenStreetMap. | +| `width` | `string` or `false` | `"500px"` | The width of the rendered map with its unit (for example "500px" or "50em"), set to false to not set any width style inline. | +| `zoom` | `integer` | `13` | The initial zoom level on the map. | Example: diff --git a/docs/content_management/field_types/field_type_reference/relationfield.md b/docs/content_management/field_types/field_type_reference/relationfield.md index 6a0016cb03..f1dc7730a1 100644 --- a/docs/content_management/field_types/field_type_reference/relationfield.md +++ b/docs/content_management/field_types/field_type_reference/relationfield.md @@ -21,9 +21,9 @@ This field type makes it possible to store and retrieve the value of a relation The Value class of this field type contains the following properties: -| Property | Type | Description | -|------------------------|-------------------|-------------------------------------------------------------------------------------------| -| `$destinationContentId` | `string|int|null` | This property is used to store the value provided, which represents the related content. | +| Property | Type | Description | +|------------------------|-----------------------------|-------------------------------------------------------------------------------------------| +| `$destinationContentId` | `string`, `int`, or `null` | This property is used to store the value provided, which represents the related content. | ``` php // Value object content example diff --git a/docs/content_management/field_types/field_type_reference/relationlistfield.md b/docs/content_management/field_types/field_type_reference/relationlistfield.md index 9bdac070d6..86dece9cc8 100644 --- a/docs/content_management/field_types/field_type_reference/relationlistfield.md +++ b/docs/content_management/field_types/field_type_reference/relationlistfield.md @@ -12,7 +12,7 @@ This field type makes it possible to store and retrieve values of a relation to |Type|Description|Example| |------|------|------| -|`int|string`|ID of the related content item|`42`| +|`int` or `string`|ID of the related content item|`42`| |`array`|An array of related Content IDs|`[ 24, 42 ]`| |`Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo`|ContentInfo instance of the related Content|n/a| |`Ibexa\Core\FieldType\RelationList\Value`|RelationList field type value object|See below.| @@ -74,7 +74,7 @@ The field definition of this field type can be configured with the following opt |Name|Type|Default value|Description| |------|------|------|------| |`selectionMethod`|`mixed`|`SELECTION_BROWSE`|Method of selection in the back-end interface.| -|`selectionDefaultLocation`|`string|integer`|`null`|ID of the default Location for the selection when using the back-end interface.| +|`selectionDefaultLocation`|`string` or `integer`|`null`|ID of the default Location for the selection when using the back-end interface.| |`selectionContentTypes`|`array`|`[]`|An array of content type IDs that are allowed for related Content.| Following selection methods are available: diff --git a/docs/content_management/field_types/field_type_reference/taxonomyentryfield.md b/docs/content_management/field_types/field_type_reference/taxonomyentryfield.md index 89ee705228..787a03ade6 100644 --- a/docs/content_management/field_types/field_type_reference/taxonomyentryfield.md +++ b/docs/content_management/field_types/field_type_reference/taxonomyentryfield.md @@ -41,7 +41,7 @@ Example using array: |Property|Type|Description| |--------|----|-----------| -|`taxonomyEntry`|`Ibexa\Contracts\Taxonomy\Value\TaxonomyEntry|null`|Stores selected taxonomy entry.| +|`taxonomyEntry`|`?Ibexa\Contracts\Taxonomy\Value\TaxonomyEntry`|Stores selected taxonomy entry.| #### Constructor diff --git a/docs/content_management/field_types/field_type_reference/timefield.md b/docs/content_management/field_types/field_type_reference/timefield.md index 062270a9af..6b32ab8bb9 100644 --- a/docs/content_management/field_types/field_type_reference/timefield.md +++ b/docs/content_management/field_types/field_type_reference/timefield.md @@ -30,9 +30,9 @@ It's also possible to directly pass an instance of `\DateTime`. The Value class of this field type contains the following properties: -| Property | Type | Description | -|----------|----------------|-----------------------------------------------------------------------------------| -| `$time` | `integer|null` | Holds the time information as a number of seconds since the beginning of the day. | +| Property | Type | Description | +|----------|---------------------|-----------------------------------------------------------------------------------| +| `$time` | `integer` or `null` | Holds the time information as a number of seconds since the beginning of the day. | #### Constructor diff --git a/docs/content_management/field_types/field_type_reference/userfield.md b/docs/content_management/field_types/field_type_reference/userfield.md index 4ca7180596..8a470d803d 100644 --- a/docs/content_management/field_types/field_type_reference/userfield.md +++ b/docs/content_management/field_types/field_type_reference/userfield.md @@ -13,7 +13,7 @@ This field type validates and stores information about a user. | Property | Type | Description | Example | |--------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------| | `hasStoredLogin` | `boolean` | Denotes if user has stored login. | `true` | -| `contentId` | `int | string` | ID of the content item corresponding to the user. |`42`| +| `contentId` | `int` or `string` | ID of the content item corresponding to the user. |`42`| | `login` | `string` | Username. | `john` | | `email` | `string` | The user's email address. | `john@smith.com` | | `passwordHash` | `string` | Hash of the user's password. | `1234567890abcdef` | diff --git a/docs/content_management/images/images.md b/docs/content_management/images/images.md index 73b29e9575..c2b11eab99 100644 --- a/docs/content_management/images/images.md +++ b/docs/content_management/images/images.md @@ -168,19 +168,19 @@ If there is no configuration assigned to the `binary_handler`, the placeholder g #### Configuration examples -**Example 1 - placeholders with basic information about original image** +##### Example 1 - placeholders with basic information about original image ```yaml [[= include_file('code_samples/back_office/images/config/packages/images_basic.yaml') =]] ``` -**Example 2 - placeholders from remote source** +##### Example 2 - placeholders from remote source ```yaml [[= include_file('code_samples/back_office/images/config/packages/images_remote.yaml') =]] ``` -**Example 3 - placeholders from live version of a site** +##### Example 3 - placeholders from live version of a site ```yaml [[= include_file('code_samples/back_office/images/config/packages/images_live.yaml') =]] diff --git a/docs/infrastructure_and_maintenance/cache/persistence_cache.md b/docs/infrastructure_and_maintenance/cache/persistence_cache.md index 8f98350b64..37316289dc 100644 --- a/docs/infrastructure_and_maintenance/cache/persistence_cache.md +++ b/docs/infrastructure_and_maintenance/cache/persistence_cache.md @@ -54,7 +54,7 @@ Use of Redis as shared cache back end is a requirement for use in clustering set For an overview of this feature, see [Clustering](clustering.md). Filesystem adapters, for example, are **not** intended to be used over a shared filesystem. -**Cache service** +### Cache service The underlying cache system is exposed as an `ibexa.cache_pool` service, and can be reused by any other service as described in the [Using Cache service](#using-cache-service) section. diff --git a/docs/permissions/policies.md b/docs/permissions/policies.md index 44befc165a..0a096d2ebc 100644 --- a/docs/permissions/policies.md +++ b/docs/permissions/policies.md @@ -34,20 +34,20 @@ Each role you assign to user or user group consists of policies which define, wh | Module | Function | Effect | Possible Limitations | |-------------------------------------|------------------------|------------------------|----------------------| -| `action_configuration` | `view` | view AI Action | -| | `create` | create a new AI action | -| | `edit` | edit an AI action | -| | `delete` | delete an AI action | -| | `execute` | execute an AI action | +| `action_configuration` | `view` | view AI Action | | +| | `create` | create a new AI action | | +| | `edit` | edit an AI action | | +| | `delete` | delete an AI action | | +| | `execute` | execute an AI action | | #### Customer groups | Module | Function | Effect | Possible limitations | |-------------------------------|-----------------------|-------------------------|----------------------| -| `customer_group` | `create` | create a customer group | -| | `delete` | delete a customer group | -| | `edit` | edit a customer group | -| | `view` | view customer groups | +| `customer_group` | `create` | create a customer group | | +| | `delete` | delete a customer group | | +| | `edit` | edit a customer group | | +| | `view` | view customer groups | | #### Personalization @@ -60,43 +60,43 @@ Each role you assign to user or user group consists of policies which define, wh | Module | Function | Effect | Possible limitations | |---------------------|-----------------------|----------------------------------------------------------------------------|----------------------| -| `role` | `assign` | assign roles to users and user groups | -| | `create` | create new roles | -| | `delete` | delete roles | -| | `read` | view the roles list in Admin. Required for all other role-related policies | -| | `update` | modify existing roles | +| `role` | `assign` | assign roles to users and user groups | | +| | `create` | create new roles | | +| | `delete` | delete roles | | +| | `read` | view the roles list in Admin. Required for all other role-related policies | | +| | `update` | modify existing roles | | #### Setup -| Module | Function | Effect | Possible limitations | -|----------------------|-----------------------------|------------------------------------------|----------------------| -| `setup` | `administrate` | access Admin | -| | `install` | unused | -| | `setup` | unused | -| | `system_info` | view the **System Information** tab in Admin | +| Module | Function | Effect | Possible limitations | +|----------------------|-----------------------------|----------------------------------------------|----------------------| +| `setup` | `administrate` | access Admin | | +| | `install` | unused | | +| | `setup` | unused | | +| | `system_info` | view the **System Information** tab in Admin | | #### Sites [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] | Module | Function | Effect | Possible limitations | |---------------------|------------------------------|-------------------------------------------------------------------------------------------------------|----------------------| -| `site` | `change_status` | change status of the public accesses of sites to `Live` or `Offline` in the Site Factory | -| | `create` | create sites in the Site Factory | -| | `delete` | delete sites from the Site Factory | -| | `edit` | edit sites in the Site Factory | -| | `update` | update sites in the Site Factory | -| | `view` | view the "Sites" in the top navigation | +| `site` | `change_status` | change status of the public accesses of sites to `Live` or `Offline` in the Site Factory | | +| | `create` | create sites in the Site Factory | | +| | `delete` | delete sites from the Site Factory | | +| | `edit` | edit sites in the Site Factory | | +| | `update` | update sites in the Site Factory | | +| | `view` | view the "Sites" in the top navigation | | #### Users | Module | Function | Effect | Possible limitations | |---------------------|----------------------------|---------------------------------------------------|----------------------| -| `user` | `activation` | unused | -| | `invite` | create and send invitations to create an account | -| | `login` | log in to the application | -| | `password` | unused | -| | `preferences` | access and set user preferences | -| | `register` | register using the `/register` route | -| | `selfedit` | unused | +| `user` | `activation` | unused | | +| | `invite` | create and send invitations to create an account | | +| | `login` | log in to the application | | +| | `password` | unused | | +| | `preferences` | access and set user preferences | | +| | `register` | register using the `/register` route | | +| | `selfedit` | unused | | ### Commerce @@ -113,17 +113,17 @@ Each role you assign to user or user group consists of policies which define, wh | Module | Function | Effect | Possible limitations | |-------------------------|-----------------------|---------------------------------------------------------------------|----------------------| -| `checkout` | `create` | create new checkout, for example, after workflow fails to complete | -| | `delete` | delete checkout, for example, after workflow completes successfully | -| | `update` | change currency, quantity | -| | `view` | access checkout | +| `checkout` | `create` | create new checkout, for example, after workflow fails to complete | | +| | `delete` | delete checkout, for example, after workflow completes successfully | | +| | `update` | change currency, quantity | | +| | `view` | access checkout | | #### Currencies and regions | Module | Function | Effect | Possible limitations | |-------------------------|-------------------------|-------------------|----------------------| -| `commerce` | `currency` | manage currencies | -| | `region` | manage regions | +| `commerce` | `currency` | manage currencies | | +| | `region` | manage regions | | #### Discounts [[% include 'snippets/commerce_badge.md' %]] @@ -165,10 +165,10 @@ The [discount](discounts.md) policies decide which actions can be executed by gi | Module | Function | Effect | Possible limitations | |-------------------------------|-----------------------|-------------------------|----------------------| -| `payment_method` | `create` | create a payment method | -| | `delete` | delete a payment method | -| | `edit` | modify a payment method | -| | `view` | view payment methods | +| `payment_method` | `create` | create a payment method | | +| | `delete` | delete a payment method | | +| | `edit` | modify a payment method | | +| | `view` | view payment methods | | #### Segments [[% include 'snippets/commerce_badge.md' %]] @@ -184,10 +184,10 @@ The [discount](discounts.md) policies decide which actions can be executed by gi | Module | Function | Effect | Possible limitations | |------------------------------|-----------------------|--------------------------------|----------------------| -| `segment_group` | `create` | create segment groups | -| | `read` | load segment group information | -| | `remove` | remove segment groups | -| | `update` | update segment groups | +| `segment_group` | `create` | create segment groups | | +| | `read` | load segment group information | | +| | `remove` | remove segment groups | | +| | `update` | update segment groups | | #### Shipments [[% include 'snippets/commerce_badge.md' %]] @@ -202,10 +202,10 @@ The [discount](discounts.md) policies decide which actions can be executed by gi | Module | Function | Effect | Possible limitations | |--------------------------------|-----------------------|--------------------------|----------------------| -| `shipping_method` | `create` | create a shipping method | -| | `delete` | delete a shipping method | -| | `update` | modify a shipping method | -| | `view` | view shipping methods | +| `shipping_method` | `create` | create a shipping method | | +| | `delete` | delete a shipping method | | +| | `update` | modify a shipping method | | +| | `view` | view shipping methods | | #### Shopping lists [[% include 'snippets/lts-update_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] @@ -222,22 +222,22 @@ The [discount](discounts.md) policies decide which actions can be executed by gi | Module | Function | Effect | Possible limitations | |------------------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `content` | `cleantrash` | empty the Trash (even when the User doesn't have access to individual content items) | +| `content` | `cleantrash` | empty the Trash (even when the User doesn't have access to individual content items) | | | | `create` | create new content. Note: even without this policy the user is able to enter edit mode, but cannot finalize work with the content item. | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Language](limitation_reference.md#language-limitation)
[Owner of Parent](limitation_reference.md#owner-of-parent-limitation)
[Content type Group of Parent](limitation_reference.md#content-type-group-of-parent-limitation)
[Content type of Parent](limitation_reference.md#content-type-of-parent-limitation)
[Parent Depth](limitation_reference.md#parent-depth-limitation)
[Field Group](limitation_reference.md#field-group-limitation)
[Change Owner](limitation_reference.md#change-owner-limitation) | -| | `diff` | unused | +| | `diff` | unused | | | | `edit` | edit existing content | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Content type Group](limitation_reference.md#content-type-group-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Language](limitation_reference.md#language-limitation)
[Object State](limitation_reference.md#object-state-limitation)
[Workflow Stage](limitation_reference.md#workflow-stage-limitation)
[Field Group](limitation_reference.md#field-group-limitation)
[Version Lock](limitation_reference.md#version-lock-limitation)
[Change Owner](limitation_reference.md#change-owner-limitation) | | | `hide` | hide and reveal content locations | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Content type Group](limitation_reference.md#content-type-group-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Language](limitation_reference.md#language-limitation) | | | `manage_locations` | remove locations and send content to Trash | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Object State](limitation_reference.md#object-state-limitation) | -| | `pendinglist` | unused | +| | `pendinglist` | unused | | | | `publish` | publish content. Without this Policy, the User can only save drafts or send them for review (in [[= product_name_exp =]]) | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Content type Group](limitation_reference.md#content-type-group-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Language](limitation_reference.md#language-limitation)
[Object State](limitation_reference.md#object-state-limitation)
[Workflow Stage](limitation_reference.md#workflow-stage-limitation) | | | `read` | view the content both in front and back end | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Content type Group](limitation_reference.md#content-type-group-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Object State](limitation_reference.md#object-state-limitation) | | | `remove` | remove locations and send content to Trash | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Object State](limitation_reference.md#object-state-limitation)
[Language](limitation_reference.md#language-limitation) | -| | `restore` | restore content from Trash | +| | `restore` | restore content from Trash | | | | `reverserelatedlist` | see all content that a content item relates to (even when the User isn't allowed to view it as an individual content items) | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
| | | `translate` | unused | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Language](limitation_reference.md#language-limitation) | -| | `translations` | manage the language list in Admin | +| | `translations` | manage the language list in Admin || | | `unlock` | unlock drafts locked to a user for performing actions | [Owner](limitation_reference.md#owner-limitation)
[Content type Group](limitation_reference.md#content-type-group-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Language](limitation_reference.md#language-limitation)
[Version Lock](limitation_reference.md#version-lock-limitation) | -| | `urltranslator` | manage URL aliases of a content item | +| | `urltranslator` | manage URL aliases of a content item | | | | `versionread` | view content after publishing, and to preview any content in the Site mode | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
Status
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Object State](limitation_reference.md#object-state-limitation) | | | `versionremove` | remove archived content versions | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
Status
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Object State](limitation_reference.md#object-state-limitation) | | | `view_embed` | view content embedded in another content item (even when the User isn't allowed to view it as an individual content item) | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation) | @@ -247,44 +247,44 @@ The [discount](discounts.md) policies decide which actions can be executed by gi | Module | Function | Effect | Possible limitations | |----------------------|-----------------------|--------------------------------------------------------------------------|----------------------| | `content` | `share` | share content drafts with internal and external users through [collaborative editing](collaborative_editing.md) |[Owner](limitation_reference.md#collaborative-editing-owner-limitation)
[PublicLink](limitation_reference.md#collaborative-editing-publiclink-limitation)
[Scope](limitation_reference.md#collaborative-editing-scope-limitation) | -| `rte` | `edit` | use [Real-time editing](collaborative_editing_guide.md#real-time-editing) | +| `rte` | `edit` | use [Real-time editing](collaborative_editing_guide.md#real-time-editing) | | #### Content types | Module | Function | Effect | Possible limitations | |----------------------|-----------------------|--------------------------------------------------------------------------|----------------------| -| `class` | `create` | create new content types. Also required to edit exiting content types | -| | `delete` | delete content types | -| | `update` | modify existing content types. Also required to create new content types | +| `class` | `create` | create new content types. Also required to edit exiting content types | | +| | `delete` | delete content types | | +| | `update` | modify existing content types. Also required to create new content types | | #### Sections | Module | Function | Effect | Possible limitations | |------------------------|-----------------------|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `section` | `assign` | assign Sections to content | [content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[New Section](limitation_reference.md#new-section-limitation) | -| | `edit` | edit existing Sections and create new ones | -| | `view` | view the Sections list in Admin. Required for all other section-related policies | +| | `edit` | edit existing Sections and create new ones | | +| | `view` | view the Sections list in Admin. Required for all other section-related policies | | #### Object States | Module | Function | Effect | Possible limitations | |----------------------|-----------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `state` | `assign` | assign object states to content items | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Content type Group](limitation_reference.md#content-type-group-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Object State](limitation_reference.md#object-state-limitation)
[New State](limitation_reference.md#new-state-limitation) | -| | `administrate` | view, add and edit object states | +| | `administrate` | view, add and edit object states | | #### Taxonomy | Module | Function | Effect | Possible limitations | |-------------------------|-----------------------|-------------------------------|----------------------| -| `taxonomy` | `assign` | tag or untag content | -| | `manage` | create, edit, and delete tags | -| | `read` | view the Taxonomy interface | +| `taxonomy` | `assign` | tag or untag content | | +| | `manage` | create, edit, and delete tags | | +| | `read` | view the Taxonomy interface | | #### Workflow and version comparison | Module | Function | Effect | Possible limitations | |---------------------------|-----------------------------|----------------------------------------|-------------------------------------------------------------------------------| -| `comparison` | `view` | view version comparison | +| `comparison` | `view` | view version comparison | | | `workflow` | `change_stage` | change stage in the specified workflow | [Workflow Transition](limitation_reference.md#workflow-transition-limitation) | ### Product catalog @@ -293,10 +293,10 @@ The [discount](discounts.md) policies decide which actions can be executed by gi | Module | Function | Effect | Possible limitations | |------------------------|-----------------------|------------------|----------------------| -| `catalog` | `create` | create a catalog | -| | `delete` | delete a catalog | -| | `edit` | edit a catalog | -| | `view` | view catalogs | +| `catalog` | `create` | create a catalog | | +| | `delete` | delete a catalog | | +| | `edit` | edit a catalog | | +| | `view` | view catalogs | | #### Products diff --git a/docs/personalization/tracking_with_ibexa-tracker.md b/docs/personalization/tracking_with_ibexa-tracker.md index 71079030e1..388bb2dac1 100644 --- a/docs/personalization/tracking_with_ibexa-tracker.md +++ b/docs/personalization/tracking_with_ibexa-tracker.md @@ -87,7 +87,7 @@ _ycq.push(['_trackEvent', '1', 'click', '10', '']); | `_setMandator` | - Executed with one additional parameter: `MandatorId` | `_ycq.push(['_setMandator' , '']);` | | `_trackEvent` | - Executed with four additional parameters: `ItemType`, `EventType`, `ItemId`, `UserId`.
- `EventType` can be any of the [described types]([[= user_doc =]]/personalization/event_types/) | capturing an event: `_ycq.push(['_trackEvent', '1', 'buy', '10', '']);` | | `_trackTimedEvent` | - Executed with five additional parameters:`ItemType`, `EventType`, `ItemId`, `Timeout`, `UserId`.
- `EventType` can be any of the [described types]([[= user_doc =]]/personalization/event_types/).
- `Timeout` can be any integer greater than 0 representing time in ms | consume event sent after 20s: `_ycq.push(['_trackTimedEvent', '1', 'consume', '10', '20000', '']);` | -| `_login` | - Executed with two additional parameters: anonymous userId, pseudonymous userId.
- It is to be triggered when a user logs in and the tracking identity is changed.
| - | +| `_login` | - Executed with two additional parameters: anonymous userId, pseudonymous userId.
- It is to be triggered when a user logs in and the tracking identity is changed.
| | | `ycreco=true` | - If you want to send a click recommended event you can append the following parameter to the recommended item URLs: | [https://mydomain.com/mypage.html?ycreco=true](https://mydomain.com/mypage.html?ycreco=true) or
[https://mydomain.com/mypage.html?myparameter=x&ycreco=true](https://mydomain.com/mypage.html?myparameter=x&ycreco=true) | ## Tracking with HTML event handlers diff --git a/docs/release_notes/ez_platform_v3.0_deprecations.md b/docs/release_notes/ez_platform_v3.0_deprecations.md index 233511207a..01341d68b8 100644 --- a/docs/release_notes/ez_platform_v3.0_deprecations.md +++ b/docs/release_notes/ez_platform_v3.0_deprecations.md @@ -311,7 +311,7 @@ The following deprecated items have been removed: |`fieldDefinitionsByGroup`|`EzSystems\EzPlatformAdminUi\Tab\LocationView\ContentTab`| `field_definitions_by_group` | |`full`|`window.eZ.adminUiConfig.dateFormat`| `fullDateTime` | |`short`|`window.eZ.adminUiConfig.dateFormat`| `shortDateTime` | -|`limit`|`EzSystems\EzPlatformAdminUi\UI\Module\Subitems\ContentViewParameterSupplier`| - | +|`limit`|`EzSystems\EzPlatformAdminUi\UI\Module\Subitems\ContentViewParameterSupplier`| | |`contentTypeNames`|`window.eZ.adminUiConfig`|`contentTypes`| Following the upgrade to Symfony 5, the following event classes have been deprecated: diff --git a/docs/search/criteria_reference/search_criteria_reference.md b/docs/search/criteria_reference/search_criteria_reference.md index 2e73e8724c..0a6638217c 100644 --- a/docs/search/criteria_reference/search_criteria_reference.md +++ b/docs/search/criteria_reference/search_criteria_reference.md @@ -60,7 +60,7 @@ Due to this storage limitation, searching content using the Country field type o | [ObjectStateId](objectstateid_criterion.md) | Object state ID | ✔ | ✔ | ✔ | | | [ObjectStateIdentifier](objectstateidentifier_criterion.md) | Object state Identifier | ✔ | ✔ | ✔ | | | [ParentLocationId](parentlocationid_criterion.md) | Location ID of a content item's parent | ✔ | ✔ | ✔ | | -| [ParentLocationRemoteId](parentlocationremoteId_criterion.md) | Location remote ID of a content item's parent | ✔ | ✔ | | +| [ParentLocationRemoteId](parentlocationremoteId_criterion.md) | Location remote ID of a content item's parent | ✔ | ✔ | | | | [Priority](priority_criterion.md) | Location priority | | ✔ | ✔ | | | [RemoteId](remoteid_criterion.md) | Remote content ID | ✔ | ✔ | ✔ | | | [SectionId](sectionid_criterion.md) | ID of the Section content is assigned to | ✔ | ✔ | ✔ | ✔ | diff --git a/docs/search/search_engines/elasticsearch/elasticsearch_overview.md b/docs/search/search_engines/elasticsearch/elasticsearch_overview.md index 8902ba97f0..3951aad368 100644 --- a/docs/search/search_engines/elasticsearch/elasticsearch_overview.md +++ b/docs/search/search_engines/elasticsearch/elasticsearch_overview.md @@ -17,7 +17,7 @@ Thanks to this mechanism, it's able to achieve fast response. For a detailed description of advanced settings that you might require in a specific production environment, see the documentation provided by Elastic. Start with the [Set up Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/8.19/setup.html) section. -**Prerequisite** +## Prerequisite To proceed you need to be familiar with how indexing, filtering and queries work. diff --git a/docs/templating/urls_and_routes/custom_breadcrumbs.md b/docs/templating/urls_and_routes/custom_breadcrumbs.md index 3da8df6e42..7e35dfbae0 100644 --- a/docs/templating/urls_and_routes/custom_breadcrumbs.md +++ b/docs/templating/urls_and_routes/custom_breadcrumbs.md @@ -22,7 +22,7 @@ Both `breadcrumb_path` and `breadcrumb_names` must be configured for the breadcr |Option|Description| |--- |--- | |`breadcrumb_path`|Valid route identifier which exists in at least one of the routing YAML files.| -|`breadcrumb_names`|Name for the breadcrumb element. If the translation isn't set, there is a fallback to route translation.
In the example above if the `Blog List` key has no translation, the fallback key is `custom_blog_index|breadcrumb`.| +|`breadcrumb_names`|Name for the breadcrumb element. If the translation isn't set, there is a fallback to route translation.
In the example above if the `Blog List` key has no translation, the fallback key is custom_blog_index | breadcrumb.| ### Multi-part routes diff --git a/docs/update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish_platform.md b/docs/update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish_platform.md index 5956b5e224..bf7361202e 100644 --- a/docs/update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish_platform.md +++ b/docs/update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish_platform.md @@ -423,9 +423,11 @@ Once you have fixed all the dump files in `ezxmltext-export/`, you may skip the `php -d memory_limit=1536M bin/console ezxmltext:import-xml --export-dir=ezxmltext-export -v` +##### Typical problems + Typical problems that needs manual fixing: -**Duplicate XHTML IDs** +###### Duplicate XHTML ID XHTML IDs needs to be unique. The following `ezxmltext` results in a warning: @@ -441,7 +443,7 @@ XHTML IDs needs to be unique. The following `ezxmltext` results in a warning: The conversion tool replaces the duplicate id (`inv5`) with a random value. If you need the ID value to match your CSS, you need to change it manually. The conversion tool also complains about IDs which contain invalid characters. -**Links with non-existing `object_remote_id` or `node_remote_id`.** +###### Links with non-existing `object_remote_id` or `node_remote_id` In `ezxmltext` you may have links which refer to other objects by their remote ID. This isn't supported in `richtext`, so the conversion tool must look up such remote IDs and replace them with the `object_id` or `node_id`. If the conversion tool cannot find the object by its remote id, it issues a warning about it. @@ -453,7 +455,7 @@ In older eZ Publish databases you may also have invalid links due to lack of ref When the conversion tool detects links with no reference it issues a warning and rewrite the URL to point to current page (`href="#"`). -**``** +###### `` The `` tag isn't yet supported in eZ Platform. @@ -461,7 +463,7 @@ When you're ready to migrate your eZ Publish XmlText content to the eZ Platform `php -d memory_limit=1536M bin/console ezxmltext:convert-to-richtext --export-dir=ezxmltext-export --export-dir-filter=notice,warning,error --concurrency 4 -v` -**Custom tags and attributes** +###### Custom tags and attributes eZ Platform now supports custom tags, including inline custom tags, and limited use of custom tag attributes. After migrating to RichText, you need to adapt your custom tag config for eZ Platform and rewrite the custom tags in Twig. @@ -587,18 +589,16 @@ new EzSystems\EzFlowMigrationToolkitBundle\EzSystemsEzFlowMigrationToolkitBundle bin/console cache:clear ``` -**4.** Run the script with the following parameters: +**4.** Run the script below with the following parameters: - absolute path of your legacy application - list of .ini files which define your legacy blocks -**Script command** - ``` bash bin/console ezflow:migrate —ini= [—ini= ...] ``` -**Example of the migration script command** +Example usage: ``` bash bin/console ezflow:migrate /var/www/legacy.application.com/ —ini=extension/myapplication/settings/block.ini.append.php