class ComputedString

Same name in other branches
  1. 9 core/modules/system/tests/modules/entity_test/src/TypedData/ComputedString.php \Drupal\entity_test\TypedData\ComputedString
  2. 10 core/modules/system/tests/modules/entity_test/src/TypedData/ComputedString.php \Drupal\entity_test\TypedData\ComputedString
  3. 11.x core/modules/system/tests/modules/entity_test/src/TypedData/ComputedString.php \Drupal\entity_test\TypedData\ComputedString

A computed property for test strings.

Hierarchy

Expanded class hierarchy of ComputedString

1 file declares its use of ComputedString
InternalPropertyTestFieldItem.php in core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/InternalPropertyTestFieldItem.php

File

core/modules/system/tests/modules/entity_test/src/TypedData/ComputedString.php, line 12

Namespace

Drupal\entity_test\TypedData
View source 
class ComputedString extends TypedData implements CacheableDependencyInterface {
    
    /**
     * {@inheritdoc}
     */
    public function getValue() {
        
        /** @var \Drupal\Core\Field\FieldItemInterface $item */
        $item = $this->getParent();
        $computed_value = "Computed! " . $item->get('value')
            ->getString();
        return $computed_value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCastedValue() {
        return $this->getString();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        return [
            'you_are_it',
            'no_tag_backs',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        return [
            'request_format',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheMaxAge() {
        return Cache::PERMANENT;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ComputedString::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
ComputedString::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
ComputedString::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ComputedString::getCastedValue public function
ComputedString::getValue public function Gets the data value. Overrides TypedData::getValue
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
TypedData::$definition protected property The data definition. 1
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::applyDefaultValue public function Applies the default value. Overrides TypedDataInterface::applyDefaultValue 3
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 9
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::getString public function Returns a string representation of the data. Overrides TypedDataInterface::getString 6
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::setValue public function Sets the data value. Overrides TypedDataInterface::setValue 10
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct public function Constructs a TypedData object given its definition and context. 3
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.