SearchPlugin
class SearchPlugin extends Plugin (View source)
Defines a SearchPlugin type annotation object.
SearchPlugin classes define search types for the core Search module. Each search type can be used to create search pages from the Search settings page.
Properties
| protected array | $definition | The plugin definition read from the class annotation. |
from Plugin |
| string | $id | A unique identifier for the search plugin. |
|
| Translation | $title | The title for the search page tab. |
|
| bool | $use_admin_theme | Whether or not search results should be displayed in admin theme. |
Methods
Details
in
Plugin at line 35
__construct($values)
Constructs a Plugin object.
Builds up the plugin definition and invokes the get() method for any classed annotations that were used.
in
Plugin at line 54
protected array
parse(array $values)
Parses an annotation into its definition.
in
Plugin at line 73
get()
Gets the value of an annotation.
in
Plugin at line 80
string
getProvider()
Gets the name of the provider of the annotated class.
in
Plugin at line 87
setProvider(string $provider)
Sets the name of the provider of the annotated class.
in
Plugin at line 94
string
getId()
Gets the unique ID for this annotated class.
string
getClass()
Gets the class of the annotated class.
setClass(string $class)
Sets the class of the annotated class.