class ViewsFieldTemplate in Calendar 8

Views Template for all calendar fields.

Plugin annotation

@ViewsBuilder(
 id = "calendar_field",
 module = "calendar",
 deriver = "Drupal\calendar\Plugin\Derivative\ViewsFieldTemplate"
)

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
      • class \Drupal\views_templates\Plugin\ViewsDuplicateBuilderBase implements ContainerFactoryPluginInterface, ViewsDuplicateBuilderPluginInterface
        • class \Drupal\calendar\Plugin\ViewsTemplateBuilder\ViewsFieldTemplate

File

src/Plugin/ViewsTemplateBuilder/ViewsFieldTemplate.php, line 20

Namespace

Drupal\calendar\Plugin\ViewsTemplateBuilder

class ViewsFieldTemplate extends ViewsDuplicateBuilderBase {

  /**
   * The entity field manager object.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $fieldManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ViewsTemplateLoaderInterface $loader, EntityFieldManagerInterface $manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $loader);
    $this->fieldManager = $manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('views_templates.loader'), $container
      ->get('entity_field.manager'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getReplacements($options = NULL) {
    $replacements = parent::getReplacements($options);
    if (isset($options['base_path'])) {
      $replacements['__BASE_PATH'] = $options['base_path'];
    }
    return $replacements;
  }

  /**
   * {@inheritdoc}
   */
  protected function alterViewTemplateAfterCreation(array &$view_template, array $options = NULL) {
    parent::alterViewTemplateAfterCreation($view_template, $options);
    $field_defs = $this->fieldManager
      ->getBaseFieldDefinitions($this
      ->getDefinitionValue('entity_type'));
    if (empty($field_defs['status'])) {

      // If entity doesn't have a base field status remove it from View filter.
      unset($view_template['display']['default']['display_options']['filters']['status']);
    }
    $this->fieldManager
      ->getFieldDefinitions($this
      ->getDefinitionValue('entity_type'), 'event');
    $this->fieldManager
      ->getFieldStorageDefinitions('node');
  }

  /**
   * {@inheritDoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $config_form = parent::buildConfigurationForm($form, $form_state);
    $replacements = $this
      ->getDefinitionValue('replacements');
    if (isset($replacements['base_path'])) {
      $config_form['base_path'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Base View Path'),
        '#description' => $this
          ->t('This view will be displayed by visiting this path on your site.'),
        '#default_value' => $replacements['base_path'],
        '#required' => TRUE,
      ];
    }
    return $config_form;
  }

}

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.
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::getBaseTable	public	function	Returns base table id. Overrides ViewsBuilderPluginInterface::getBaseTable
ViewsBuilderBase::getDefinitionValue	public	function	Get a value from the plugin definition. Overrides ViewsBuilderPluginInterface::getDefinitionValue
ViewsDuplicateBuilderBase::$loadedTemplate	protected	property	The loaded template.
ViewsDuplicateBuilderBase::$templateLoader	protected	property	The view template loader.
ViewsDuplicateBuilderBase::createView	public	function	Create a View. Don't save it. Overrides ViewsBuilderBase::createView
ViewsDuplicateBuilderBase::getAdminLabel	public	function	Get template admin label. Overrides ViewsBuilderBase::getAdminLabel
ViewsDuplicateBuilderBase::getDescription	public	function	Get template description. Overrides ViewsBuilderBase::getDescription
ViewsDuplicateBuilderBase::getViewTemplateId	public	function	Return the View Template id to be used by this Plugin. Overrides ViewsDuplicateBuilderPluginInterface::getViewTemplateId
ViewsDuplicateBuilderBase::loadTemplate	protected	function	Load template from service.
ViewsDuplicateBuilderBase::loadViewsTemplateValue	protected	function	Return value from template.
ViewsDuplicateBuilderBase::replaceTemplateKeyAndValues	protected	function	Recursively replace keys and values in template elements.
ViewsDuplicateBuilderBase::templateExists	public	function	Check if template exists. Overrides ViewsBuilderBase::templateExists
ViewsFieldTemplate::$fieldManager	protected	property	The entity field manager object.
ViewsFieldTemplate::alterViewTemplateAfterCreation	protected	function	After View Template has been created the Builder should alter it some how. Overrides ViewsDuplicateBuilderBase::alterViewTemplateAfterCreation
ViewsFieldTemplate::buildConfigurationForm	public	function	Return form elements of extra configuration when adding View from template. Overrides ViewsDuplicateBuilderBase::buildConfigurationForm
ViewsFieldTemplate::create	public static	function	Creates an instance of the plugin. Overrides ViewsDuplicateBuilderBase::create
ViewsFieldTemplate::getReplacements	protected	function	Get the replaces array from the plugin definition. Overrides ViewsDuplicateBuilderBase::getReplacements
ViewsFieldTemplate::__construct	public	function	Constructor to the class ViewDuplicateBuilderBase. Overrides ViewsDuplicateBuilderBase::__construct