class Embed

The plugin that handles an embed display.

@todo: Wait until annotations/plugins support access mehtods. no_ui => !config('views.settings')->get('ui.show.display_embed'),

Plugin annotation

@Plugin(
  id = "embed",
  title = @Translation("Embed"),
  help = @Translation("Provide a display which can be embedded using the views api."),
  theme = "views_view",
  uses_hook_menu = FALSE
)

Hierarchy

Expanded class hierarchy of Embed

Related topics

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/display/Embed.php, line 29

Definition of Drupal\views\Plugin\views\display\Embed.

Namespace

class Embed extends DisplayPluginBase {

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
DisplayPluginBase::$extender		property	Stores all available display extenders.
DisplayPluginBase::$handlers		property
DisplayPluginBase::$output	public	property	Stores the rendered output of the display.
DisplayPluginBase::$plugins	protected	property	An array of instantiated plugins used in this display.
DisplayPluginBase::$usesAJAX	protected	property	Whether the display allows the use of AJAX or not.	2
DisplayPluginBase::$usesAreas	protected	property	Whether the display allows area plugins.	2
DisplayPluginBase::$usesAttachments	protected	property	Whether the display allows attachments.	5
DisplayPluginBase::$usesMore	protected	property	Whether the display allows the use of a 'more' link or not.	1
DisplayPluginBase::$usesOptions	protected	property	Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions	1
DisplayPluginBase::$usesPager	protected	property	Whether the display allows the use of a pager or not.	4
DisplayPluginBase::$view		property	The top object of a view. Overrides PluginBase::$view
DisplayPluginBase::acceptAttachments	public	function	Determines whether this display can use attachments.
DisplayPluginBase::access	public	function	Determine if the user has access to this display of the view.
DisplayPluginBase::ajaxEnabled	public	function	Whether the display is actually using AJAX or not.
DisplayPluginBase::attachTo	public	function	Allow displays to attach to other views.	2
DisplayPluginBase::buildOptionsForm	public	function	Provide the default form for setting options. Overrides PluginBase::buildOptionsForm	4
DisplayPluginBase::changeThemeForm	public	function	Displays the Change Theme form.
DisplayPluginBase::defaultableSections	public	function	Static member function to list which sections are defaultable and what items each section contains.	1
DisplayPluginBase::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides PluginBase::defineOptions	5
DisplayPluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
DisplayPluginBase::displaysExposed	public	function	Determine if this display should display the exposed filters widgets, so the view will know whether or not to render them.	2
DisplayPluginBase::execute	public	function	When used externally, this is how a view gets run and returns data in the format required.	6
DisplayPluginBase::executeHookMenu	public	function	If this display creates a page with a menu item, implement it here.	1
DisplayPluginBase::formatThemes	protected	function	Format a list of theme templates for output by the theme info helper.
DisplayPluginBase::getArgumentsTokens	public	function	Returns to tokens for arguments.
DisplayPluginBase::getArgumentText	public	function	Provide some helpful text for the arguments. The result should contain of an array with	1
DisplayPluginBase::getAttachedDisplays	public	function	Find out all displays which are attached to this display.
DisplayPluginBase::getFieldLabels	public	function	Retrieves a list of fields for the current display.
DisplayPluginBase::getHandler	public	function	Get the handler object for a single handler.
DisplayPluginBase::getHandlers	public	function	Get a full array of handlers for $type. This caches them.
DisplayPluginBase::getLinkDisplay	public	function	Check to see which display to use when creating links within a view using this display.
DisplayPluginBase::getOption	public	function	Intelligently get an option either from this display or from the default display, if directed to do so.
DisplayPluginBase::getPagerText	public	function	Provide some helpful text for pagers.	1
DisplayPluginBase::getPath	public	function	Return the base path to use for this display.	1
DisplayPluginBase::getPlugin	public	function	Get the instance of a plugin, for example style or row.
DisplayPluginBase::getSpecialBlocks	public	function	Provide the block system with any exposed widget blocks for this display.
DisplayPluginBase::getType	protected	function	Returns the display type that this display requires.	4
DisplayPluginBase::getUrl	public	function
DisplayPluginBase::hasPath	public	function	Check to see if the display has a 'path' field.	1
DisplayPluginBase::initDisplay	public	function		2
DisplayPluginBase::isDefaultDisplay	public	function	Determine if this display is the 'default' display which contains fallback settings	1
DisplayPluginBase::isDefaulted	public	function	Determine if a given option is set to use the default display or the current display
DisplayPluginBase::isEnabled	public	function	Whether the display is enabled.
DisplayPluginBase::isIdentifierUnique	public	function	Check if the provided identifier is unique.
DisplayPluginBase::isMoreEnabled	public	function	Whether the display is using the 'more' link or not.
DisplayPluginBase::isPagerEnabled	public	function	Whether the display is using a pager or not.
DisplayPluginBase::mergeDefaults	public	function	Merges default values for all plugin types.
DisplayPluginBase::mergeHandler	protected	function	Merges handlers default values.
DisplayPluginBase::mergePlugin	protected	function	Merges plugins default values.
DisplayPluginBase::optionLink	public	function	Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this.
DisplayPluginBase::optionsOverride	public	function	If override/revert was clicked, perform the proper toggle.
DisplayPluginBase::optionsSummary	public	function	Provide the default summary for options in the views UI.	5
DisplayPluginBase::overrideOption	public	function	Set an option and force it to be an override.
DisplayPluginBase::preExecute	public	function	Set up any variables on the view prior to execution. These are separated from execute because they are extremely common and unlikely to be overridden on an individual display.
DisplayPluginBase::preview		function	Fully render the display for the purposes of a live preview or some other AJAXy reason.	3
DisplayPluginBase::query	public	function	Inject anything into the query that the display handler needs. Overrides PluginBase::query	1
DisplayPluginBase::remove	public	function	Reacts on deleting a display.	1
DisplayPluginBase::render	public	function	Render this display.	3
DisplayPluginBase::renderArea	public	function	Render one of the available areas.
DisplayPluginBase::renderFilters	public	function	Not all display plugins will support filtering
DisplayPluginBase::renderMoreLink	public	function	Render the 'more' link
DisplayPluginBase::renderPager	public	function	Not all display plugins will suppert pager rendering.	1
DisplayPluginBase::rescanThemes	public	function	Submit hook to clear Drupal's theme registry (thereby triggering a templates rescan).
DisplayPluginBase::setOption	public	function	Intelligently set an option either from this display or from the default display, if directed to do so.
DisplayPluginBase::setOverride	public	function	Flip the override setting for the given section.
DisplayPluginBase::submitOptionsForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides PluginBase::submitOptionsForm	4
DisplayPluginBase::useGroupBy	public	function	Does the display have groupby enabled?
DisplayPluginBase::useMoreAlways	public	function	Should the enabled display more link be shown when no more items?
DisplayPluginBase::useMoreText	public	function	Does the display have custom link text?
DisplayPluginBase::usesAJAX	public	function	Whether the display allows the use of AJAX or not.	2
DisplayPluginBase::usesAreas	public	function	Returns whether the display can use areas.	2
DisplayPluginBase::usesAttachments	public	function	Returns whether the display can use attachments.	5
DisplayPluginBase::usesBreadcrumb	public	function	Check to see if the display needs a breadcrumb	1
DisplayPluginBase::usesExposed	public	function	Determine if this display uses exposed filters, so the view will know whether or not to build them.	4
DisplayPluginBase::usesExposedFormInBlock	public	function	Check to see if the display can put the exposed formin a block.
DisplayPluginBase::usesFields	public	function	Determine if the display's style uses fields.
DisplayPluginBase::usesLinkDisplay	public	function	Check to see if the display has some need to link to another display.	1
DisplayPluginBase::usesMore	public	function	Whether the display allows the use of a 'more' link or not.	1
DisplayPluginBase::usesPager	public	function	Whether the display allows the use of a pager or not.	4
DisplayPluginBase::validate	public	function	Make sure the display and all associated handlers are valid. Overrides PluginBase::validate	2
DisplayPluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm	2
DisplayPluginBase::viewExposedFormBlocks	public	function	Render the exposed form as block.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements.
PluginBase::getPluginDefinition	public	function	Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced.
PluginBase::init	public	function	Initialize the plugin.	8
PluginBase::pluginTitle	public	function	Return the human readable name of the display.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display.	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style.	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions	public	function	Returns the usesOptions property.	8
PluginBase::__construct	public	function	Constructs a Plugin object. Overrides PluginBase::__construct