Skip to content

Add Immutable flag description to flags reference #2040

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
vienthuong wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Immutable flag description to flags reference #2040

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5b8eb25
Add Immutable flag description to flags reference
vienthuong Dec 12, 2025
2c852d2
Remove empty line in flags reference documentation
vienthuong Dec 12, 2025
cc1dc6c
fix/sorting
Isengo1989 Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions resources/references/core-reference/dal-reference/flags-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,23 @@

# Flags Reference

| Classname | Description |
| :--- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Classname | Description |
|:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| AllowEmptyString | Flag a text column that an empty string should not be considered as null |
| AllowHtml | In case a column is allowed to contain HTML-escaped data. Beware of injection possibilities |
| ApiAware | Makes a field available in the Store or Admin API. If no parameter is passed for the flag, the field will be exposed in the both Store and Admin API. By default, all fields are enabled for the Admin API, as the flag is added in the base Field class. However, the scope can be restricted to `AdminApiSource` and `SalesChannelApiSource`. |
| CascadeDelete | In case the referenced association data will be deleted, the related data will be deleted too |
| Computed | The value is computed by indexer or external systems and cannot be written using the DAL. |
| Deprecated | This flag is used to mark the field that has been deprecated and will be removed with the next major version. |
| Extension | Defines that the data of this field is stored in an Entity::$extension and are not part of the struct itself. |
| Inherited | Defines that the data of this field can be inherited by the parent record |
| PrimaryKey | The PrimaryKey flag defines the field as part of the entity's primary key. Usually, this should be the ID field. |
| Required | Fields marked as "Required" must be specified during the create request of an entity. This configuration is only taken into account during the write process. |
| RestrictDelete | Associated data with this flag, restricts the delete of the entity in case that a record with the primary key exists. |
| AllowHtml | In case a column is allowed to contain HTML-escaped data. Beware of injection possibilities |
| ApiAware | Makes a field available in the Store or Admin API. If no parameter is passed for the flag, the field will be exposed in the both Store and Admin API. By default, all fields are enabled for the Admin API, as the flag is added in the base Field class. However, the scope can be restricted to `AdminApiSource` and `SalesChannelApiSource`. |
| CascadeDelete | In case the referenced association data will be deleted, the related data will be deleted too |
| Computed | The value is computed by indexer or external systems and cannot be written using the DAL. |
| Deprecated | This flag is used to mark the field that has been deprecated and will be removed with the next major version. |
| Extension | Defines that the data of this field is stored in an Entity::$extension and are not part of the struct itself. |
| Immutable | By setting the "Immutable" flag, it indicates that the field is write-once and then read-only |
| Inherited | Defines that the data of this field can be inherited by the parent record |
| PrimaryKey | The PrimaryKey flag defines the field as part of the entity's primary key. Usually, this should be the ID field. |
| Required | Fields marked as "Required" must be specified during the create request of an entity. This configuration is only taken into account during the write process. |
| RestrictDelete | Associated data with this flag, restricts the delete of the entity in case that a record with the primary key exists. |

Check warning on line 23 in resources/references/core-reference/dal-reference/flags-reference.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] resources/references/core-reference/dal-reference/flags-reference.md#L23 

The verb ‘delete’ does not usually follow articles like ‘the’. Check that ‘delete’ is spelled correctly; using ‘delete’ as a noun may be non-standard. (A_INFINITIVE[2])
Suggestions: `to delete`, `the deleted`, `they delete`
URL: https://languagetool.org/insights/post/verbs-as-nouns/ 
Rule: https://community.languagetool.org/rule/show/A_INFINITIVE?lang=en-US&subId=2
Category: GRAMMAR
Raw output 
resources/references/core-reference/dal-reference/flags-reference.md:23:63: The verb ‘delete’ does not usually follow articles like ‘the’. Check that ‘delete’ is spelled correctly; using ‘delete’ as a noun may be non-standard. (A_INFINITIVE[2])
 Suggestions: `to delete`, `the deleted`, `they delete`
 URL: https://languagetool.org/insights/post/verbs-as-nouns/ 
 Rule: https://community.languagetool.org/rule/show/A_INFINITIVE?lang=en-US&subId=2
 Category: GRAMMAR
| ReverseInherited | Flags "ReverseInherited" |
| Runtime | Defines that the data of the field will be loaded at runtime by an event subscriber or other class. Used in entity extensions for plugins or not directly fetchable associations. |
| SearchRanking | Defines the weight for a search query on the entity for this field |
| SetNullOnDelete | In case the referenced association data will be deleted, the related data will be set to null and an Written event will be thrown |
| Since | The "Since" flag defines since which Shopware version the field is available. |
| WriteProtected | By setting the "WriteProtected" flag, write access via API can be restricted. This flag is mostly used to protect indexed data from direct writing via API. |
| Runtime | Defines that the data of the field will be loaded at runtime by an event subscriber or other class. Used in entity extensions for plugins or not directly fetchable associations. |
| SearchRanking | Defines the weight for a search query on the entity for this field |
| SetNullOnDelete | In case the referenced association data will be deleted, the related data will be set to null and an Written event will be thrown |

Check warning on line 27 in resources/references/core-reference/dal-reference/flags-reference.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] resources/references/core-reference/dal-reference/flags-reference.md#L27 

Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
Suggestions: `a`
URL: https://languagetool.org/insights/post/indefinite-articles/ 
Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
Category: MISC
Raw output 
resources/references/core-reference/dal-reference/flags-reference.md:27:119: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
 Suggestions: `a`
 URL: https://languagetool.org/insights/post/indefinite-articles/ 
 Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
 Category: MISC
| Since | The "Since" flag defines since which Shopware version the field is available. |
| WriteProtected | By setting the "WriteProtected" flag, write access via API can be restricted. This flag is mostly used to protect indexed data from direct writing via API. | |