Constructs a \Drupal\node\Plugin\Search\NodeSearch object.

Gets the plugin_id of the plugin instance.

Gets the base_plugin_id of the plugin instance.

Gets the derivative_id of the plugin instance.

Gets the definition of the plugin implementation.

Determines if the plugin is configurable.

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Formats a string containing a count of items.

Returns the number of plurals supported by a given language.

Gets the string translation service.

Sets the string translation service to use.

{@inheritdoc}

{@inheritdoc}

Sets the messenger.

Gets the messenger.

Sets cacheability; useful for value object constructors.

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

Creates an instance of the plugin.

Sets the keywords, parameters, and attributes to be used by execute().

Returns the currently set keywords of the plugin instance.

Returns the current parameters set using setSearch().

Returns the currently set attributes (from the request).

Verifies if the values set via setSearch() are valid and sufficient.

Returns the search index type this plugin uses.

Executes the search and builds render arrays for the result items.

Alters the search form when being built for a given plugin.

The core search module only invokes this method on active module plugins when building a form for them in \Drupal\search\Form\SearchPageForm::buildForm(). A plugin implementing this will also need to implement the buildSearchUrlQuery() method.

Provides a suggested title for a page of search results.

Builds the URL GET query parameters array for search.

When the search form is submitted, a redirect is generated with the search input as GET query parameters. Plugins using the searchFormAlter() method to add form elements to the search form will need to override this method to gather the form input and add it to the GET query parameters.

Returns the searching help.

Gets default configuration for this plugin.

Gets this plugin's configuration.

Sets the configuration for this plugin instance.

Form validation handler.

Calculates dependencies for the configured plugin.

Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.

Sets the ID for the search page using this plugin.

Allows to access deprecated/removed properties.

This method must be public.

Checks data value access.

Executes the search.

Queries to find search results, and sets status messages.

This method can assume that $this->isSearchExecutable() has already been checked and returned TRUE.

Prepares search results for rendering.

Removes the submitted by information from the build array.

This information is being removed from the rendered node that is used to build the search result snippet. It just doesn't make sense to have it displayed in the snippet.

Adds the configured rankings to the search query.

Updates the search index for this plugin.

This method is called every cron run if the plugin has been set as an active search module on the Search settings page (admin/config/search/pages). It allows your module to add items to the built-in search index by calling the index() method on the search.index service class, or to add them to your module's own indexing mechanism.

When implementing this method, your module should index content items that were modified or added since the last run. There is a time limit for cron, so it is advisable to limit how many items you index per run using config('search.settings')->get('index.cron_limit') or with your own setting. And since the cron run could time out and abort in the middle of your run, you should update any needed internal bookkeeping on when items have last been indexed as you go rather than waiting to the end of indexing.

Indexes a single node.

Clears the search index for this plugin.

When a request is made to clear all items from the search index related to this plugin, this method will be called. If this plugin uses the default search index, this method can call clear($type) method on the search.index service class to remove indexed items from the search database.

Marks the search index for reindexing for this plugin.

When a request is made to mark all items from the search index related to this plugin for reindexing, this method will be called. If this plugin uses the default search index, this method can call markForReindex($type) method on the search.index service class to mark the items in the search database for reindexing.

Reports the status of indexing.

The core search module only invokes this method on active module plugins. Implementing modules do not need to check whether they are active when calculating their return values.

Parses the advanced search form default values.

Gathers ranking definitions from hook_ranking().

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and

array_parents, see \Drupal\Core\Render\Element\FormElement.

Form submission handler.

Lists the trusted callbacks provided by the implementing class.

Trusted callbacks are public methods on the implementing class and can be invoked via \Drupal\Core\Security\DoTrustedCallbackTrait::doTrustedCallback().