Drupal 8  8.0.2
Tour Class Reference
Inheritance diagram for Tour:

Public Member Functions

 __construct (array $values, $entity_type)
 
 getRoutes ()
 
 getTip ($id)
 
 getTips ()
 
 getModule ()
 
 hasMatchingRoute ($route_name, $route_params)
 
 resetKeyedRoutes ()
 
 calculateDependencies ()
 
- Public Member Functions inherited from ConfigEntityBase
 __construct (array $values, $entity_type)
 
 getOriginalId ()
 
 setOriginalId ($id)
 
 isNew ()
 
 get ($property_name)
 
 set ($property_name, $value)
 
 enable ()
 
 disable ()
 
 setStatus ($status)
 
 status ()
 
 setSyncing ($syncing)
 
 isSyncing ()
 
 setUninstalling ($uninstalling)
 
 isUninstalling ()
 
 createDuplicate ()
 
 preSave (EntityStorageInterface $storage)
 
 calculateDependencies ()
 
 urlInfo ($rel= 'edit-form', array $options=[])
 
 url ($rel= 'edit-form', $options=array())
 
 link ($text=NULL, $rel= 'edit-form', array $options=[])
 
 toUrl ($rel= 'edit-form', array $options=[])
 
 getCacheTagsToInvalidate ()
 
 getDependencies ()
 
 getConfigDependencyName ()
 
 getConfigTarget ()
 
 onDependencyRemoval (array $dependencies)
 
 setThirdPartySetting ($module, $key, $value)
 
 getThirdPartySetting ($module, $key, $default=NULL)
 
 getThirdPartySettings ($module)
 
 unsetThirdPartySetting ($module, $key)
 
 getThirdPartyProviders ()
 
 isInstallable ()
 
 trustData ()
 
 hasTrustedData ()
 
 save ()
 
- Public Member Functions inherited from Entity
 __construct (array $values, $entity_type)
 
 id ()
 
 uuid ()
 
 isNew ()
 
 enforceIsNew ($value=TRUE)
 
 getEntityTypeId ()
 
 bundle ()
 
 label ()
 
 urlInfo ($rel= 'canonical', array $options=[])
 
 toUrl ($rel= 'canonical', array $options=[])
 
 hasLinkTemplate ($rel)
 
 link ($text=NULL, $rel= 'canonical', array $options=[])
 
 toLink ($text=NULL, $rel= 'canonical', array $options=[])
 
 url ($rel= 'canonical', $options=array())
 
 uriRelationships ()
 
 access ($operation, AccountInterface $account=NULL, $return_as_object=FALSE)
 
 language ()
 
 save ()
 
 delete ()
 
 createDuplicate ()
 
 getEntityType ()
 
 preSave (EntityStorageInterface $storage)
 
 postSave (EntityStorageInterface $storage, $update=TRUE)
 
 postCreate (EntityStorageInterface $storage)
 
 referencedEntities ()
 
 getCacheContexts ()
 
 getCacheTagsToInvalidate ()
 
 getCacheTags ()
 
 getCacheMaxAge ()
 
 getOriginalId ()
 
 setOriginalId ($id)
 
 toArray ()
 
 getTypedData ()
 
 __sleep ()
 
 getConfigDependencyKey ()
 
 getConfigDependencyName ()
 
 getConfigTarget ()
 
- Public Member Functions inherited from RefinableCacheableDependencyInterface
 addCacheContexts (array $cache_contexts)
 
 addCacheTags (array $cache_tags)
 
 mergeCacheMaxAge ($max_age)
 
 addCacheableDependency ($other_object)
 

Protected Attributes

 $id
 
 $module
 
 $label
 
 $routes = array()
 
 $keyedRoutes
 
 $tipsCollection
 
 $tips = array()
 
- Protected Attributes inherited from ConfigEntityBase
 $originalId
 
 $pluginConfigKey
 
 $status = TRUE
 
 $uuid
 
 $langcode = 'en'
 
 $third_party_settings = array()
 
 $_core = []
 
 $trustedData = FALSE
 
- Protected Attributes inherited from Entity
 $entityTypeId
 
 $enforceIsNew
 
 $typedData
 

Additional Inherited Members

- Static Public Member Functions inherited from ConfigEntityBase
static sort (ConfigEntityInterface $a, ConfigEntityInterface $b)
 
- Static Public Member Functions inherited from Entity
static preCreate (EntityStorageInterface $storage, array &$values)
 
static preDelete (EntityStorageInterface $storage, array $entities)
 
static postDelete (EntityStorageInterface $storage, array $entities)
 
static postLoad (EntityStorageInterface $storage, array &$entities)
 
static load ($id)
 
static loadMultiple (array $ids=NULL)
 
static create (array $values=array())
 
- Protected Member Functions inherited from ConfigEntityBase
 getTypedConfig ()
 
 addDependency ($type, $name)
 
 invalidateTagsOnSave ($update)
 
- Protected Member Functions inherited from Entity
 entityManager ()
 
 entityTypeManager ()
 
 languageManager ()
 
 uuidGenerator ()
 
 linkTemplates ()
 
 urlRouteParameters ($rel)
 
 invalidateTagsOnSave ($update)
 
- Static Protected Member Functions inherited from ConfigEntityBase
static invalidateTagsOnDelete (EntityTypeInterface $entity_type, array $entities)
 
static getConfigManager ()
 
- Static Protected Member Functions inherited from Entity
static invalidateTagsOnDelete (EntityTypeInterface $entity_type, array $entities)
 

Detailed Description

Defines the configured tour entity.

( id = "tour", label = ("Tour"), handlers = { "view_builder" = "Drupal\tour\TourViewBuilder" }, entity_keys = { "id" = "id", "label" = "label" }, config_export = { "id", "label", "module", "routes", "tips", }, lookup_keys = { "routes.*.route_name" } )

Constructor & Destructor Documentation

__construct ( array  $values,
  $entity_type 
)

{}

References Drupal\service().

Here is the call graph for this function:

Member Function Documentation

calculateDependencies ( )

{Calculates dependencies and stores them in the dependency property.

Returns
$this
See Also
}

Implements ConfigEntityInterface.

References ConfigEntityBase\addDependency().

Here is the call graph for this function:

getModule ( )

{Gets the module this tour belongs to.

Returns
string The module this tour belongs to.
}

Implements TourInterface.

getRoutes ( )

{The routes that this tour will appear on.

Returns
array Returns array of routes for the tour.
}

Implements TourInterface.

Referenced by Tour\hasMatchingRoute().

Here is the caller graph for this function:

getTip (   $id)

{Returns tip plugin.

Parameters
string$idThe identifier of the tip.
Returns
The tip plugin.
}

Implements TourInterface.

Referenced by Tour\getTips().

Here is the caller graph for this function:

getTips ( )

{Returns the tips for this tour.

Returns
array An array of tip plugins.
}

Implements TourInterface.

References Tour\getTip(), and Drupal\moduleHandler().

Here is the call graph for this function:

hasMatchingRoute (   $route_name,
  $route_params 
)

{Whether the tour matches a given set of route parameters.

Parameters
string$route_nameThe route name the parameters are for.
array$route_paramsAssociative array of raw route params.
Returns
bool TRUE if the tour matches the route parameters.
}

Implements TourInterface.

References Tour\getRoutes().

Here is the call graph for this function:

resetKeyedRoutes ( )

{Resets the statically cached keyed routes.}

Implements TourInterface.


The documentation for this class was generated from the following file: