interface BundleEntityStorageInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/BundleEntityStorageInterface.php \Drupal\Core\Entity\BundleEntityStorageInterface
  2. 11.x core/lib/Drupal/Core/Entity/BundleEntityStorageInterface.php \Drupal\Core\Entity\BundleEntityStorageInterface

A storage that supports entities with bundle specific classes.

Hierarchy

Expanded class hierarchy of BundleEntityStorageInterface

All classes that implement BundleEntityStorageInterface

File

core/lib/Drupal/Core/Entity/BundleEntityStorageInterface.php, line 8

Namespace

Drupal\Core\Entity
View source
interface BundleEntityStorageInterface {
    
    /**
     * Retrieves the bundle name for a provided class name.
     *
     * @param string $class_name
     *   The class name to check.
     *
     * @return string|null
     *   The bundle name of the class provided or NULL if unable to determine the
     *   bundle from the provided class.
     *
     * @throws \Drupal\Core\Entity\Exception\AmbiguousBundleClassException
     *   Thrown when multiple bundles are using the provided class.
     */
    public function getBundleFromClass(string $class_name) : ?string;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
BundleEntityStorageInterface::getBundleFromClass public function Retrieves the bundle name for a provided class name. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.