SearchPageListBuilder

Defines a class to build a listing of search page entities.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface
  - class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
    - class \Drupal\Core\Config\Entity\DraggableListBuilder implements FormInterface
      - class \Drupal\search\SearchPageListBuilder implements FormInterface uses ConfigFormBaseTrait

File

core/modules/search/src/SearchPageListBuilder.php, line 21

Namespace

Drupal\search

Members

Name	Modifiers	Type	Description
ConfigEntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function
DependencySerializationTrait::__wakeup	public	function
DraggableListBuilder::$entitiesKey	protected	property	The key to use for the form element containing the entities.
DraggableListBuilder::$formBuilder	protected	property	The form builder.
DraggableListBuilder::$weightKey	protected	property	Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder	protected	function	Returns the form builder.
DraggableListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::$storage	protected	property	The entity storage class.
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.
SearchPageListBuilder::$configFactory	protected	property	Stores the configuration factory.
SearchPageListBuilder::$entities	protected	property	The entities being listed. Overrides DraggableListBuilder::$entities
SearchPageListBuilder::$searchManager	protected	property	The search manager.
SearchPageListBuilder::buildForm	public	function	Form constructor. Overrides DraggableListBuilder::buildForm
SearchPageListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
SearchPageListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
SearchPageListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
SearchPageListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
SearchPageListBuilder::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SearchPageListBuilder::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SearchPageListBuilder::searchAdminReindexSubmit	public	function	Form submission handler for the reindex button on the search admin settings form.
SearchPageListBuilder::submitAddSearchPage	public	function	Form submission handler for adding a new search page.
SearchPageListBuilder::submitForm	public	function	Form submission handler. Overrides DraggableListBuilder::submitForm
SearchPageListBuilder::validateAddSearchPage	public	function	Form validation handler for adding a new search page.
SearchPageListBuilder::validateForm	public	function	Form validation handler. Overrides DraggableListBuilder::validateForm
SearchPageListBuilder::__construct	public	function	Constructs a new SearchPageListBuilder object. Overrides DraggableListBuilder::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

Links:

https://api.drupal.org/api/drupal/core%21modules%21search%21src%21SearchPageListBuilder.php/class/SearchPageListBuilder/8.2.x

doc_Drupal

2016-10-29 09:40:40

Comments

SearchPageListBuilder

Hierarchy

See also

File

Namespace

Members