You are here

Home » API reference » Extensible BBCode 4.0.x » Tag.php

class Tag in Extensible BBCode 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Entity/Tag.php \Drupal\xbbcode\Entity\Tag

Represents a custom XBBCode tag that can be altered by administrators.

Plugin annotation


@ConfigEntityType(
  id = "xbbcode_tag",
  label = @Translation("custom tag"),
  label_plural = @Translation("custom tags"),
  handlers = {
    "form" = {
      "add" = "Drupal\xbbcode\Form\TagForm",
      "edit" = "Drupal\xbbcode\Form\TagForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm",
      "view" = "Drupal\xbbcode\Form\TagFormView",
      "copy" = "Drupal\xbbcode\Form\TagFormCopy"
    },
    "list_builder" = "Drupal\xbbcode\TagListBuilder",
    "access" = "Drupal\xbbcode\TagAccessHandler"
  },
  config_prefix = "tag",
  admin_permission = "administer custom BBCode tags",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "status" = "status"
  },
  links = {
    "edit-form" = "/admin/config/content/xbbcode/tags/manage/{xbbcode_tag}/edit",
    "delete-form" = "/admin/config/content/xbbcode/tags/manage/{xbbcode_tag}/delete",
    "view-form" = "/admin/config/content/xbbcode/tags/manage/{xbbcode_tag}/view",
    "copy-form" = "/admin/config/content/xbbcode/tags/manage/{xbbcode_tag}/copy",
    "collection" = "/admin/config/content/xbbcode/tags"
  },
  config_export = {
    "id",
    "label",
    "description",
    "sample",
    "name",
    "attached",
    "editable",
    "template_code",
    "template_file"
  }
)

Hierarchy

Expanded class hierarchy of Tag

1 file declares its use of Tag
XBBCodeFilterTest.php in tests/src/Kernel/XBBCodeFilterTest.php

File

src/Entity/Tag.php, line 56

Namespace

Drupal\xbbcode\Entity
View source 
class Tag extends ConfigEntityBase implements TagInterface {

  /**
   * Description of the tag.
   *
   * @var string
   */
  protected $description;

  /**
   * Default tag name.
   *
   * @var string
   */
  protected $name;

  /**
   * Any attachments required to render this tag.
   *
   * @var array
   */
  protected $attached = [];

  /**
   * Sample code.
   *
   * @var string
   */
  protected $sample;

  /**
   * An inline Twig template.
   *
   * @var string
   */
  protected $template_code;

  /**
   * A Twig template file.
   *
   * @var string
   */
  protected $template_file;

  /**
   * Settings for this tag.
   *
   * @var array
   */
  protected $settings = [];

  /**
   * Whether the tag is editable by admins.
   *
   * This should be left off for tags defined by modules.
   *
   * @var bool
   */
  protected $editable = FALSE;

  /**
   * {@inheritdoc}
   */
  public function getDescription() : string {
    return $this->description ?? '';
  }

  /**
   * {@inheritdoc}
   */
  public function getName() : string {
    return $this->name ?? '';
  }

  /**
   * {@inheritdoc}
   */
  public function getSample() : string {
    return $this->sample ?? '';
  }

  /**
   * {@inheritdoc}
   */
  public function getTemplateCode() : string {
    return $this->template_code ?? '';
  }

  /**
   * {@inheritdoc}
   */
  public function getTemplateFile() : string {
    return $this->template_file ?? '';
  }

  /**
   * {@inheritdoc}
   */
  public function getAttachments() : array {
    return $this->attached;
  }

  /**
   * {@inheritdoc}
   */
  public function isEditable() : bool {
    return $this->editable;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettings() : array {
    return $this->settings;
  }

  /**
   * {@inheritdoc}
   */
  protected function invalidateTagsOnSave($update) : void {
    parent::invalidateTagsOnSave($update);

    // Rebuild the tag plugins.
    \Drupal::service('plugin.manager.xbbcode')
      ->clearCachedDefinitions();

    // Filters can't tag their formats' cache, so invalidate it explicitly.
    if ($tags = $this
      ->filterFormatCacheTags()) {
      filter_formats_reset();
    }
    if (!$update) {

      // New tags affect all filters without a tag set.
      $tags['xbbcode_tag_new'] = 'xbbcode_tag_new';
    }
    if ($tags) {
      Cache::invalidateTags($tags);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected static function invalidateTagsOnDelete(EntityTypeInterface $entity_type, array $entities) : void {

    /** @var \Drupal\xbbcode\Entity\Tag[] $entities */
    parent::invalidateTagsOnDelete($entity_type, $entities);
    $tags = [];
    foreach ($entities as $entity) {
      $tags += $entity
        ->filterFormatCacheTags();
    }
    if ($tags) {
      filter_formats_reset();
      Cache::invalidateTags($tags);
    }
  }

  /**
   * Get all formats that use this tag.
   *
   * @return \Drupal\filter\FilterFormatInterface[]
   *   An array of filter formats using a tag set where this tag is active.
   */
  protected function getFormats() : array {
    $formats = [];
    try {

      // Load all formats that use the BBCode filter.
      $storage = \Drupal::entityTypeManager()
        ->getStorage('filter_format');
      $ids = $storage
        ->getQuery()
        ->condition('filters.xbbcode.status', TRUE)
        ->execute();

      /** @var \Drupal\filter\FilterFormatInterface $format */
      foreach ($storage
        ->loadMultiple($ids) as $id => $format) {
        $config = $format
          ->filters('xbbcode')
          ->getConfiguration();
        $tag_set_id = $config['settings']['tags'];

        // If it references an existing tag set without this tag, skip.
        if ($tag_set_id) {

          /** @var \Drupal\xbbcode\Entity\TagSetInterface $tag_set */
          $tag_set = TagSet::load($tag_set_id);
          if ($tag_set !== NULL && !$tag_set
            ->hasTag($this
            ->id())) {
            continue;
          }
        }

        // Otherwise, include it.
        $formats[$id] = $format;
      }
    } catch (InvalidPluginDefinitionException|PluginNotFoundException $exception) {

      // A broken filter_format entity type is beyond this module to handle.
      watchdog_exception('filter', $exception);
    }
    return $formats;
  }

  /**
   * Get the cache tags of all text formats that use this BBCode tag.
   *
   * @return string[]
   *   Array of cache tags.
   *
   * @internal
   */
  protected function filterFormatCacheTags() : array {
    if ($formats = $this
      ->getFormats()) {
      $tags = [
        'config:filter_format_list',
      ];
      foreach ($formats as $id => $format) {
        $tags[] = "config:filter_format:{$id}";
      }
      return array_combine($tags, $tags);
    }
    return [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 14
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
Tag::$attached protected property Any attachments required to render this tag.
Tag::$description protected property Description of the tag.
Tag::$editable protected property Whether the tag is editable by admins.
Tag::$name protected property Default tag name.
Tag::$sample protected property Sample code.
Tag::$settings protected property Settings for this tag.
Tag::$template_code protected property An inline Twig template.
Tag::$template_file protected property A Twig template file.
Tag::filterFormatCacheTags protected function Get the cache tags of all text formats that use this BBCode tag.
Tag::getAttachments public function Return the attachments for this tag. Overrides TagInterface::getAttachments
Tag::getDescription public function The tag description. Overrides TagInterface::getDescription
Tag::getFormats protected function Get all formats that use this tag.
Tag::getName public function The default tag name. Overrides TagInterface::getName
Tag::getSample public function The sample code. Overrides TagInterface::getSample
Tag::getSettings public function The settings of this tag. Overrides TagInterface::getSettings
Tag::getTemplateCode public function An inline template. Overrides TagInterface::getTemplateCode
Tag::getTemplateFile public function An external template file. Overrides TagInterface::getTemplateFile
Tag::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides ConfigEntityBase::invalidateTagsOnDelete
Tag::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides ConfigEntityBase::invalidateTagsOnSave
Tag::isEditable public function Whether the tag is editable. Overrides TagInterface::isEditable