class Tour

Same name and namespace in other branches
  1. 8.9.x core/modules/tour/src/Entity/Tour.php \Drupal\tour\Entity\Tour
  2. 10 core/modules/tour/src/Entity/Tour.php \Drupal\tour\Entity\Tour
  3. 11.x core/modules/tour/src/Entity/Tour.php \Drupal\tour\Entity\Tour

Defines the configured tour entity.

Plugin annotation


@ConfigEntityType(
  id = "tour",
  label = @Translation("Tour"),
  label_collection = @Translation("Tours"),
  label_singular = @Translation("tour"),
  label_plural = @Translation("tours"),
  label_count = @PluralTranslation(
    singular = "@count tour",
    plural = "@count tours",
  ),
  handlers = {
    "view_builder" = "Drupal\tour\TourViewBuilder",
    "access" = "Drupal\tour\TourAccessControlHandler",
  },
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "module",
    "routes",
    "tips",
  },
  lookup_keys = {
    "routes.*.route_name"
  }
)

Hierarchy

Expanded class hierarchy of Tour

8 files declare their use of Tour
ConfigInstallProfileOverrideTest.php in core/modules/config/tests/src/Functional/ConfigInstallProfileOverrideTest.php
tour.module in core/modules/tour/tour.module
Main functions of the module.
tour.post_update.php in core/modules/tour/tour.post_update.php
Post update functions for Tour.
TourCacheTagsTest.php in core/modules/tour/tests/src/Functional/TourCacheTagsTest.php
TourPluginTest.php in core/modules/tour/tests/src/Kernel/TourPluginTest.php

... See full list

20 string references to 'Tour'
ConfigInstallProfileOverrideTest::testInstallProfileConfigOverwrite in core/modules/config/tests/src/Functional/ConfigInstallProfileOverrideTest.php
Tests install profile config changes.
config_test.dynamic.override.yml in core/profiles/testing_config_overrides/config/optional/config_test.dynamic.override.yml
core/profiles/testing_config_overrides/config/optional/config_test.dynamic.override.yml
config_test.dynamic.override_unmet.yml in core/modules/config/tests/config_test/config/optional/config_test.dynamic.override_unmet.yml
core/modules/config/tests/config_test/config/optional/config_test.dynamic.override_unmet.yml
demo_umami.info.yml in core/profiles/demo_umami/demo_umami.info.yml
core/profiles/demo_umami/demo_umami.info.yml
standard.info.yml in core/profiles/standard/standard.info.yml
core/profiles/standard/standard.info.yml

... See full list

File

core/modules/tour/src/Entity/Tour.php, line 43

Namespace

Drupal\tour\Entity
View source
class Tour extends ConfigEntityBase implements TourInterface {
    
    /**
     * The name (plugin ID) of the tour.
     *
     * @var string
     */
    protected $id;
    
    /**
     * The module which this tour is assigned to.
     *
     * @var string
     */
    protected $module;
    
    /**
     * The label of the tour.
     *
     * @var string
     */
    protected $label;
    
    /**
     * The routes on which this tour should be displayed.
     *
     * @var array
     */
    protected $routes = [];
    
    /**
     * The routes on which this tour should be displayed, keyed by route id.
     *
     * @var array
     */
    protected $keyedRoutes;
    
    /**
     * Holds the collection of tips that are attached to this tour.
     *
     * @var \Drupal\tour\TipsPluginCollection
     */
    protected $tipsCollection;
    
    /**
     * The array of plugin config, only used for export and to populate the $tipsCollection.
     *
     * @var array
     */
    protected $tips = [];
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $values, $entity_type) {
        parent::__construct($values, $entity_type);
        $this->tipsCollection = new TipsPluginCollection(\Drupal::service('plugin.manager.tour.tip'), $this->tips);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRoutes() {
        return $this->routes;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTip($id) {
        return $this->tipsCollection
            ->get($id);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTips() {
        $tips = [];
        foreach ($this->tips as $id => $tip) {
            $tips[] = $this->getTip($id);
        }
        uasort($tips, function ($a, $b) {
            return $a->getWeight() <=> $b->getWeight();
        });
        \Drupal::moduleHandler()->alter('tour_tips', $tips, $this);
        return array_values($tips);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getModule() {
        return $this->module;
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasMatchingRoute($route_name, $route_params) {
        if (!isset($this->keyedRoutes)) {
            $this->keyedRoutes = [];
            foreach ($this->getRoutes() as $route) {
                $this->keyedRoutes[$route['route_name']] = $route['route_params'] ?? [];
            }
        }
        if (!isset($this->keyedRoutes[$route_name])) {
            // We don't know about this route.
            return FALSE;
        }
        if (empty($this->keyedRoutes[$route_name])) {
            // We don't need to worry about route params, the route name is enough.
            return TRUE;
        }
        foreach ($this->keyedRoutes[$route_name] as $key => $value) {
            // If a required param is missing or doesn't match, return FALSE.
            if (empty($route_params[$key]) || $route_params[$key] !== $value) {
                return FALSE;
            }
        }
        return TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function resetKeyedRoutes() {
        unset($this->keyedRoutes);
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        parent::calculateDependencies();
        foreach ($this->tipsCollection as $instance) {
            $definition = $instance->getPluginDefinition();
            $this->addDependency('module', $definition['provider']);
        }
        $this->addDependency('module', $this->module);
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title 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&#039;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::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&#039; cache tags; the
config system already invalidates them.
Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity&#039;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::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::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object&#039;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 1
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
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::getTypedDataClass private function Returns the typed data class name for this entity.
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 19
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
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 Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
Tour::$id protected property The name (plugin ID) of the tour.
Tour::$keyedRoutes protected property The routes on which this tour should be displayed, keyed by route id.
Tour::$label protected property The label of the tour.
Tour::$module protected property The module which this tour is assigned to.
Tour::$routes protected property The routes on which this tour should be displayed.
Tour::$tips protected property The array of plugin config, only used for export and to populate the $tipsCollection.
Tour::$tipsCollection protected property Holds the collection of tips that are attached to this tour.
Tour::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
Tour::getModule public function Gets the module this tour belongs to. Overrides TourInterface::getModule
Tour::getRoutes public function The routes that this tour will appear on. Overrides TourInterface::getRoutes
Tour::getTip public function Returns tip plugin. Overrides TourInterface::getTip
Tour::getTips public function Returns the tips for this tour. Overrides TourInterface::getTips
Tour::hasMatchingRoute public function Whether the tour matches a given set of route parameters. Overrides TourInterface::hasMatchingRoute
Tour::resetKeyedRoutes public function Resets the statically cached keyed routes. Overrides TourInterface::resetKeyedRoutes
Tour::__construct public function Constructs an Entity object. Overrides ConfigEntityBase::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.