You are here

class ViewsReferenceTitle in Views Reference Field 8.2

The views reference setting title plugin.

Plugin annotation


@ViewsReferenceSetting(
  id = "title",
  label = @Translation("Include View Title"),
  default_value = 0,
)

Hierarchy

Expanded class hierarchy of ViewsReferenceTitle

File

src/Plugin/ViewsReferenceSetting/ViewsReferenceTitle.php, line 19

Namespace

Drupal\viewsreference\Plugin\ViewsReferenceSetting
View source
class ViewsReferenceTitle extends PluginBase implements ViewsReferenceSettingInterface {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function alterFormField(array &$form_field) {
    $form_field['#type'] = 'checkbox';
    $form_field['#weight'] = 20;
  }

  /**
   * {@inheritdoc}
   */
  public function alterView(ViewExecutable $view, $value) {
    if (empty($value)) {
      $view->display_handler
        ->setOption('title', '');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
ViewsReferenceTitle::alterFormField public function Get the form field array. Overrides ViewsReferenceSettingInterface::alterFormField
ViewsReferenceTitle::alterView public function Alter the view object. Overrides ViewsReferenceSettingInterface::alterView