Drupal 8  8.0.2
EntityReference Class Reference
Inheritance diagram for EntityReference:

Public Member Functions

 optionsSummary (&$categories, &$options)
 getType ()
 execute ()
 render ()
 usesExposed ()
 query ()
 validate ()
- Public Member Functions inherited from DisplayPluginBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 destroy ()
 isDefaultDisplay ()
 usesExposed ()
 displaysExposed ()
 usesAJAX ()
 ajaxEnabled ()
 isEnabled ()
 usesPager ()
 isPagerEnabled ()
 usesMore ()
 isMoreEnabled ()
 useGroupBy ()
 useMoreAlways ()
 useMoreText ()
 acceptAttachments ()
 usesAttachments ()
 usesAreas ()
 attachTo (ViewExecutable $view, $display_id, array &$build)
 defaultableSections ($section=NULL)
 hasPath ()
 usesLinkDisplay ()
 usesExposedFormInBlock ()
 getAttachedDisplays ()
 getLinkDisplay ()
 getPath ()
 getRoutedDisplay ()
 getUrl ()
 isDefaulted ($option)
 getOption ($option)
 usesFields ()
 getPlugin ($type)
getHandler ($type, $id)
getHandlers ($type)
 calculateDependencies ()
 getFieldLabels ($groupable_only=FALSE)
 setOption ($option, $value)
 overrideOption ($option, $value)
 optionLink ($text, $section, $class= '', $title= '')
 getArgumentsTokens ()
 optionsSummary (&$categories, &$options)
 buildOptionsForm (&$form, FormStateInterface $form_state)
 validateOptionsForm (&$form, FormStateInterface $form_state)
 optionsOverride ($form, FormStateInterface $form_state)
 setOverride ($section, $new_state=NULL)
 query ()
 renderFilters ()
 renderPager ()
 renderMoreLink ()
 render ()
 elementPreRender (array $element)
 renderArea ($area, $empty=FALSE)
 preExecute ()
 getCacheMetadata ()
 execute ()
 buildRenderable (array $args=[], $cache=TRUE)
 preview ()
 getType ()
 validate ()
 newDisplay ()
 isIdentifierUnique ($id, $identifier)
 outputIsEmpty ()
 getSpecialBlocks ()
 viewExposedFormBlocks ()
 getArgumentText ()
 getPagerText ()
 mergeDefaults ()
 remove ()
 getExtenders ()
- Public Member Functions inherited from PluginBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 init (ViewExecutable $view, DisplayPluginBase $display, array &$options=NULL)
 filterByDefinedOptions (array &$storage)
 unpackOptions (&$storage, $options, $definition=NULL, $all=TRUE, $check=TRUE)
 destroy ()
 buildOptionsForm (&$form, FormStateInterface $form_state)
 validateOptionsForm (&$form, FormStateInterface $form_state)
 submitOptionsForm (&$form, FormStateInterface $form_state)
 query ()
 themeFunctions ()
 validate ()
 summaryTitle ()
 pluginTitle ()
 usesOptions ()
 globalTokenReplace ($string= '', array $options=array())
 getAvailableGlobalTokens ($prepared=FALSE, array $types=array())
 globalTokenForm (&$form, FormStateInterface $form_state)
 calculateDependencies ()
 getProvider ()
- Public Member Functions inherited from PluginInspectionInterface
 getPluginId ()
 getPluginDefinition ()
- Public Member Functions inherited from DerivativeInspectionInterface
 getBaseId ()
 getDerivativeId ()
- Public Member Functions inherited from DisplayPluginInterface
 initDisplay (ViewExecutable $view, array &$display, array &$options=NULL)
 submitOptionsForm (&$form, FormStateInterface $form_state)
 access (AccountInterface $account=NULL)
 calculateCacheMetadata ()

Protected Member Functions

 defineOptions ()
- Protected Member Functions inherited from DisplayPluginBase
 defineOptions ()
 getAllHandlers ($only_overrides=FALSE)
 getAllPlugins ($only_overrides=FALSE)
 mergePlugin ($type)
 mergeHandler ($type)
 buildRenderingLanguageOptions ()
 isBaseTableTranslatable ()
- Protected Member Functions inherited from PluginBase
 defineOptions ()
 setOptionDefaults (array &$storage, array $options)
 doFilterByDefinedOptions (array &$storage, array $options)
 viewsTokenReplace ($text, $tokens)
 listLanguages ($flags=LanguageInterface::STATE_ALL, array $current_values=NULL)
 getRenderer ()

Protected Attributes

 $usesAJAX = FALSE
 $usesPager = FALSE
 $usesAttachments = FALSE
- Protected Attributes inherited from DisplayPluginBase
 $plugins = array()
 $extenders = []
 $usesOptions = TRUE
 $usesAJAX = TRUE
 $usesPager = TRUE
 $usesMore = TRUE
 $usesAttachments = FALSE
 $usesAreas = TRUE
- Protected Attributes inherited from PluginBase
 $usesOptions = FALSE

Additional Inherited Members

- Static Public Member Functions inherited from DisplayPluginBase
static buildBasicRenderable ($view_id, $display_id, array $args=[])
- Static Public Member Functions inherited from PluginBase
static create (ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition)
static preRenderAddFieldsetMarkup (array $form)
static preRenderFlattenData ($form)
static queryLanguageSubstitutions ()
- Data Fields inherited from DisplayPluginBase
 $view = NULL
 $handlers = []
 $output = NULL
- Data Fields inherited from PluginBase
 $options = array()
 $view = NULL
- Static Protected Attributes inherited from DisplayPluginBase
static $unpackOptions = array()

Detailed Description

The plugin that handles an EntityReference display.

"entity_reference_display" is a custom property, used with ::getApplicableViews() to retrieve all views with a 'Entity Reference' display.

( id = "entity_reference", title = ("Entity Reference"), admin = ("Entity Reference Source"), help = ("Selects referenceable entities for an entity reference field."), theme = "views_view", register_theme = FALSE, uses_menu_links = FALSE, entity_reference_display = TRUE )

Member Function Documentation

defineOptions ( )


execute ( )

{Executes the view and returns data in the format required.The base class cannot be executed.}

Implements DisplayPluginInterface.

getType ( )

{Returns the display type that this display requires.This can be used for filtering views plugins. E.g. if a plugin category of 'foo' is specified, only plugins with no 'types' declared or 'types' containing 'foo'. If you have a type of bar, this plugin will not be used. This is applicable for style, row, access, cache, and exposed_form plugins.

string The required display type. Defaults to 'normal'.
See Also

Implements DisplayPluginInterface.

optionsSummary ( $categories,

Overrides ::optionsSummary().

Disable 'cache' and 'title' so it won't be changed.

Implements DisplayPluginInterface.

query ( )

{Injects anything into the query that the display handler needs.}

Implements DisplayPluginInterface.

References db_like(), db_or(), and DisplayPluginBase\getOption().

Here is the call graph for this function:

render ( )

{Renders this display.}

Implements DisplayPluginInterface.

usesExposed ( )

{Determines if this display uses exposed filters.}

Implements DisplayPluginInterface.

validate ( )

{Make sure the display and all associated handlers are valid.

Empty array if the display is valid; an array of error strings if it is not.

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption(), and t().

Here is the call graph for this function:

Field Documentation



$usesAttachments = FALSE


$usesPager = FALSE


The documentation for this class was generated from the following file: