class FileUriItem

File-specific plugin implementation of a URI item to provide a full URL.

Plugin annotation

@FieldType(
  id = "file_uri",
  label = @Translation("File URI"),
  description = @Translation("An entity field containing a file URI, and a computed root-relative file URL."),
  no_ui = TRUE,
  default_formatter = "file_uri",
  default_widget = "uri",
)

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
  • class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ComplexDataInterface extends \Drupal\Core\TypedData\TypedData
    • class \Drupal\Core\Field\FieldItemBase implements \Drupal\Core\Field\FieldItemInterface extends \Drupal\Core\TypedData\Plugin\DataType\Map
      • class \Drupal\Core\Field\Plugin\Field\FieldType\StringItemBase extends \Drupal\Core\Field\FieldItemBase
        • class \Drupal\Core\Field\Plugin\Field\FieldType\StringItem extends \Drupal\Core\Field\Plugin\Field\FieldType\StringItemBase
          • class \Drupal\Core\Field\Plugin\Field\FieldType\UriItem extends \Drupal\Core\Field\Plugin\Field\FieldType\StringItem
            • class \Drupal\file\Plugin\Field\FieldType\FileUriItem extends \Drupal\Core\Field\Plugin\Field\FieldType\UriItem

Expanded class hierarchy of FileUriItem

File

core/modules/file/src/Plugin/Field/FieldType/FileUriItem.php, line 22

Namespace

class FileUriItem extends UriItem {
  
  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties = parent::propertyDefinitions($field_definition);
    $properties['url'] = DataDefinition::create('string')->setLabel(t('Root-relative file URL'))
      ->setComputed(TRUE)
      ->setInternal(FALSE)
      ->setClass(ComputedFileUrl::class);
    return $properties;
  }

}

Members