interface AutoEntityLabelManagerInterface in Automatic Entity Label 8.3

Provides an interface for AutoEntityLabelManager.

Hierarchy

• interface \Drupal\auto_entitylabel\AutoEntityLabelManagerInterface

File

src/AutoEntityLabelManagerInterface.php, line 8

Namespace

Drupal\auto_entitylabel

interface AutoEntityLabelManagerInterface {

  /**
   * Sets the automatically generated entity label.
   *
   * @return string
   *   The applied label. The entity is updated with this label.
   */
  public function setLabel();

  /**
   * Determines if the entity bundle has auto entity label enabled.
   *
   * @return bool
   *   True if the entity bundle has an automatic label.
   */
  public function hasAutoLabel();

  /**
   * Determines if the entity bundle has an optional automatic label.
   *
   * Optional means that if the label is empty, it will be automatically
   * generated.
   *
   * @return bool
   *   True if the entity bundle has an optional automatic label.
   */
  public function hasOptionalAutoLabel();

  /**
   * Returns whether the automatic label has to be set.
   *
   * @return bool
   *   Returns true if the label should be automatically generated.
   */
  public function autoLabelNeeded();

  /**
   * Returns status of automatic entity label.
   *
   * @return bool
   *   Status value.
   */
  public function getStatus();

  /**
   * Returns pattern for the label.
   *
   * @return string
   *   Pattern value.
   */
  public function getPattern();

}

Members

Name	Modifiers	Type	Description	Overrides
AutoEntityLabelManagerInterface::autoLabelNeeded	public	function	Returns whether the automatic label has to be set.	1
AutoEntityLabelManagerInterface::getPattern	public	function	Returns pattern for the label.	1
AutoEntityLabelManagerInterface::getStatus	public	function	Returns status of automatic entity label.	1
AutoEntityLabelManagerInterface::hasAutoLabel	public	function	Determines if the entity bundle has auto entity label enabled.	1
AutoEntityLabelManagerInterface::hasOptionalAutoLabel	public	function	Determines if the entity bundle has an optional automatic label.	1
AutoEntityLabelManagerInterface::setLabel	public	function	Sets the automatically generated entity label.	1