interface FeedsEntityProcessorPropertyInterface in Feeds entity processor 7

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".

Hierarchy

• interface \FeedsEntityProcessorPropertyInterface

File

src/Property/FeedsEntityProcessorPropertyInterface.php, line 17

Contains FeedsEntityProcessorPropertyInterface.

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);

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsEntityProcessorPropertyInterface::entityWrapper	public	function	Returns entity metata wrapper.	1
FeedsEntityProcessorPropertyInterface::getFormField	public	function	Returns a field to insert a value for the property.	1
FeedsEntityProcessorPropertyInterface::getMappingTarget	public	function	Returns a mapping target.	1
FeedsEntityProcessorPropertyInterface::getName	public	function	Returns the property's name.	1
FeedsEntityProcessorPropertyInterface::getProcessor	public	function	Returns the processor that is processing the data.	1
FeedsEntityProcessorPropertyInterface::getPropertyInfo	public	function	Returns info about the property.	1
FeedsEntityProcessorPropertyInterface::setValue	public	function	Sets a value on the entity.	1
FeedsEntityProcessorPropertyInterface::validate	public	function	Validates the value for the property.	1