You are here

interface ResourceFieldEntityInterface in RESTful 7.2

Hierarchy

Expanded class hierarchy of ResourceFieldEntityInterface

All classes that implement ResourceFieldEntityInterface

File

src/Plugin/resource/Field/ResourceFieldEntityInterface.php, line 10
Contains \Drupal\restful\Plugin\resource\Field\ResourceFieldEntityInterface.

Namespace

Drupal\restful\Plugin\resource\Field
View source
interface ResourceFieldEntityInterface extends ResourceFieldInterface {

  /**
   * Decorate the object.
   *
   * @param ResourceFieldInterface $decorated
   *   The decorated subject.
   */
  public function decorate(ResourceFieldInterface $decorated);

  /**
   * @return string
   */
  public function getSubProperty();

  /**
   * @param string $sub_property
   */
  public function setSubProperty($sub_property);

  /**
   * @return string
   */
  public function getFormatter();

  /**
   * @param array $formatter
   */
  public function setFormatter($formatter);

  /**
   * @return string
   */
  public function getWrapperMethod();

  /**
   * @param string $wrapper_method
   */
  public function setWrapperMethod($wrapper_method);

  /**
   * @return boolean
   */
  public function isWrapperMethodOnEntity();

  /**
   * @param boolean $wrapper_method_on_entity
   */
  public function setWrapperMethodOnEntity($wrapper_method_on_entity);

  /**
   * @return string
   */
  public function getColumn();

  /**
   * @param string $column
   */
  public function setColumn($column);

  /**
   * @return array
   */
  public function getImageStyles();

  /**
   * @param array $image_styles
   */
  public function setImageStyles($image_styles);

  /**
   * @return string
   */
  public function getEntityType();

  /**
   * @param string $entity_type
   */
  public function setEntityType($entity_type);

  /**
   * @return string
   */
  public function getBundle();

  /**
   * @param string $bundle
   */
  public function setBundle($bundle);

  /**
   * Get the image URLs based on the configured image styles.
   *
   * @param array $file_array
   *   The file array.
   * @param array $image_styles
   *   The list of image styles to use.
   *
   * @return array
   *   The input file array with an extra key for the image styles.
   */
  public static function getImageUris(array $file_array, $image_styles);

  /**
   * Checks if a given string represents a Field API field.
   *
   * @param string $name
   *   The name of the field/property.
   *
   * @return bool
   *   TRUE if it's a field. FALSE otherwise.
   */
  public static function propertyIsField($name);

  /**
   * Massage the value to set according to the format expected by the wrapper.
   *
   * @param mixed $value
   *   The value passed in the request.
   *
   * @return mixed
   *   The value to set using the wrapped property.
   */
  public function preprocess($value);

}

Members

Namesort descending Modifiers Type Description Overrides
ResourceFieldEntityInterface::decorate public function Decorate the object. 1
ResourceFieldEntityInterface::getBundle public function 1
ResourceFieldEntityInterface::getColumn public function 1
ResourceFieldEntityInterface::getEntityType public function 1
ResourceFieldEntityInterface::getFormatter public function 1
ResourceFieldEntityInterface::getImageStyles public function 1
ResourceFieldEntityInterface::getImageUris public static function Get the image URLs based on the configured image styles. 1
ResourceFieldEntityInterface::getSubProperty public function 1
ResourceFieldEntityInterface::getWrapperMethod public function 1
ResourceFieldEntityInterface::isWrapperMethodOnEntity public function 1
ResourceFieldEntityInterface::preprocess public function Massage the value to set according to the format expected by the wrapper. 1
ResourceFieldEntityInterface::propertyIsField public static function Checks if a given string represents a Field API field. 1
ResourceFieldEntityInterface::setBundle public function 1
ResourceFieldEntityInterface::setColumn public function 1
ResourceFieldEntityInterface::setEntityType public function 1
ResourceFieldEntityInterface::setFormatter public function 1
ResourceFieldEntityInterface::setImageStyles public function 1
ResourceFieldEntityInterface::setSubProperty public function 1
ResourceFieldEntityInterface::setWrapperMethod public function 1
ResourceFieldEntityInterface::setWrapperMethodOnEntity public function 1
ResourceFieldInterface::access public function Check access on property by the defined access callbacks. 3
ResourceFieldInterface::addDefaults public function Adds the default values to the definitions array. 3
ResourceFieldInterface::addMetadata public function Add metadata to the field. 3
ResourceFieldInterface::compoundDocumentId public function Fetches the embedded identifier(s) for the current resource field, if any. 3
ResourceFieldInterface::create public static function Factory. 3
ResourceFieldInterface::executeProcessCallbacks public function Executes the process callbacks. 3
ResourceFieldInterface::getAccessCallbacks public function 3
ResourceFieldInterface::getCallback public function 3
ResourceFieldInterface::getCardinality public function Gets the cardinality of the wrapped field. 3
ResourceFieldInterface::getDefinition public function Gets the original field definition as declared in Resource::publicFields(). 3
ResourceFieldInterface::getMetadata public function Add metadata to the field. 3
ResourceFieldInterface::getMethods public function 3
ResourceFieldInterface::getProcessCallbacks public function 3
ResourceFieldInterface::getProperty public function 3
ResourceFieldInterface::getPublicFieldInfo public function Gets the public field info object. 3
ResourceFieldInterface::getPublicName public function 3
ResourceFieldInterface::getRequest public function Get the request in the data provider. 3
ResourceFieldInterface::getResource public function 3
ResourceFieldInterface::id public function Gets the ID of the resource field. 3
ResourceFieldInterface::isArrayNumeric public static function Helper method to determine if an array is numeric. 3
ResourceFieldInterface::isComputed public function Checks if the current field is computed. 3
ResourceFieldInterface::render public function Gets the value of a field and applies all process callbacks to it. 3
ResourceFieldInterface::set public function Gets the value for the field given a data source. 3
ResourceFieldInterface::setAccessCallbacks public function 3
ResourceFieldInterface::setCallback public function 3
ResourceFieldInterface::setCardinality public function Set the cardinality. 3
ResourceFieldInterface::setMethods public function 3
ResourceFieldInterface::setProcessCallbacks public function 3
ResourceFieldInterface::setProperty public function 3
ResourceFieldInterface::setPublicFieldInfo public function Gets the public field info object. 3
ResourceFieldInterface::setPublicName public function 3
ResourceFieldInterface::setRequest public function Set the request. 3
ResourceFieldInterface::setResource public function 3
ResourceFieldInterface::value public function Gets the value for the field given a data source. 3