class LeafletAttachment in Leaflet 8

Same name and namespace in other branches

2.1.x modules/leaflet_views/src/Plugin/views/display/LeafletAttachment.php \Drupal\leaflet_views\Plugin\views\display\LeafletAttachment
2.0.x modules/leaflet_views/src/Plugin/views/display/LeafletAttachment.php \Drupal\leaflet_views\Plugin\views\display\LeafletAttachment

Plugin attachment of additional leaflet features to leaflet map views.

@ViewsDisplay( id = "leaflet_attachment", title = @Translation("Leaflet Attachment"), help = @Translation("Add additional markers to a leaflet map."), no_ui = TRUE )

@todo We only use very few features from the parent class Attachment, so this should probably just extend DisplayPluginBase to simplify things.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\display\DisplayPluginBase implements DependentPluginInterface, DisplayPluginInterface uses PluginDependencyTrait
    class \Drupal\views\Plugin\views\display\Attachment
    class \Drupal\leaflet_views\Plugin\views\display\LeafletAttachment

Expanded class hierarchy of LeafletAttachment

File

modules/leaflet_views/src/Plugin/views/display/LeafletAttachment.php, line 23

Namespace

Drupal\leaflet_views\Plugin\views\display

View source

class LeafletAttachment extends Attachment {

  /**
   * Whether the display allows the use of a pager or not.
   *
   * @var bool
   */
  protected $usesPager = FALSE;

  /**
   * Whether the display allows the use of a 'more' link or not.
   *
   * @var bool
   */
  protected $usesMore = FALSE;

  /**
   * Whether the display allows area plugins.
   *
   * @var bool
   */
  protected $usesAreas = FALSE;

  /**
   * {@inheritdoc}
   */
  public function usesLinkDisplay() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function attachTo(ViewExecutable $view, $display_id, array &$build) {
    $displays = $this
      ->getOption('displays');
    if (empty($displays[$display_id])) {
      return;
    }
    if (!$this
      ->access()) {
      return;
    }
    $args = $this
      ->getOption('inherit_arguments') ? $this->view->args : [];
    $view
      ->setArguments($args);
    $view
      ->setDisplay($this->display['id']);
    if ($this
      ->getOption('inherit_pager')) {
      $view->display_handler->usesPager = $this->view->displayHandlers
        ->get($display_id)
        ->usesPager();
      $view->display_handler
        ->setOption('pager', $this->view->displayHandlers
        ->get($display_id)
        ->getOption('pager'));
    }
    if ($render = $view
      ->render()) {
      $this->view->attachment_before[] = $render + [
        '#leaflet-attachment' => TRUE,
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $rows = !empty($this->view->result) || $this->view->style_plugin
      ->evenEmpty() ? $this->view->style_plugin
      ->render($this->view->result) : [];

    // The element is rendered during preview only; when used as an attachment
    // in the Leaflet class, only the 'rows' property is used.
    $element = [
      '#markup' => print_r($rows, TRUE),
      '#prefix' => '<pre>',
      '#suffix' => '</pre>',
      '#attached' => &$this->view->element['#attached'],
      'rows' => $rows,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function getType() {
    return 'leaflet';
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();

    // Overrides for standard stuff.
    $options['style']['contains']['type']['default'] = 'leaflet_marker_default';
    $options['defaults']['default']['style'] = FALSE;
    $options['row']['contains']['type']['default'] = 'leaflet_marker';
    $options['defaults']['default']['row'] = FALSE;
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Attachment::attachmentPositions	public	function
Attachment::buildOptionsForm	public	function	Provide the default form for setting options. Overrides DisplayPluginBase::buildOptionsForm
Attachment::displaysExposed	public	function	If an attachment is set to inherit the exposed filter settings from its parent display, then don't render and display a second set of exposed filter widgets. Overrides DisplayPluginBase::displaysExposed
Attachment::execute	public	function	Executes the view and returns data in the format required. Overrides DisplayPluginBase::execute
Attachment::optionsSummary	public	function	Provide the summary for attachment options in the views UI. Overrides DisplayPluginBase::optionsSummary
Attachment::renderPager	public	function	Checks to see if the display plugins support pager rendering. Overrides DisplayPluginBase::renderPager
Attachment::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 DisplayPluginBase::submitOptionsForm
Attachment::usesExposed	public	function	Attachment displays only use exposed widgets if they are set to inherit the exposed filter settings of their parent display. Overrides DisplayPluginBase::usesExposed
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DisplayPluginBase::$display	public	property	The display information coming directly from the view entity.
DisplayPluginBase::$extenders	protected	property	Stores all available display extenders.
DisplayPluginBase::$handlers	public	property	An array of instantiated handlers used in this display.
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::$unpackOptions	protected static	property	Static cache for unpackOptions, but not if we are in the UI.
DisplayPluginBase::$usesAJAX	protected	property	Whether the display allows the use of AJAX or not.	2
DisplayPluginBase::$usesAttachments	protected	property	Whether the display allows attachments.	6
DisplayPluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions	1
DisplayPluginBase::$view	public	property	The top object of a view. Overrides PluginBase::$view
DisplayPluginBase::acceptAttachments	public	function	Determines whether this display can use attachments. Overrides DisplayPluginInterface::acceptAttachments
DisplayPluginBase::access	public	function	Determines if the user has access to this display of the view. Overrides DisplayPluginInterface::access
DisplayPluginBase::ajaxEnabled	public	function	Whether the display is actually using AJAX or not. Overrides DisplayPluginInterface::ajaxEnabled
DisplayPluginBase::applyDisplayCachablityMetadata Deprecated	protected	function	Applies the cacheability of the current display to the given render array.
DisplayPluginBase::applyDisplayCacheabilityMetadata	protected	function	Applies the cacheability of the current display to the given render array.
DisplayPluginBase::buildBasicRenderable	public static	function	Builds a basic render array which can be properly render cached. Overrides DisplayPluginInterface::buildBasicRenderable	1
DisplayPluginBase::buildRenderable	public	function	Builds a renderable array of the view. Overrides DisplayPluginInterface::buildRenderable	1
DisplayPluginBase::buildRenderingLanguageOptions	protected	function	Returns the available rendering strategies for language-aware entities.
DisplayPluginBase::calculateCacheMetadata	public	function	Calculates the display's cache metadata by inspecting each handler/plugin. Overrides DisplayPluginInterface::calculateCacheMetadata
DisplayPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies	3
DisplayPluginBase::defaultableSections	public	function	Lists the 'defaultable' sections and what items each section contains. Overrides DisplayPluginInterface::defaultableSections	1
DisplayPluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
DisplayPluginBase::elementPreRender	public	function	#pre_render callback for view display rendering. Overrides DisplayPluginInterface::elementPreRender
DisplayPluginBase::getAllHandlers	protected	function	Gets all the handlers used by the display.
DisplayPluginBase::getAllPlugins	protected	function	Gets all the plugins used by the display.
DisplayPluginBase::getArgumentsTokens	public	function	Returns to tokens for arguments. Overrides DisplayPluginInterface::getArgumentsTokens
DisplayPluginBase::getArgumentText	public	function	Provides help text for the arguments. Overrides DisplayPluginInterface::getArgumentText	1
DisplayPluginBase::getAttachedDisplays	public	function	Find out all displays which are attached to this display. Overrides DisplayPluginInterface::getAttachedDisplays
DisplayPluginBase::getCacheMetadata	public	function	Gets the cache metadata. Overrides DisplayPluginInterface::getCacheMetadata
DisplayPluginBase::getExtenders	public	function	Gets the display extenders. Overrides DisplayPluginInterface::getExtenders
DisplayPluginBase::getFieldLabels	public	function	Retrieves a list of fields for the current display. Overrides DisplayPluginInterface::getFieldLabels
DisplayPluginBase::getHandler	public	function	Get the handler object for a single handler. Overrides DisplayPluginInterface::getHandler
DisplayPluginBase::getHandlers	public	function	Get a full array of handlers for $type. This caches them. Overrides DisplayPluginInterface::getHandlers
DisplayPluginBase::getLinkDisplay	public	function	Returns the ID of the display to use when making links. Overrides DisplayPluginInterface::getLinkDisplay
DisplayPluginBase::getMoreUrl	protected	function	Get the more URL for this view.
DisplayPluginBase::getOption	public	function	Gets an option, from this display or the default display. Overrides DisplayPluginInterface::getOption
DisplayPluginBase::getPagerText	public	function	Provides help text for pagers. Overrides DisplayPluginInterface::getPagerText	1
DisplayPluginBase::getPath	public	function	Returns the base path to use for this display. Overrides DisplayPluginInterface::getPath	1
DisplayPluginBase::getPlugin	public	function	Get the instance of a plugin, for example style or row. Overrides DisplayPluginInterface::getPlugin
DisplayPluginBase::getRoutedDisplay	public	function	Points to the display which can be linked by this display. Overrides DisplayPluginInterface::getRoutedDisplay
DisplayPluginBase::getSpecialBlocks	public	function	Provides the block system with any exposed widget blocks for this display. Overrides DisplayPluginInterface::getSpecialBlocks
DisplayPluginBase::getUrl	public	function	Returns a URL to $this display or its configured linked display. Overrides DisplayPluginInterface::getUrl
DisplayPluginBase::hasPath	public	function	Checks to see if the display has a 'path' field. Overrides DisplayPluginInterface::hasPath	1
DisplayPluginBase::initDisplay	public	function	Initializes the display plugin. Overrides DisplayPluginInterface::initDisplay	1
DisplayPluginBase::isBaseTableTranslatable	protected	function	Returns whether the base table is of a translatable entity type.
DisplayPluginBase::isDefaultDisplay	public	function	Determines if this display is the 'default' display. Overrides DisplayPluginInterface::isDefaultDisplay	1
DisplayPluginBase::isDefaulted	public	function	Determines if an option is set to use the default or current display. Overrides DisplayPluginInterface::isDefaulted
DisplayPluginBase::isEnabled	public	function	Whether the display is enabled. Overrides DisplayPluginInterface::isEnabled
DisplayPluginBase::isIdentifierUnique	public	function	Checks if the provided identifier is unique. Overrides DisplayPluginInterface::isIdentifierUnique
DisplayPluginBase::isMoreEnabled	public	function	Whether the display is using the 'more' link or not. Overrides DisplayPluginInterface::isMoreEnabled
DisplayPluginBase::isPagerEnabled	public	function	Whether the display is using a pager or not. Overrides DisplayPluginInterface::isPagerEnabled
DisplayPluginBase::mergeDefaults	public	function	Merges default values for all plugin types. Overrides DisplayPluginInterface::mergeDefaults
DisplayPluginBase::mergeHandler	protected	function	Merges handlers default values.
DisplayPluginBase::mergePlugin	protected	function	Merges plugins default values.
DisplayPluginBase::newDisplay	public	function	Reacts on adding a display. Overrides DisplayPluginInterface::newDisplay	1
DisplayPluginBase::optionLink	public	function	Returns a link to a section of a form. Overrides DisplayPluginInterface::optionLink
DisplayPluginBase::optionsOverride	public	function	If override/revert was clicked, perform the proper toggle. Overrides DisplayPluginInterface::optionsOverride
DisplayPluginBase::outputIsEmpty	public	function	Is the output of the view empty. Overrides DisplayPluginInterface::outputIsEmpty
DisplayPluginBase::overrideOption	public	function	Set an option and force it to be an override. Overrides DisplayPluginInterface::overrideOption
DisplayPluginBase::preExecute	public	function	Sets up any variables on the view prior to execution. Overrides DisplayPluginInterface::preExecute
DisplayPluginBase::preview	public	function	Renders the display for the purposes of a live preview. Overrides DisplayPluginInterface::preview	3
DisplayPluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	1
DisplayPluginBase::remove	public	function	Reacts on deleting a display. Overrides DisplayPluginInterface::remove	2
DisplayPluginBase::renderArea	public	function	Renders one of the available areas. Overrides DisplayPluginInterface::renderArea
DisplayPluginBase::renderFilters	public	function	Does nothing (obsolete function). Overrides DisplayPluginInterface::renderFilters
DisplayPluginBase::renderMoreLink	public	function	Renders the 'more' link. Overrides DisplayPluginInterface::renderMoreLink
DisplayPluginBase::setOption	public	function	Sets an option, on this display or the default display. Overrides DisplayPluginInterface::setOption
DisplayPluginBase::setOverride	public	function	Flip the override setting for the given section. Overrides DisplayPluginInterface::setOverride
DisplayPluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
DisplayPluginBase::useGroupBy	public	function	Does the display have groupby enabled? Overrides DisplayPluginInterface::useGroupBy
DisplayPluginBase::useMoreAlways	public	function	Should the enabled display more link be shown when no more items? Overrides DisplayPluginInterface::useMoreAlways
DisplayPluginBase::useMoreText	public	function	Does the display have custom link text? Overrides DisplayPluginInterface::useMoreText
DisplayPluginBase::usesAJAX	public	function	Whether the display allows the use of AJAX or not. Overrides DisplayPluginInterface::usesAJAX	2
DisplayPluginBase::usesAreas	public	function	Returns whether the display can use areas. Overrides DisplayPluginInterface::usesAreas	2
DisplayPluginBase::usesAttachments	public	function	Returns whether the display can use attachments. Overrides DisplayPluginInterface::usesAttachments	6
DisplayPluginBase::usesExposedFormInBlock	public	function	Checks to see if the display can put the exposed form in a block. Overrides DisplayPluginInterface::usesExposedFormInBlock
DisplayPluginBase::usesFields	public	function	Determines if the display's style uses fields. Overrides DisplayPluginInterface::usesFields
DisplayPluginBase::usesMore	public	function	Whether the display allows the use of a 'more' link or not. Overrides DisplayPluginInterface::usesMore	1
DisplayPluginBase::usesPager	public	function	Whether the display allows the use of a pager or not. Overrides DisplayPluginInterface::usesPager	4
DisplayPluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides PluginBase::validate	3
DisplayPluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm	2
DisplayPluginBase::viewExposedFormBlocks	public	function	Renders the exposed form as block. Overrides DisplayPluginInterface::viewExposedFormBlocks
DisplayPluginBase::__construct	public	function	Constructs a new DisplayPluginBase object. Overrides PluginBase::__construct	3
LeafletAttachment::$usesAreas	protected	property	Whether the display allows area plugins. Overrides DisplayPluginBase::$usesAreas
LeafletAttachment::$usesMore	protected	property	Whether the display allows the use of a 'more' link or not. Overrides DisplayPluginBase::$usesMore
LeafletAttachment::$usesPager	protected	property	Whether the display allows the use of a pager or not. Overrides Attachment::$usesPager
LeafletAttachment::attachTo	public	function	Allows displays to attach to other views. Overrides Attachment::attachTo
LeafletAttachment::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides Attachment::defineOptions
LeafletAttachment::getType	public	function	Returns the display type that this display requires. Overrides DisplayPluginBase::getType
LeafletAttachment::render	public	function	Renders this display. Overrides DisplayPluginBase::render
LeafletAttachment::usesLinkDisplay	public	function	Checks to see if the display has some need to link to another display. Overrides DisplayPluginBase::usesLinkDisplay
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	62
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::init	public	function	Initialize the plugin. Overrides ViewsPluginInterface::init	8
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
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. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class LeafletAttachment in Leaflet 8

Hierarchy

File

Namespace

Members

API Navigation