FeedsEntityProcessorPropertyInterface.php in Feeds entity processor 7

Contains FeedsEntityProcessorPropertyInterface.

File

src/Property/FeedsEntityProcessorPropertyInterface.php

<?php

/**
 * @file
 * Contains FeedsEntityProcessorPropertyInterface.
 */

/**
 * An interface for a Feeds entity property plugin.
 *
 * Feeds entity property plugins are used to import and convert values through
 * Feeds for certain entity property types. This way, the Feeds entity processor
 * can treat different data types differently. For example, values for a date
 * property may need to be converted from a particular date format to a
 * timestamp, like "Y-m-d\TH:i:s".
 */
interface FeedsEntityProcessorPropertyInterface {

  /**
   * Returns the property's name.
   *
   * @return string
   *   The property name.
   */
  public function getName();

  /**
   * Returns info about the property.
   *
   * @return array
   *   The property info.
   */
  public function getPropertyInfo();

  /**
   * Returns entity metata wrapper.
   *
   * @return EntityMetadataWrapper
   *   An instance of EntityMetadataWrapper.
   */
  public function entityWrapper();

  /**
   * Returns the processor that is processing the data.
   *
   * @return FeedsProcessor
   *   An instance of FeedsProcessor.
   */
  public function getProcessor();

  /**
   * Returns a field to insert a value for the property.
   *
   * @param array $form
   *   The form in which the field will appear.
   * @param array $form_state
   *   The form state.
   * @param mixed $default
   *   The default value for the field.
   *
   * @return array
   *   A Drupal Form API field.
   */
  public function getFormField(array &$form, array &$form_state, $default);

  /**
   * Validates the value for the property.
   *
   * @param mixed $value
   *   The value to validate.
   *
   * @return array
   *   A list of errors, if there are errors.
   */
  public function validate(&$value);

  /**
   * Returns a mapping target.
   *
   * @return array
   *   The mapping target.
   */
  public function getMappingTarget();

  /**
   * Sets a value on the entity.
   *
   * @param mixed $value
   *   The value to set.
   * @param array $mapping
   *   Mapping configuration.
   */
  public function setValue($value, array $mapping);

}

Interfaces

Name	Description
FeedsEntityProcessorPropertyInterface	An interface for a Feeds entity property plugin.