interface EntityProviderInterface in Crop API 8

Defines the interface for entity provider integration plugin.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\crop\EntityProviderInterface

File

src/EntityProviderInterface.php, line 11

Namespace

Drupal\crop

interface EntityProviderInterface extends PluginInspectionInterface {

  /**
   * Returns the selection display label.
   *
   * @return string
   *   The selection display label.
   */
  public function label();

  /**
   * Gets URI of the image file.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   Entity being cropping.
   *
   * @return string|false
   *   URI as string or FALSE
   */
  public function uri(EntityInterface $entity);

}

Members

Name	Modifiers	Type	Description	Overrides
EntityProviderInterface::label	public	function	Returns the selection display label.	1
EntityProviderInterface::uri	public	function	Gets URI of the image file.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2