Drupal 8  8.0.2
Links Class Reference
Inheritance diagram for Links:

Public Member Functions

 usesGroupBy ()
 
 defineOptions ()
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 query ()
 
- Public Member Functions inherited from FieldPluginBase
 init (ViewExecutable $view, DisplayPluginBase $display, array &$options=NULL)
 
 query ()
 
 clickSort ($order)
 
 clickSortable ()
 
 label ()
 
 elementType ($none_supported=FALSE, $default_empty=FALSE, $inline=FALSE)
 
 elementLabelType ($none_supported=FALSE, $default_empty=FALSE)
 
 elementWrapperType ($none_supported=FALSE, $default_empty=FALSE)
 
 getElements ()
 
 elementClasses ($row_index=NULL)
 
 tokenizeValue ($value, $row_index=NULL)
 
 elementLabelClasses ($row_index=NULL)
 
 elementWrapperClasses ($row_index=NULL)
 
 getEntity (ResultRow $values)
 
 getValue (ResultRow $values, $field=NULL)
 
 useStringGroupBy ()
 
 submitOptionsForm (&$form, FormStateInterface $form_state)
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 adminSummary ()
 
 preRender (&$values)
 
 render (ResultRow $values)
 
 postRender (ResultRow $row, $output)
 
 advancedRender (ResultRow $values)
 
 isValueEmpty ($value, $empty_zero, $no_skip_empty=TRUE)
 
 renderText ($alter)
 
 theme (ResultRow $values)
 
 themeFunctions ()
 
 adminLabel ($short=FALSE)
 
- Public Member Functions inherited from HandlerBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 init (ViewExecutable $view, DisplayPluginBase $display, array &$options=NULL)
 
 adminLabel ($short=FALSE)
 
 getField ($field=NULL)
 
 sanitizeValue ($value, $type=NULL)
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 setModuleHandler (ModuleHandlerInterface $module_handler)
 
 usesGroupBy ()
 
 buildGroupByForm (&$form, FormStateInterface $form_state)
 
 submitGroupByForm (&$form, FormStateInterface $form_state)
 
 hasExtraOptions ()
 
 defineExtraOptions (&$option)
 
 buildExtraOptionsForm (&$form, FormStateInterface $form_state)
 
 validateExtraOptionsForm ($form, FormStateInterface $form_state)
 
 submitExtraOptionsForm ($form, FormStateInterface $form_state)
 
 canExpose ()
 
 defaultExposeOptions ()
 
 exposedInfo ()
 
 buildExposedForm (&$form, FormStateInterface $form_state)
 
 validateExposed (&$form, FormStateInterface $form_state)
 
 submitExposed (&$form, FormStateInterface $form_state)
 
 buildExposeForm (&$form, FormStateInterface $form_state)
 
 validateExposeForm ($form, FormStateInterface $form_state)
 
 submitExposeForm ($form, FormStateInterface $form_state)
 
 showExposeButton (&$form, FormStateInterface $form_state)
 
 showExposeForm (&$form, FormStateInterface $form_state)
 
 access (AccountInterface $account)
 
 preQuery ()
 
 query ()
 
 postExecute (&$values)
 
 setRelationship ()
 
 ensureMyTable ()
 
 adminSummary ()
 
 isExposed ()
 
 isAGroup ()
 
 multipleExposedInput ()
 
 acceptExposedInput ($input)
 
 storeExposedInput ($input, $status)
 
 getJoin ()
 
 validate ()
 
 broken ()
 
 getDateFormat ($format)
 
 getDateField ()
 
 setViewsData (ViewsData $views_data)
 
 getEntityType ()
 
 displayExposedForm ($form, FormStateInterface $form_state)
 
 submitTemporaryForm ($form, FormStateInterface $form_state)
 
- 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 FieldHandlerInterface
 getRenderTokens ($item)
 

Protected Member Functions

 getLinks ()
 
- Protected Member Functions inherited from FieldPluginBase
 allowAdvancedRender ()
 
 addAdditionalFields ($fields=NULL)
 
 defineOptions ()
 
 getPreviousFieldLabels ()
 
 renderAltered ($alter, $tokens)
 
 renderTrimText ($alter, $value)
 
 renderAsLink ($alter, $text, $tokens)
 
 getFieldTokenPlaceholder ()
 
 getTokenValuesRecursive (array $array, array $parent_keys=array())
 
 addSelfTokens (&$tokens, $item)
 
 documentSelfTokens (&$tokens)
 
 linkGenerator ()
 
 getRenderer ()
 
- Protected Member Functions inherited from HandlerBase
 defineOptions ()
 
 caseTransform ($string, $option)
 
 getModuleHandler ()
 
 placeholder ()
 
 getViewsData ()
 
- 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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from FieldPluginBase
static trimText ($alter, $value)
 
- Static Public Member Functions inherited from HandlerBase
static getTableJoin ($table, $base_table)
 
static breakString ($str, $force_int=FALSE)
 
- 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 FieldPluginBase
const RENDER_TEXT_PHASE_SINGLE_ITEM = 0
 
const RENDER_TEXT_PHASE_COMPLETELY = 1
 
const RENDER_TEXT_PHASE_EMPTY = 2
 
 $field_alias = 'unknown'
 
 $aliases = array()
 
 $original_value = NULL
 
 $additional_fields = array()
 
- Data Fields inherited from HandlerBase
 $query = NULL
 
 $table
 
 $tableAlias
 
 $actualTable
 
 $realField
 
 $field
 
 $actualField
 
 $relationship = NULL
 
- Data Fields inherited from PluginBase
const INCLUDE_NEGOTIATED = 16
 
const INCLUDE_ENTITY = 32
 
const VIEWS_QUERY_LANGUAGE_SITE_DEFAULT = '***LANGUAGE_site_default***'
 
 $options = array()
 
 $view = NULL
 
 $displayHandler
 
 $definition
 
- Protected Attributes inherited from FieldPluginBase
 $linkGenerator
 
 $renderer
 
- Protected Attributes inherited from HandlerBase
 $moduleHandler
 
 $viewsData
 
- Protected Attributes inherited from PluginBase
 $usesOptions = FALSE
 
 $renderer
 

Detailed Description

A abstract handler which provides a collection of links.

Member Function Documentation

buildOptionsForm ( $form,
FormStateInterface  $form_state 
)

{Provide a form to edit options for this plugin.}

Implements ViewsPluginInterface.

References FieldPluginBase\getPreviousFieldLabels(), and t().

Here is the call graph for this function:

defineOptions ( )

{}

getLinks ( )
protected

Gets the list of links used by this field.

Returns
array The links which are used by the render function.

References Html\decodeEntities(), Drupal\destination(), FieldHandlerInterface\getRenderTokens(), and PluginBase\viewsTokenReplace().

Referenced by Dropbutton\render().

Here is the call graph for this function:

Here is the caller graph for this function:

query ( )

{Add anything to the query that we might need to.}

Implements ViewsPluginInterface.

usesGroupBy ( )

{}


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