class ComputedFileUrl

Same name in other branches
  1. 9 core/modules/file/src/ComputedFileUrl.php \Drupal\file\ComputedFileUrl
  2. 8.9.x core/modules/file/src/ComputedFileUrl.php \Drupal\file\ComputedFileUrl
  3. 10 core/modules/file/src/ComputedFileUrl.php \Drupal\file\ComputedFileUrl

Computed file URL property class.

Hierarchy

Expanded class hierarchy of ComputedFileUrl

2 files declare their use of ComputedFileUrl
ComputedFileUrlTest.php in core/modules/file/tests/src/Kernel/ComputedFileUrlTest.php
FileUriItem.php in core/modules/file/src/Plugin/Field/FieldType/FileUriItem.php

File

core/modules/file/src/ComputedFileUrl.php, line 10

Namespace

Drupal\file
View source 
class ComputedFileUrl extends TypedData {
    
    /**
     * Computed root-relative file URL.
     *
     * @var string
     */
    protected $url = NULL;
    
    /**
     * {@inheritdoc}
     */
    public function getValue() {
        if ($this->url !== NULL) {
            return $this->url;
        }
        assert($this->getParent()
            ->getEntity() instanceof FileInterface);
        $uri = $this->getParent()
            ->getEntity()
            ->getFileUri();
        
        /** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
        $file_url_generator = \Drupal::service('file_url_generator');
        $this->url = $file_url_generator->generateString($uri);
        return $this->url;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setValue($value, $notify = TRUE) {
        $this->url = $value;
        // Notify the parent of any changes.
        if ($notify && isset($this->parent)) {
            $this->parent
                ->onChange($this->name);
        }
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ComputedFileUrl::$url protected property Computed root-relative file URL.
ComputedFileUrl::getValue public function Gets the data value. Overrides TypedData::getValue
ComputedFileUrl::setValue public function Sets the data value. Overrides TypedData::setValue
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.
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 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::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
TypedData::__construct public function Constructs a TypedData object given its definition and context. 4
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.