class TextProcessed

Same name in other branches
  1. 8.9.x core/modules/text/src/TextProcessed.php \Drupal\text\TextProcessed
  2. 10 core/modules/text/src/TextProcessed.php \Drupal\text\TextProcessed
  3. 11.x core/modules/text/src/TextProcessed.php \Drupal\text\TextProcessed

A computed property for processing text with a format.

Required settings (below the definition's 'settings' key) are:

  • text source: The text property containing the to be processed text.

Hierarchy

Expanded class hierarchy of TextProcessed

File

core/modules/text/src/TextProcessed.php, line 18

Namespace

Drupal\text
View source
class TextProcessed extends TypedData implements CacheableDependencyInterface {
    
    /**
     * Cached processed text.
     *
     * @var \Drupal\filter\FilterProcessResult|null
     */
    protected $processed = NULL;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(DataDefinitionInterface $definition, $name = NULL, TypedDataInterface $parent = NULL) {
        parent::__construct($definition, $name, $parent);
        if ($definition->getSetting('text source') === NULL) {
            throw new \InvalidArgumentException("The definition's 'text source' key has to specify the name of the text property to be processed.");
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getValue() {
        if ($this->processed !== NULL) {
            return FilteredMarkup::create($this->processed
                ->getProcessedText());
        }
        $item = $this->getParent();
        $text = $item->{$this->definition
            ->getSetting('text source')};
        // Avoid doing unnecessary work on empty strings.
        if (!isset($text) || $text === '') {
            $this->processed = new FilterProcessResult('');
        }
        else {
            $build = [
                '#type' => 'processed_text',
                '#text' => $text,
                '#format' => $item->format,
                '#filter_types_to_skip' => [],
                '#langcode' => $item->getLangcode(),
            ];
            // Capture the cacheability metadata associated with the processed text.
            $processed_text = $this->getRenderer()
                ->renderPlain($build);
            $this->processed = FilterProcessResult::createFromRenderArray($build)->setProcessedText((string) $processed_text);
        }
        return FilteredMarkup::create($this->processed
            ->getProcessedText());
    }
    
    /**
     * {@inheritdoc}
     */
    public function setValue($value, $notify = TRUE) {
        $this->processed = $value;
        // Notify the parent of any changes.
        if ($notify && isset($this->parent)) {
            $this->parent
                ->onChange($this->name);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        $this->getValue();
        return $this->processed
            ->getCacheTags();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        $this->getValue();
        return $this->processed
            ->getCacheContexts();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheMaxAge() {
        $this->getValue();
        return $this->processed
            ->getCacheMaxAge();
    }
    
    /**
     * Returns the renderer service.
     *
     * @return \Drupal\Core\Render\RendererInterface
     */
    protected function getRenderer() {
        return \Drupal::service('renderer');
    }

}

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
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.
TextProcessed::$processed protected property Cached processed text.
TextProcessed::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
TextProcessed::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
TextProcessed::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
TextProcessed::getRenderer protected function Returns the renderer service.
TextProcessed::getValue public function Gets the data value. Overrides TypedData::getValue
TextProcessed::setValue public function Sets the data value. Overrides TypedData::setValue
TextProcessed::__construct public function Constructs a TypedData object given its definition and context. Overrides TypedData::__construct
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::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.