CommerceBundleEntityInterface.php in Commerce Core 8.2

Namespace

Drupal\commerce\Entity

File

src/Entity/CommerceBundleEntityInterface.php

<?php

namespace Drupal\commerce\Entity;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides the interface for Commerce bundle entities.
 *
 * Each bundle entity can have traits attached.
 *
 * @see \Drupal\commerce\Plugin\Commerce\EntityTrait\EntityTraitInterface
 */
interface CommerceBundleEntityInterface extends ConfigEntityInterface {

  /**
   * Gets the traits.
   *
   * @return array
   *   The trait plugin IDs.
   */
  public function getTraits();

  /**
   * Sets the traits.
   *
   * @param array $traits
   *   The trait plugin IDs.
   *
   * @return $this
   */
  public function setTraits(array $traits);

  /**
   * Gets whether the bundle has the given trait.
   *
   * @param string $trait
   *   The trait plugin ID.
   */
  public function hasTrait($trait);

  /**
   * Gets whether the bundle is locked.
   *
   * Locked bundles cannot be deleted.
   *
   * @return bool
   *   TRUE if the bundle is locked, FALSE otherwise.
   */
  public function isLocked();

  /**
   * Locks the bundle.
   *
   * @return $this
   */
  public function lock();

  /**
   * Unlocks the bundle.
   *
   * @return $this
   */
  public function unlock();

}

Interfaces

Name	Description
CommerceBundleEntityInterface	Provides the interface for Commerce bundle entities.