You are here

Home » API reference » Wysiwyg API template plugin 3.0.x » Template.php

class Template in Wysiwyg API template plugin 3.0.x

Same name and namespace in other branches
  1. 8.2 src/Entity/Template.php \Drupal\wysiwyg_template\Entity\Template

Defines the Template entity.

Plugin annotation


@ConfigEntityType(
  id = "wysiwyg_template",
  label = @Translation("Template"),
  handlers = {
    "list_builder" = "Drupal\wysiwyg_template\TemplateListBuilder",
    "form" = {
      "add" = "Drupal\wysiwyg_template\Form\TemplateForm",
      "edit" = "Drupal\wysiwyg_template\Form\TemplateForm",
      "delete" = "Drupal\wysiwyg_template\Form\TemplateDeleteForm"
    }
  },
  config_prefix = "wysiwyg_template",
  config_export = {
    "id",
    "label",
    "description",
    "body",
    "weight",
    "node_types",
    "entity_types"
  },
  admin_permission = "administer wysiwyg templates",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
    "weight" = "weight"
  },
  links = {
    "canonical" = "/admin/config/content/wysiwyg-templates/{wysiwyg_template}",
    "edit-form" = "/admin/config/content/wysiwyg-templates/{wysiwyg_template}/edit",
    "delete-form" = "/admin/config/content/wysiwyg-templates/{wysiwyg_template}/delete",
    "collection" = "/admin/config/content/wysiwyg-templates"
  }
)

Hierarchy

Expanded class hierarchy of Template

7 files declare their use of Template
CrudTest.php in src/Tests/Form/CrudTest.php
DefaultContentTest.php in src/Tests/DefaultContentTest.php
TemplateController.php in src/Controller/TemplateController.php
TemplateControllerTest.php in tests/src/Kernel/Controller/TemplateControllerTest.php
TemplateTest.php in tests/src/Kernel/Entity/TemplateTest.php

... See full list

1 string reference to 'Template'
TemplateListBuilder::buildHeader in src/TemplateListBuilder.php
Builds the header row for the entity listing.

File

src/Entity/Template.php, line 50

Namespace

Drupal\wysiwyg_template\Entity
View source 
class Template extends ConfigEntityBase implements TemplateInterface {

  /**
   * The unique template ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The template title.
   *
   * @var string
   */
  protected $title;

  /**
   * The template description.
   *
   * @var string
   */
  protected $description;

  /**
   * The template HTML body.
   *
   * @var string
   */
  protected $body;

  /**
   * The template weight.
   *
   * @var integer
   */
  protected $weight;

  /**
   * The node types this template is available for.
   *
   * @var string[]
   */
  protected $node_types;

  /**
   * The entity types this template is available for.
   *
   * @var string[][]
   */
  protected $entity_types;

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

  /**
   * {@inheritdoc}
   */
  public function getBody() : string {
    if ($body = $this
      ->get('body')) {
      return $body['value'];
    }
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function getFormat() : string {
    if ($body = $this
      ->get('body')) {
      return $body['format'];
    }
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() : int {
    return $this->weight;
  }

  /**
   * {@inheritdoc}
   */
  public function getNodeTypes() : array {
    return $this->node_types ?? [];
  }

  /**
   * {@inheritdoc}
   */
  public function getBundles($entity_type = NULL) : array {
    if ($entity_type === NULL) {
      return empty($this->entity_types) ? [] : array_keys($this->entity_types);
    }
    return $this->entity_types[$entity_type] ?? [];
  }

  /**
   * {@inheritdoc}
   */
  public function setBundles($entity_type, array $bundles) : TemplateInterface {
    $this->entity_types[$entity_type] = $bundles;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function save() {
    $this->node_types = array_values(array_filter($this
      ->getNodeTypes()));
    foreach ($this
      ->getBundles() as $type) {
      $this->entity_types[$type] = array_values(array_filter($this
        ->getBundles($type)));
    }
    parent::save();
  }

  /**
   * {@inheritdoc}
   */
  public static function postLoad(EntityStorageInterface $storage, array &$entities) {
    parent::postLoad($storage, $entities);

    // Sort the queried roles by their weight.
    // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
    uasort($entities, 'static::sort');
  }

  /**
   * {@inheritdoc}
   */
  public static function loadByNodeType(NodeTypeInterface $node_type = NULL) : array {

    /** @var \Drupal\wysiwyg_template_core\TemplateInterface[] $templates */
    $templates = static::loadMultiple();
    foreach ($templates as $id => $template) {
      if (!$node_type) {

        // If no node type is passed than all templates that *don't specify any*
        // types are included, but those specifying a type are not.
        if (!empty($template
          ->getNodeTypes())) {
          unset($templates[$id]);
        }
      }
      else {

        // Any templates without types, plus the templates that specify this type.
        if (empty($template
          ->getNodeTypes()) || in_array($node_type
          ->id(), $template
          ->getNodeTypes(), TRUE)) {
          continue;
        }
        unset($templates[$id]);
      }
    }
    return $templates;
  }

  /**
   * {@inheritdoc}
   */
  public static function loadByTypeAndBundle($entity_type, $bundle) : array {

    /** @var \Drupal\wysiwyg_template_core\TemplateInterface[] $templates */
    $templates = static::loadMultiple();
    foreach ($templates as $id => $template) {
      $bundles = $template
        ->getBundles($entity_type);
      if (!empty($bundles)) {
        if (!in_array($bundle, $bundles)) {

          // At least one bundle of the entity type is selected but not the given
          // one, so this template is not for us.
          unset($templates[$id]);
        }

        // Otherwise, we are relevant for the given bundle.
      }
      else {
        foreach ($template
          ->getBundles() as $type) {
          if ($type === $entity_type) {

            // Do not test the current type again.
            continue;
          }
          if (!empty($template
            ->getBundles($entity_type))) {

            // The template is selected for another entity type, so it's not for us.
            unset($templates[$id]);
            continue 2;
          }
        }
      }
    }
    return $templates;
  }

}

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::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
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::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::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
Template::$body protected property The template HTML body.
Template::$description protected property The template description.
Template::$entity_types protected property The entity types this template is available for.
Template::$id protected property The unique template ID.
Template::$node_types protected property The node types this template is available for.
Template::$title protected property The template title.
Template::$weight protected property The template weight.
Template::getBody public function Gets the template body. Overrides TemplateInterface::getBody
Template::getBundles public function Gets the list of allowed types for the given entity type. Overrides TemplateInterface::getBundles
Template::getDescription public function Gets the template description. Overrides TemplateInterface::getDescription
Template::getFormat public function Gets the text format. Overrides TemplateInterface::getFormat
Template::getNodeTypes public function Gets the list of allowed node types. Overrides TemplateInterface::getNodeTypes
Template::getWeight public function Gets the template weight. Overrides TemplateInterface::getWeight
Template::loadByNodeType public static function Loads templates filtered by node type. Overrides TemplateInterface::loadByNodeType
Template::loadByTypeAndBundle public static function Loads templates filtered by entity type and bundle. Overrides TemplateInterface::loadByTypeAndBundle
Template::postLoad public static function Acts on loaded entities. Overrides EntityBase::postLoad
Template::save public function Saves an entity permanently. Overrides ConfigEntityBase::save
Template::setBundles public function Overrides TemplateInterface::setBundles