Flags Reference
| 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 both the Store and Admin API. By default, all fields are enabled for the Admin API because the flag is set in the base Field class. However, the scope can be restricted to AdminApiSource and SalesChannelApiSource. |
| CascadeDelete | In case the referenced association data is deleted, the related data will be deleted too |
| Computed | Indexer or external systems compute the value 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 is 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 parent record can inherit the data of this field |
| 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 creation request of an entity. This configuration is only considered during the write process. |
| RestrictDelete | Associated data with this flag, restricts the deletion of the entity in case a record with the primary key exists. |
| 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 a 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 primarily used to protect indexed data from direct writes via the API. |
