You are here

Home » API reference » Feeds 8.3 » Image.php

class Image in Feeds 8.3

Defines a file field mapper.

Plugin annotation


@FeedsTarget(
  id = "image",
  field_types = {"image"}
)

Hierarchy

Expanded class hierarchy of Image

2 files declare their use of Image
ImageTest.php in tests/src/Unit/Feeds/Target/ImageTest.php
ImageTest.php in tests/src/Kernel/Feeds/Target/ImageTest.php

File

src/Feeds/Target/Image.php, line 16

Namespace

Drupal\feeds\Feeds\Target
View source 
class Image extends File {

  /**
   * {@inheritdoc}
   */
  protected static function prepareTarget(FieldDefinitionInterface $field_definition) {
    return FieldTargetDefinition::createFromFieldDefinition($field_definition)
      ->addProperty('target_id')
      ->addProperty('alt')
      ->addProperty('title');
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareValue($delta, array &$values) {
    foreach ($values as $column => $value) {
      switch ($column) {
        case 'target_id':
          $values[$column] = $this
            ->getFile($value);
          break;
        default:
          $values[$column] = (string) $value;
          break;
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurablePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
EntityReference::$entityFieldManager protected property The entity field manager.
EntityReference::$entityFinder protected property The Feeds entity finder service.
EntityReference::$entityTypeManager protected property The entity type manager.
EntityReference::findEntities protected function Tries to lookup an existing entity.
EntityReference::findEntity protected function Searches for an entity by entity key.
EntityReference::getBundleKey protected function Returns the entity type's bundle key.
EntityReference::getFeedsItemOptions public function Returns options for feeds_item configuration.
EntityReference::getLabelKey protected function Returns the entity type's label key.
EntityReference::getLangcodeKey protected function Returns the entity type's langcode key, if it has one.
EntityReference::getPotentialFields protected function Returns a list of fields that may be used to reference by.
EntityReference::setTarget public function Sets the values on an object. Overrides FieldTargetBase::setTarget
FieldTargetBase::$fieldSettings protected property The field settings.
FieldTargetBase::$languageManager protected property The language manager.
FieldTargetBase::addMessage protected function Adds a message.
FieldTargetBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
FieldTargetBase::getEntityTarget public function Get entity, or entity translation to set the map.
FieldTargetBase::getLangcode public function Gets the configured language. Overrides TranslatableTargetInterface::getLangcode
FieldTargetBase::getLanguageManager protected function Gets the language manager.
FieldTargetBase::getMessenger protected function Returns the messenger to use.
FieldTargetBase::getUniqueQuery protected function Constructs a base query which is used to find an existing entity.
FieldTargetBase::getUniqueValue public function Looks for an existing entity and returns an entity ID if found.
FieldTargetBase::isEmpty public function Returns if the value for the target is empty. Overrides TargetInterface::isEmpty
FieldTargetBase::isMutable public function Returns if the target is mutable. Overrides TargetInterface::isMutable 1
FieldTargetBase::isTargetFieldTranslatable protected function Checks if the targeted field is translatable.
FieldTargetBase::isTargetTranslatable public function Checks if the target is translatable. Overrides TranslatableTargetInterface::isTargetTranslatable
FieldTargetBase::languageExists public function Checks if the language selected on the target exists. Overrides TranslatableTargetInterface::languageExists
FieldTargetBase::onDependencyRemoval public function Allows a plugin to define whether it should be removed. Overrides TargetBase::onDependencyRemoval
FieldTargetBase::prepareValues protected function Prepares the the values that will be mapped to an entity.
FieldTargetBase::setLanguageManager public function Sets the language manager.
FieldTargetBase::targets public static function Returns the targets defined by this plugin. Overrides TargetInterface::targets 1
File::$client protected property The http client.
File::$fileExtensions protected property The list of allowed file extensions.
File::$fileSystem protected property The file and stream wrapper helper.
File::$token protected property Token service.
File::buildConfigurationForm public function @todo Inject $user. Overrides EntityReference::buildConfigurationForm
File::create public static function Creates an instance of the plugin. Overrides EntityReference::create
File::createEntity protected function Creates a new entity with the given label and saves it. Overrides EntityReference::createEntity
File::defaultConfiguration public function Gets default configuration for this plugin. Overrides EntityReference::defaultConfiguration
File::filterFieldTypes protected function Filesize and MIME-type aren't sensible fields to match on so these are filtered out. Overrides EntityReference::filterFieldTypes
File::getBundles protected function The file entity doesn't support any bundles. Providing an empty array here will prevent the bundle check from being added in the find entity query. Overrides EntityReference::getBundles
File::getContent protected function Attempts to download the file at the given url.
File::getDestinationDirectory protected function Prepares destination directory and returns its path.
File::getEntityType protected function Returns the entity type to reference. Overrides EntityReference::getEntityType
File::getFile protected function Returns a file id given a url.
File::getFileName protected function Extracts the file name from the given url and checks for valid extension.
File::getSummary public function Returns the summary for a target. Overrides EntityReference::getSummary
File::__construct public function Constructs a File object. Overrides EntityReference::__construct
Image::prepareTarget protected static function Prepares a target definition. Overrides File::prepareTarget
Image::prepareValue protected function Prepares a single value. Overrides File::prepareValue
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$feedType protected property The importer this plugin is working for.
PluginBase::$linkGenerator protected property The link generator.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$urlGenerator protected property The url generator.
PluginBase::container private function Returns the service container.
PluginBase::defaultFeedConfiguration public function Returns default feed configuration. Overrides FeedsPluginInterface::defaultFeedConfiguration 3
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::l protected function Renders a link to a route given a route name and its parameters.
PluginBase::linkGenerator protected function Returns the link generator service.
PluginBase::onFeedDeleteMultiple public function A feed is being deleted. 3
PluginBase::onFeedSave public function A feed is being saved.
PluginBase::onFeedTypeDelete public function The feed type is being deleted. 1
PluginBase::onFeedTypeSave public function The feed type is being saved. 1
PluginBase::pluginType public function Returns the type of plugin. Overrides FeedsPluginInterface::pluginType
PluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
PluginBase::url protected function Generates a URL or path for a specific route based on the given parameters.
PluginBase::urlGenerator protected function Returns the URL generator service.
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.
TargetBase::$targetDefinition protected property The target definition.
TargetBase::getTargetDefinition public function Returns the target's definition. Overrides TargetInterface::getTargetDefinition
TargetBase::submitConfigurationForm public function Form submission handler. Overrides ConfigurablePluginBase::submitConfigurationForm