class TextItemBase

Same name and namespace in other branches
  1. 9 core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php \Drupal\text\Plugin\Field\FieldType\TextItemBase
  2. 8.9.x core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php \Drupal\text\Plugin\Field\FieldType\TextItemBase
  3. 10 core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php \Drupal\text\Plugin\Field\FieldType\TextItemBase

Base class for 'text' configurable field types.

Hierarchy

Expanded class hierarchy of TextItemBase

3 files declare their use of TextItemBase
editor.module in core/modules/editor/editor.module
Adds bindings for client-side "text editors" to text formats.
TextItemBaseTest.php in core/modules/text/tests/src/Kernel/TextItemBaseTest.php
TextItemSillyNormalizer.php in core/modules/serialization/tests/modules/field_normalization_test/src/Normalization/TextItemSillyNormalizer.php

File

core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php, line 15

Namespace

Drupal\text\Plugin\Field\FieldType
View source
abstract class TextItemBase extends FieldItemBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultFieldSettings() {
        return [
            'allowed_formats' => [],
        ] + parent::defaultFieldSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
        $element = parent::fieldSettingsForm($form, $form_state);
        $settings = $this->getSettings();
        $element['allowed_formats'] = [
            '#type' => 'checkboxes',
            '#title' => $this->t('Allowed text formats'),
            '#options' => $this->get('format')
                ->getPossibleOptions(),
            '#default_value' => !empty($settings['allowed_formats']) ? $settings['allowed_formats'] : [],
            '#description' => $this->t('Select the allowed text formats. If no formats are selected, all available text formats will be displayed to the user.'),
            '#element_validate' => [
                [
                    static::class,
                    'validateAllowedFormats',
                ],
            ],
        ];
        return $element;
    }
    
    /**
     * Render API callback: Processes the allowed formats value.
     *
     * Ensure the element's value is an indexed array of selected format IDs.
     * This function is assigned as an #element_validate callback.
     *
     * @see static::fieldSettingsForm()
     */
    public static function validateAllowedFormats(array &$element, FormStateInterface $form_state) {
        $value = array_values(array_filter($form_state->getValue($element['#parents'])));
        $form_state->setValueForElement($element, $value);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function calculateDependencies(FieldDefinitionInterface $field_definition) {
        // Add explicitly allowed formats as config dependencies.
        $format_dependencies = [];
        $dependencies = parent::calculateDependencies($field_definition);
        if (!is_null($field_definition->getSetting('allowed_formats'))) {
            $format_dependencies = array_map(function (string $format_id) {
                return 'filter.format.' . $format_id;
            }, $field_definition->getSetting('allowed_formats'));
        }
        $config = $dependencies['config'] ?? [];
        $dependencies['config'] = array_merge($config, $format_dependencies);
        return $dependencies;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
        $properties['value'] = DataDefinition::create('string')->setLabel(t('Text'))
            ->setRequired(TRUE);
        $properties['format'] = DataDefinition::create('filter_format')->setLabel(t('Text format'))
            ->setSetting('allowed_formats', $field_definition->getSetting('allowed_formats'));
        $properties['processed'] = DataDefinition::create('string')->setLabel(t('Processed text'))
            ->setDescription(t('The text with the text format applied.'))
            ->setComputed(TRUE)
            ->setClass('\\Drupal\\text\\TextProcessed')
            ->setSetting('text source', 'value')
            ->setInternal(FALSE);
        return $properties;
    }
    
    /**
     * {@inheritdoc}
     */
    public function applyDefaultValue($notify = TRUE) {
        // @todo Add in the filter default format here.
        $this->setValue([
            'format' => NULL,
        ], $notify);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isEmpty() {
        $value = $this->get('value')
            ->getValue();
        return $value === NULL || $value === '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function onChange($property_name, $notify = TRUE) {
        // Unset processed properties that are affected by the change.
        foreach ($this->definition
            ->getPropertyDefinitions() as $property => $definition) {
            if ($definition->getClass() == '\\Drupal\\text\\TextProcessed') {
                if ($property_name == 'format' || $definition->getSetting('text source') == $property_name) {
                    $this->writePropertyValue($property, NULL);
                }
            }
        }
        parent::onChange($property_name, $notify);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
        $random = new Random();
        $settings = $field_definition->getSettings();
        if (empty($settings['max_length'])) {
            // Textarea handling
            $value = $random->paragraphs();
        }
        else {
            // Textfield handling.
            $max = ceil($settings['max_length'] / 3);
            $value = substr($random->sentences(mt_rand(1, $max), FALSE), 0, $settings['max_length']);
        }
        $values = [
            'value' => $value,
            'summary' => $value,
            'format' => filter_fallback_format(),
        ];
        return $values;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FieldItemBase::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies
FieldItemBase::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings 9
FieldItemBase::delete public function Defines custom delete behavior for field values. Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsSummary public static function Returns a short summary of the field's field-level settings. Overrides FieldItemInterface::fieldSettingsSummary
FieldItemBase::fieldSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting protected function Returns the value of a field setting.
FieldItemBase::getSettings protected function Returns the array of field settings.
FieldItemBase::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval
FieldItemBase::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave 2
FieldItemBase::preSave public function Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave 6
FieldItemBase::setValue public function Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides Map::setValue 3
FieldItemBase::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm 7
FieldItemBase::storageSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsSummary public static function Returns a short summary of the field's storage-level settings. Overrides FieldItemInterface::storageSettingsSummary
FieldItemBase::storageSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue protected function Different to the parent Map class, we avoid creating property objects as
far as possible in order to optimize performance. Thus we just update
$this->values if no property object has been created yet.
Overrides Map::writePropertyValue
FieldItemBase::__construct public function Constructs a TypedData object given its definition and context. Overrides TypedData::__construct 2
FieldItemBase::__get public function Magic method: Gets a property value. Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Magic method: Sets a property value. Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Magic method: Unsets a property. Overrides FieldItemInterface::__unset
FieldItemInterface::schema public static function Returns the schema for the field. 32
Map::$definition protected property The data definition. Overrides TypedData::$definition
Map::$properties protected property The array of properties.
Map::$values protected property An array of values for the contained properties.
Map::get public function Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator public function
Map::getProperties public function Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString public function Returns a string representation of the data. Overrides TypedData::getString
Map::getValue public function Gets the data value. Overrides TypedData::getValue
Map::set public function Sets a property value. Overrides ComplexDataInterface::set
Map::toArray public function Returns an array of all property values. Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TextItemBase::applyDefaultValue public function Applies the default value. Overrides Map::applyDefaultValue
TextItemBase::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemBase::calculateDependencies
TextItemBase::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings 1
TextItemBase::fieldSettingsForm public function Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm 1
TextItemBase::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
TextItemBase::isEmpty public function Determines whether the data structure is empty. Overrides Map::isEmpty 1
TextItemBase::onChange public function React to changes to a child property or item. Overrides Map::onChange
TextItemBase::propertyDefinitions public static function Defines field item properties. Overrides FieldItemInterface::propertyDefinitions 1
TextItemBase::validateAllowedFormats public static function Render API callback: Processes the allowed formats value.
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints public function Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints 8
TypedData::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent public function Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.