You are here

Home » API reference » Remote image 8 » RemoteImageItem.php

class RemoteImageItem in Remote image 8

Plugin implementation of the 'remote_image' field type.

Plugin annotation


@FieldType(
  id = "remote_image",
  label = @Translation("Remote Image"),
  description = @Translation("Provides an external link as a field with some meta-data."),
  category = @Translation("Reference"),
  default_widget = "remote_image",
  default_formatter = "remote_image",
  constraints = {"LinkType" = {}, "LinkAccess" = {}, "LinkExternalProtocols" = {}, "LinkNotExistingInternal" = {}}
)

Hierarchy

Expanded class hierarchy of RemoteImageItem

File

src/Plugin/Field/FieldType/RemoteImageItem.php, line 31
Contains Drupal\remote_image\Plugin\Field\FieldType\RemoteImageField.

Namespace

Drupal\remote_image\Plugin\Field\FieldType
View source 
class RemoteImageItem extends LinkItem {

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {

    // Add image settings to the default link settings.
    return [
      'alt_field' => 1,
      'alt_field_required' => 0,
      'title_field' => 1,
      'title_field_required' => 0,
    ] + array_diff_key(parent::defaultFieldSettings(), [
      'title' => FALSE,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {

    // Get base form from LinkItem.
    $element = array_diff_key(parent::fieldSettingsForm($form, $form_state), [
      'title' => FALSE,
    ]);
    $element['link_type']['#weight'] = 8;
    $settings = $this
      ->getSettings();

    // Add title and alt configuration options.
    $element['alt_field'] = array(
      '#type' => 'checkbox',
      '#title' => t('Enable <em>Alt</em> field'),
      '#default_value' => $settings['alt_field'],
      '#description' => t('The alt attribute may be used by search engines, screen readers, and when the image cannot be loaded. Enabling this field is recommended.'),
      '#weight' => 9,
    );
    $element['alt_field_required'] = array(
      '#type' => 'checkbox',
      '#title' => t('<em>Alt</em> field required'),
      '#default_value' => $settings['alt_field_required'],
      '#description' => t('Making this field required is recommended.'),
      '#weight' => 10,
      '#states' => array(
        'visible' => array(
          ':input[name="settings[alt_field]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $element['title_field'] = array(
      '#type' => 'checkbox',
      '#title' => t('Enable <em>Title</em> field'),
      '#default_value' => $settings['title_field'],
      '#description' => t('The title attribute is used as a tooltip when the mouse hovers over the image. Enabling this field is not recommended as it can cause problems with screen readers.'),
      '#weight' => 11,
    );
    $element['title_field_required'] = array(
      '#type' => 'checkbox',
      '#title' => t('<em>Title</em> field required'),
      '#default_value' => $settings['title_field_required'],
      '#weight' => 12,
      '#states' => array(
        'visible' => array(
          ':input[name="settings[title_field]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    return $element;
  }

  /**
   * Builds the default_image details element.
   *
   * @param array $element
   *   The form associative array passed by reference.
   * @param array $settings
   *   The field settings array.
   */
  protected function defaultImageForm(array &$element, array $settings) {

    // Add the default image form element.
    // @todo Add url validation @see \Drupal\link\Plugin\Field\FieldWidget\LinkWidget.
    // @todo Add autocomplete for internal urls @see \Drupal\link\Plugin\Field\FieldWidget\LinkWidget.
    // @todo Figure out why default width and height won't save.
    $element['default_image'] = [
      '#type' => 'details',
      '#title' => t('Default image'),
      '#open' => TRUE,
      'uri' => [
        '#type' => 'url',
        '#title' => $this
          ->t('Default image URL'),
        '#default_value' => $settings['default_image']['uri'],
        '#maxlength' => 2048,
        '#description' => $this
          ->t('The URL of the remote image.'),
      ],
      'alt' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Alternative text'),
        '#description' => $this
          ->t('This text will be used by screen readers, search engines, and when the image cannot be loaded.'),
        '#default_value' => $settings['default_image']['alt'],
        '#maxlength' => 512,
      ],
      'title' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Title'),
        '#description' => t('The title attribute is used as a tooltip when the mouse hovers over the image.'),
        '#default_value' => $settings['default_image']['title'],
        '#maxlength' => 1024,
      ],
      'width' => [
        '#type' => 'number',
        '#title' => $this
          ->t('Width'),
        '#description' => t('The width of the image'),
        '#value' => $settings['default_image']['width'],
      ],
      'height' => [
        '#type' => 'number',
        '#title' => $this
          ->t('Height'),
        '#description' => t('The height of the image.'),
        '#value' => $settings['default_image']['height'],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    return [
      'alt' => DataDefinition::create('string')
        ->setLabel(t('Alternative text'))
        ->setDescription(t("Alternative image text, for the image's 'alt' attribute.")),
      'title' => DataDefinition::create('string')
        ->setLabel(t('Title'))
        ->setDescription(t("Image title text, for the image's 'title' attribute.")),
      'width' => DataDefinition::create('integer')
        ->setLabel(t('Width'))
        ->setDescription(t('The width of the image in pixels.')),
      'height' => DataDefinition::create('integer')
        ->setLabel(t('Height'))
        ->setDescription(t('The height of the image in pixels.')),
    ] + parent::propertyDefinitions($field_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    $schema = parent::schema($field_definition);
    $schema['columns'] = [
      'alt' => array(
        'description' => "Alternative image text, for the image's 'alt' attribute.",
        'type' => 'varchar',
        'length' => 512,
      ),
      'title' => array(
        'description' => "Image title text, for the image's 'title' attribute.",
        'type' => 'varchar',
        'length' => 1024,
      ),
      'width' => array(
        'description' => 'The width of the image in pixels.',
        'type' => 'int',
        'unsigned' => TRUE,
      ),
      'height' => array(
        'description' => 'The height of the image in pixels.',
        'type' => 'int',
        'unsigned' => TRUE,
      ),
    ] + $schema['columns'];
    return $schema;
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {

    // @todo: respect the remote image settings here.
    // Generate random dimensions.
    $width = mt_rand(100, 1024);
    $height = mt_rand(100, 1024);

    // Use \Drupal\Component\Utility\Random.
    $random = new Random();
    return [
      'uri' => "http://placehold.it/{$width}x{$height}",
      'alt' => $random
        ->sentences(4),
      'title' => $random
        ->sentences(4),
      'width' => $width,
      'height' => $height,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $value = $this
      ->get('uri')
      ->getValue();
    return $value === NULL || $value === '';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FieldItemBase::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies 1
FieldItemBase::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings 10
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::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::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval 1
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 7
FieldItemBase::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm 8
FieldItemBase::storageSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData 2
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 1
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
LinkItem::getUrl public function Gets the URL object. Overrides LinkItemInterface::getUrl
LinkItem::isExternal public function Determines if a link is external. Overrides LinkItemInterface::isExternal
LinkItem::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
LinkItem::setValue public function Sets the data value. Overrides FieldItemBase::setValue
LinkItemInterface::LINK_EXTERNAL constant Specifies whether the field supports only external URLs.
LinkItemInterface::LINK_GENERIC constant Specifies whether the field supports both internal and external URLs.
LinkItemInterface::LINK_INTERNAL constant Specifies whether the field supports only internal URLs.
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::applyDefaultValue public function Applies the default value. Overrides TypedData::applyDefaultValue 4
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 1
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 4
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.
RemoteImageItem::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides LinkItem::defaultFieldSettings
RemoteImageItem::defaultImageForm protected function Builds the default_image details element.
RemoteImageItem::fieldSettingsForm public function Returns a form for the field-level settings. Overrides LinkItem::fieldSettingsForm
RemoteImageItem::generateSampleValue public static function Generates placeholder field values. Overrides LinkItem::generateSampleValue
RemoteImageItem::isEmpty public function Determines whether the data structure is empty. Overrides LinkItem::isEmpty
RemoteImageItem::propertyDefinitions public static function Defines field item properties. Overrides LinkItem::propertyDefinitions
RemoteImageItem::schema public static function Returns the schema for the field. Overrides LinkItem::schema
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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::$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 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::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