TagInterface.php in Extensible BBCode 4.0.x

Namespace

Drupal\xbbcode\Entity

File

src/Entity/TagInterface.php

<?php

namespace Drupal\xbbcode\Entity;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Defines the interface for custom tag entities.
 */
interface TagInterface extends ConfigEntityInterface {

  /**
   * The tag description.
   *
   * @return string
   *   Tag description.
   */
  public function getDescription() : string;

  /**
   * The default tag name.
   *
   * @return string
   *   Default tag name.
   */
  public function getName() : string;

  /**
   * The sample code.
   *
   * @return string
   *   Tag sample code (using {{ name }} placeholders).
   */
  public function getSample() : string;

  /**
   * An inline template.
   *
   * @return string
   *   The Twig template code.
   */
  public function getTemplateCode() : string;

  /**
   * An external template file.
   *
   * This file must be registered with the theme registry via hook_theme().
   *
   * @return string
   *   A template file.
   */
  public function getTemplateFile() : string;

  /**
   * Return the attachments for this tag.
   *
   * @return array
   *   A valid array to put into #attached.
   */
  public function getAttachments() : array;

  /**
   * Whether the tag is editable.
   *
   * @return bool
   *   Tag is editable.
   */
  public function isEditable() : bool;

  /**
   * The settings of this tag.
   *
   * @return array
   *   The settings array.
   */
  public function getSettings() : array;

}

Interfaces

Name	Description
TagInterface	Defines the interface for custom tag entities.