abstract class ViewsBuilderBase in Views Templates 8

Base builder for View Templates.

This class get Views information for Plugin definition. Extending classes can use derivatives to make many plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\views_templates\Plugin\ViewsBuilderBase implements ViewsBuilderPluginInterface

1 file declares its use of ViewsBuilderBase

NodeViewBuilder.php in tests/modules/views_templates_builder_test/src/Plugin/ViewsTemplateBuilder/NodeViewBuilder.php

File

src/Plugin/ViewsBuilderBase.php, line 15

Namespace

Drupal\views_templates\Plugin

abstract class ViewsBuilderBase extends PluginBase implements ViewsBuilderPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function getBaseTable() {
    return $this
      ->getDefinitionValue('base_table');
  }

  /**
   * {@inheritdoc}
   */
  public function getAdminLabel() {
    return $this
      ->getDefinitionValue('admin_label');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->getDefinitionValue('description');
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinitionValue($key) {
    $def = $this
      ->getPluginDefinition();
    if (isset($def[$key])) {
      return $def[$key];
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function createView($options = NULL) {
    $view_values = [
      'id' => $options['id'],
      'label' => $options['label'],
      'description' => $options['description'],
      'base_table' => $this
        ->getBaseTable(),
    ];
    return View::create($view_values);
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function templateExists() {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
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::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.
ViewsBuilderBase::buildConfigurationForm	public	function	Return form elements of extra configuration when adding View from template. Overrides ViewsBuilderPluginInterface::buildConfigurationForm	1
ViewsBuilderBase::createView	public	function	Create a View. Don't save it. Overrides ViewsBuilderPluginInterface::createView	2
ViewsBuilderBase::getAdminLabel	public	function	Get template admin label. Overrides ViewsBuilderPluginInterface::getAdminLabel	1
ViewsBuilderBase::getBaseTable	public	function	Returns base table id. Overrides ViewsBuilderPluginInterface::getBaseTable
ViewsBuilderBase::getDefinitionValue	public	function	Get a value from the plugin definition. Overrides ViewsBuilderPluginInterface::getDefinitionValue
ViewsBuilderBase::getDescription	public	function	Get template description. Overrides ViewsBuilderPluginInterface::getDescription	1
ViewsBuilderBase::templateExists	public	function	Determine if a template exists. Overrides ViewsBuilderPluginInterface::templateExists	1