interface BundlePluginHandlerInterface in Entity API 8

Handles plugin-provided bundles.

Hierarchy

• interface \Drupal\Core\Entity\EntityHandlerInterface
  • interface \Drupal\entity\BundlePlugin\BundlePluginHandlerInterface

File

src/BundlePlugin/BundlePluginHandlerInterface.php, line 10

Namespace

Drupal\entity\BundlePlugin

interface BundlePluginHandlerInterface extends EntityHandlerInterface {

  /**
   * Gets the bundle info.
   *
   * @return array
   *   An array of bundle information keyed by the bundle name.
   *   The format expected by hook_entity_bundle_info().
   */
  public function getBundleInfo();

  /**
   * Gets the field storage definitions.
   */
  public function getFieldStorageDefinitions();

  /**
   * Gets the field definitions for a specific bundle.
   *
   * @param string $bundle
   *   The bundle name.
   *
   * @return \Drupal\entity\BundleFieldDefinition[]
   *   An array of bundle field definitions, keyed by field name.
   */
  public function getFieldDefinitions($bundle);

}

Members

Name	Modifiers	Type	Description	Overrides
BundlePluginHandlerInterface::getBundleInfo	public	function	Gets the bundle info.	1
BundlePluginHandlerInterface::getFieldDefinitions	public	function	Gets the field definitions for a specific bundle.	1
BundlePluginHandlerInterface::getFieldStorageDefinitions	public	function	Gets the field storage definitions.	1
EntityHandlerInterface::createInstance	public static	function	Instantiates a new instance of this entity handler.	13