Drupal 8  8.0.2
SearchPage Class Reference
Inheritance diagram for SearchPage:

Public Member Functions

 getPlugin ()
 
 getPluginCollections ()
 
 setPlugin ($plugin_id)
 
 isIndexable ()
 
 isDefaultSearch ()
 
 getPath ()
 
 getWeight ()
 
 postCreate (EntityStorageInterface $storage)
 
 postSave (EntityStorageInterface $storage, $update=TRUE)
 
- 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)
 

Static Public Member Functions

static postDelete (EntityStorageInterface $storage, array $entities)
 
- 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

 getPluginCollection ()
 
 routeBuilder ()
 
 configFactory ()
 
 searchPageRepository ()
 
 searchPluginManager ()
 
- 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)
 

Protected Attributes

 $id
 
 $label
 
 $configuration = array()
 
 $plugin
 
 $path
 
 $weight
 
 $pluginCollection
 
- 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 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 a configured search page.

( id = "search_page", label = ("Search page"), handlers = { "access" = "Drupal\search\SearchPageAccessControlHandler", "list_builder" = "Drupal\search\SearchPageListBuilder", "form" = { "add" = "Drupal\search\Form\SearchPageAddForm", "edit" = "Drupal\search\Form\SearchPageEditForm", "search" = "Drupal\search\Form\SearchPageForm", "delete" = "Drupal\Core\Entity\EntityDeleteForm" } }, admin_permission = "administer search", links = { "edit-form" = "/admin/config/search/pages/manage/{search_page}", "delete-form" = "/admin/config/search/pages/manage/{search_page}/delete", "enable" = "/admin/config/search/pages/manage/{search_page}/enable", "disable" = "/admin/config/search/pages/manage/{search_page}/disable", "set-default" = "/admin/config/search/pages/manage/{search_page}/set-default", "collection" = "/admin/config/search/pages", }, config_prefix = "page", entity_keys = { "id" = "id", "label" = "label", "weight" = "weight", "status" = "status" }, config_export = { "id", "label", "path", "weight", "plugin", "configuration", } )

Member Function Documentation

configFactory ( )
protected

Wraps the config factory.

Returns
A config factory object.
getPath ( )

{Returns the path for the search.

Returns
string The part of the path for this search page that comes after 'search'.
}

Implements SearchPageInterface.

getPlugin ( )

{Returns the search plugin.

Returns
The search plugin used by this search page entity.
}

Implements SearchPageInterface.

References SearchPage\getPluginCollection().

Referenced by SearchPage\isIndexable().

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginCollection ( )
protected

Encapsulates the creation of the search page's LazyPluginCollection.

Returns
The search page's plugin collection.

References SearchPage\searchPluginManager().

Referenced by SearchPage\getPlugin(), SearchPage\getPluginCollections(), and SearchPage\setPlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginCollections ( )

{Gets the plugin collections used by this entity.

Returns
[] An array of plugin collections, keyed by the property name they use to store their configuration.
}

Implements EntityWithPluginCollectionInterface.

References SearchPage\getPluginCollection().

Here is the call graph for this function:

getWeight ( )

{Returns the weight for the page.

Returns
int The page weight.
}

Implements SearchPageInterface.

isDefaultSearch ( )

{Determines if this search page entity is currently the default search.

Returns
bool TRUE if this search page entity is the default search, FALSE otherwise.
}

Implements SearchPageInterface.

References Entity\id(), and SearchPage\searchPageRepository().

Referenced by SearchPage\postCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

isIndexable ( )

{Determines if this search page entity is indexable.

Returns
bool TRUE if this search page entity is indexable, FALSE otherwise.
}

Implements SearchPageInterface.

References SearchPage\getPlugin(), and ConfigEntityBase\status().

Here is the call graph for this function:

postCreate ( EntityStorageInterface  $storage)

{}

References SearchPage\isDefaultSearch().

Here is the call graph for this function:

static postDelete ( EntityStorageInterface  $storage,
array  $entities 
)
static

{}

References Drupal\service().

Here is the call graph for this function:

postSave ( EntityStorageInterface  $storage,
  $update = TRUE 
)

{}

References SearchPage\routeBuilder().

Here is the call graph for this function:

routeBuilder ( )
protected

Wraps the route builder.

Returns
An object for state storage.

Referenced by SearchPage\postSave().

Here is the caller graph for this function:

searchPageRepository ( )
protected

Wraps the search page repository.

Returns
A search page repository object.

Referenced by SearchPage\isDefaultSearch().

Here is the caller graph for this function:

searchPluginManager ( )
protected

Wraps the search plugin manager.

Returns
A search plugin manager object.

Referenced by SearchPage\getPluginCollection().

Here is the caller graph for this function:

setPlugin (   $plugin_id)

{Sets the search plugin.

Parameters
string$plugin_idThe search plugin ID.
}

Implements SearchPageInterface.

References SearchPage\getPluginCollection().

Here is the call graph for this function:


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