ViewsDisplay
class ViewsDisplay extends ViewsPluginAnnotationBase (View source)
Defines a Plugin annotation object for views display plugins.
Properties
| protected array | $definition | The plugin definition read from the class annotation. |
from Plugin |
| bool | $register_theme | Whether or not to register a theme function automatically. |
from ViewsPluginAnnotationBase |
| string | $id | The plugin ID. |
|
| Translation | $title | The plugin title used in the views UI. |
|
| Translation | $short_title | (optional) The short title used in the views UI. |
|
| Translation | $admin | The administrative name of the display. |
|
| Translation | $help | A short help string; this is displayed in the views UI. |
|
| bool | $uses_menu_links | Whether or not to use hook_menu() to register a route. |
|
| bool | $uses_route | Does the display plugin registers routes to the route. |
|
| bool | $uses_hook_block | Does the display plugin provide blocks. |
|
| array | $contextual_links_locations | A list of places where contextual links should be added. |
|
| array | $base | The base tables on which this display plugin can be used. |
|
| string | $theme | The theme function used to render the display's output. |
|
| bool | $no_ui | Whether the plugin should be not selectable in the UI. |
|
| bool | $returns_response | Whether the display returns a response object. |
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.