Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/search/src/Plugin/SearchInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\search\Plugin\SearchInterface.
6	*/
7
8	namespace Drupal\search\Plugin;
9
10	use Drupal\Component\Plugin\PluginInspectionInterface;
11	use Drupal\Core\Form\FormStateInterface;
12
13	/**
14	* Defines a common interface for all SearchPlugin objects.
15	*/
16	interface SearchInterface extends PluginInspectionInterface {
17
18	/**
19	* Sets the keywords, parameters, and attributes to be used by execute().
20	*
21	* @param string $keywords
22	* The keywords to use in a search.
23	* @param array $parameters
24	* Array of parameters as an associative array. This is expected to
25	* be the query string from the current request.
26	* @param array $attributes
27	* Array of attributes, usually from the current request object.
28	*
29	* @return \Drupal\search\Plugin\SearchInterface
30	* A search plugin object for chaining.
31	*/
32	public function setSearch($keywords, array $parameters, array $attributes);
33
34	/**
35	* Returns the currently set keywords of the plugin instance.
36	*
37	* @return string
38	* The keywords.
39	*/
40	public function getKeywords();
41
42	/**
43	* Returns the current parameters set using setSearch().
44	*
45	* @return array
46	* The parameters.
47	*/
48	public function getParameters();
49
50	/**
51	* Returns the currently set attributes (from the request).
52	*
53	* @return array
54	* The attributes.
55	*/
56	public function getAttributes();
57
58	/**
59	* Verifies if the values set via setSearch() are valid and sufficient.
60	*
61	* @return bool
62	* TRUE if the search settings are valid and sufficient to execute a search,
63	* and FALSE if not.
64	*/
65	public function isSearchExecutable();
66
67	/**
68	* Returns the search index type this plugin uses.
69	*
70	* @return string\|null
71	* The type used by this search plugin in the search index, or NULL if this
72	* plugin does not use the search index.
73	*
74	* @see search_index()
75	* @see search_index_clear()
76	*/
77	public function getType();
78
79	/**
80	* Executes the search.
81	*
82	* @return array
83	* A structured list of search results.
84	*/
85	public function execute();
86
87	/**
88	* Executes the search and builds render arrays for the result items.
89	*
90	* @return array
91	* An array of render arrays of search result items (generally each item
92	* has '#theme' set to 'search_result'), or an empty array if there are no
93	* results.
94	*/
95	public function buildResults();
96
97	/**
98	* Provides a suggested title for a page of search results.
99	*
100	* @return string
101	* The translated suggested page title.
102	*/
103	public function suggestedTitle();
104
105	/**
106	* Returns the searching help.
107	*
108	* @return array
109	* Render array for the searching help.
110	*/
111	public function getHelp();
112
113	/**
114	* Alters the search form when being built for a given plugin.
115	*
116	* The core search module only invokes this method on active module plugins
117	* when building a form for them in
118	* \Drupal\search\Form\SearchPageForm::form(). A plugin implementing this
119	* will also need to implement the buildSearchUrlQuery() method.
120	*
121	* @param array $form
122	* Nested array of form elements that comprise the form.
123	* @param \Drupal\Core\Form\FormStateInterface $form_state
124	* The current state of the form. The arguments that
125	* \Drupal::formBuilder()->getForm() was originally called with are
126	* available in the array $form_state->getBuildInfo()['args'].
127	*
128	* @see SearchInterface::buildSearchUrlQuery()
129	*/
130	public function searchFormAlter(array &$form, FormStateInterface $form_state);
131
132	/**
133	* Builds the URL GET query parameters array for search.
134	*
135	* When the search form is submitted, a redirect is generated with the
136	* search input as GET query parameters. Plugins using the searchFormAlter()
137	* method to add form elements to the search form will need to override this
138	* method to gather the form input and add it to the GET query parameters.
139	*
140	* @param \Drupal\Core\Form\FormStateInterface $form_state
141	* The form state, with submitted form information.
142	*
143	* @return array
144	* An array of GET query parameters containing all relevant form values
145	* to process the search. The 'keys' element must be present in order to
146	* trigger generation of search results, even if it is empty or unused by
147	* the search plugin.
148	*
149	* @see SearchInterface::searchFormAlter()
150	*/
151	public function buildSearchUrlQuery(FormStateInterface $form_state);
152
153	}