FileItem

{@inheritdoc}

{@inheritdoc}

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Formats a string containing a count of items.

Returns the number of plurals supported by a given language.

Gets the string translation service.

Sets the string translation service to use.

Sets the typed data manager.

Gets the typed data manager.

Constructs a TypedData object given its definition and context.

Constructs a TypedData object given its definition and context.

Gets the plugin_id of the plugin instance.

Gets the definition of the plugin implementation.

Gets the data definition.

Gets the data value.

Overrides \Drupal\Core\TypedData\TypedData::setValue().

Returns a string representation of the data.

Gets a list of validation constraints.

Validates the currently set data value.

Applies the default value.

Sets the context of a property or item via a context aware parent.

This method is supposed to be called by the factory only.

Returns the name of a property or item.

Returns the root of the typed data tree.

Returns the root data for a tree of typed data objects; e.g. for an entity field item the root of the tree is its parent entity object.

Returns the property path of the data.

The trail of property names relative to the root of the typed data tree, separated by dots; e.g. 'field_text.0.format'.

Returns the parent data structure; i.e. either complex data or a list.

Gets a property object.

Sets a property value.

Writes the value of a property without handling changes.

Implementations of onChange() should use this method instead of set() in order to avoid onChange() being triggered again.

Gets an array of property objects.

Returns an array of all property values.

Gets an array of plain property values including all not-computed properties.

{@inheritdoc}

Determines whether the data structure is empty.

Magic method: Implements a deep clone.

React to changes to a child property or item.

Note that this is invoked after any changes have been applied.

Defines the storage-level settings for this plugin.

Defines the field-level settings for this plugin.

Returns the name of the main property, if any.

Some field items consist mainly of one main property, e.g. the value of a text field or the target_id of an entity reference. If the field item has no main property, the method returns NULL.

Gets the entity that field belongs to.

Gets the langcode of the field values held in the object.

Gets the field definition.

Returns the array of field settings.

Returns the value of a field setting.

Magic method: Gets a property value.

Magic method: Sets a property value.

Magic method: Determines whether a property is set.

Magic method: Unsets a property.

Returns a renderable array for a single field item.

Defines custom presave behavior for field values.

This method is called during the process of saving an entity, just before values are written into storage. When storing a new entity, its identifier will not be available yet. This should be used to massage item property values or perform any other operation that needs to happen before values are stored. For instance this is the proper phase to auto-create a new entity for an entity reference field item, because this way it will be possible to store the referenced entity identifier.

Defines custom post-save behavior for field values.

This method is called during the process of saving an entity, just after values are written into storage. This is useful mostly when the business logic to be implemented always requires the entity identifier, even when storing a new entity. For instance, when implementing circular entity references, the referenced entity will be created on pre-save with a dummy value for the referring entity identifier, which will be updated with the actual one on post-save.

In the rare cases where item properties depend on the entity identifier, massaging logic will have to be implemented on post-save and returning TRUE will allow them to be rewritten to the storage with the updated values.

Defines custom delete behavior for field values.

This method is called during the process of deleting an entity, just before values are deleted from storage.

Generates placeholder field values.

Useful when populating site with placeholder content during site building or profiling.

Defines custom revision delete behavior for field values.

This method is called from during the process of deleting an entity revision, just before the field values are deleted from storage. It is only called for entity types that support revisioning.

Returns a form for the storage-level settings.

Invoked from \Drupal\field_ui\Form\FieldStorageConfigEditForm to allow administrators to configure storage-level settings.

Field storage might reject settings changes that affect the field storage schema if the storage already has data. When the $has_data parameter is TRUE, the form should not allow changing the settings that take part in the schema() method. It is recommended to set #access to FALSE on the corresponding elements.

Returns a form for the field-level settings.

Invoked from \Drupal\field_ui\Form\FieldConfigEditForm to allow administrators to configure field-level settings.

Returns a settings array that can be stored as a configuration value.

For all use cases where field settings are stored and managed as configuration, this method is used to map from the field type's representation of its settings to a representation compatible with deployable configuration. This includes:

• Array keys at any depth must not contain a ".".
• Ideally, array keys at any depth are either numeric or can be enumerated as a "mapping" within the configuration schema. While not strictly required, this simplifies configuration translation UIs, configuration migrations between Drupal versions, and other use cases.
• To support configuration deployments, references to content entities must use UUIDs rather than local IDs.

An example of a conversion between representations might be an "allowed_values" setting that's structured by the field type as a \Drupal\Core\TypedData\OptionsProviderInterface::getPossibleOptions() result (i.e., values as keys and labels as values). For such a use case, in order to comply with the above, this method could convert that representation to a numerically indexed array whose values are sub-arrays with the schema definable keys of "value" and "label".

Returns a settings array in the field type's canonical representation.

This function does the inverse of static::storageSettingsToConfigData(). It's called when loading a field's settings from a configuration object.

Returns a settings array that can be stored as a configuration value.

Same as static::storageSettingsToConfigData(), but for the field's settings.

Returns a settings array in the field type's canonical representation.

This function does the inverse of static::fieldSettingsToConfigData(). It's called when loading a field's settings from a configuration object.

Calculates dependencies for field items.

Dependencies are saved in the field configuration entity and are used to determine configuration synchronization order. For example, if the field type's default value is a content entity, this method should return an array of dependencies listing the content entities.

Calculates dependencies for field items on the storage level.

Dependencies are saved in the field storage configuration entity and are used to determine configuration synchronization order. For example, if the field type storage depends on a particular entity type, this method should return an array of dependencies listing the module that provides the entity type.

Dependencies returned from this method are stored in field storage configuration and are always considered hard dependencies. If the dependency is removed the field storage configuration must be deleted.

Informs the plugin that a dependency of the field will be deleted.

Defines field item properties.

Properties that are required to constitute a valid, non-empty item should be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().

Returns the schema for the field.

This method is static because the field schema information is needed on creation of the field. FieldItemInterface objects instantiated at that time are not reliable as field settings might be missing.

Computed fields having no schema should return an empty array.

Gets a bundle for a given entity type and selection options.

Form element validation handler; Invokes selection plugin's validation.

Determines whether the item holds an unsaved entity.

This is notably used for "autocreate" widgets, and more generally to support referencing freshly created entities (they will get saved automatically as the hosting entity gets saved).

Returns an array of possible values.

If the optional $account parameter is passed, then the array is filtered to values viewable by the account.

Returns an array of possible values with labels for display.

If the optional $account parameter is passed, then the array is filtered to values viewable by the account.

Returns an array of settable values.

If the optional $account parameter is passed, then the array is filtered to values settable by the account.

Returns an array of settable values with labels for display.

If the optional $account parameter is passed, then the array is filtered to values settable by the account.

Render API callback: Processes the field settings form.

Allows access to the form state.

Adds entity_reference specific properties to AJAX form elements from the field settings form.

Render API callback: Moves entity_reference specific Form API elements (i.e. 'handler_settings') up a level for easier processing by the validation and submission handlers.

Ajax callback for the handler settings form.

Submit handler for the non-JS case.

Returns preconfigured field options for a field type.

Note that if you want to give modules an opportunity to alter the result of this method, you should call \Drupal\Core\Field\FieldTypePluginManagerInterface::getPreconfiguredOptions() instead.

Form API callback.

Removes slashes from the beginning and end of the destination value and ensures that the file directory path is not included at the beginning of the value.

This function is assigned as an #element_validate callback in fieldSettingsForm().

Form API callback.

This function is assigned as an #element_validate callback in fieldSettingsForm().

This doubles as a convenience clean-up function and a validation routine. Commas are allowed by the end-user, but ultimately the value will be stored as a space-separated list for compatibility with file_validate_extensions().

Form API callback.

Ensures that a size has been entered and that it can be parsed by \Drupal\Component\Utility\Bytes::toNumber().

This function is assigned as an #element_validate callback in fieldSettingsForm().

Determines the URI for a file field.

Determines the URI for a file field.

Retrieves the upload validators for a file field.

Determines whether an item should be displayed when rendering the field.