class Reset in Display Suite 8.4

Plugin for the reset field template.

Plugin annotation

@DsFieldTemplate(
  id = "reset",
  title = @Translation("Full reset"),
  theme = "ds_field_reset",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ds\Plugin\DsFieldTemplate\DsFieldTemplateBase implements DsFieldTemplateInterface
      • class \Drupal\ds\Plugin\DsFieldTemplate\Reset

1 string reference to 'Reset'

views.view.ds-testing.yml in tests/modules/ds_test/test_views/views.view.ds-testing.yml

tests/modules/ds_test/test_views/views.view.ds-testing.yml

File

src/Plugin/DsFieldTemplate/Reset.php, line 14

Namespace

Drupal\ds\Plugin\DsFieldTemplate

class Reset extends DsFieldTemplateBase {

  /**
   * {@inheritdoc}
   */
  public function alterForm(&$form) {
    $config = $this
      ->getConfiguration();
    $form['lb'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#size' => '10',
      '#default_value' => $config['lb'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = [];
    $config['lb'] = '';
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function massageRenderValues(&$field_settings, $values) {
    if (!empty($values['lb'])) {
      $field_settings['lb'] = $values['lb'];
    }
  }

}

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
DsFieldTemplateBase::$entity	protected	property	The entity used for token replacement.
DsFieldTemplateBase::getConfiguration	public	function	Get the selected configuration. Overrides DsFieldTemplateInterface::getConfiguration
DsFieldTemplateBase::getEntity	public	function	Gets the entity this layout belongs too. Overrides DsFieldTemplateInterface::getEntity
DsFieldTemplateBase::getThemeFunction	public	function	Gets the chosen theme function. Overrides DsFieldTemplateInterface::getThemeFunction
DsFieldTemplateBase::setConfiguration	public	function	Set the configuration for this layout. Overrides DsFieldTemplateInterface::setConfiguration
DsFieldTemplateBase::setEntity	public	function	Sets the entity this layout belong too. Overrides DsFieldTemplateInterface::setEntity
DsFieldTemplateBase::__construct	public	function	Constructs a Display Suite field plugin. Overrides PluginBase::__construct
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.
Reset::alterForm	public	function	Lets you add you add additional form element for your layout. Overrides DsFieldTemplateBase::alterForm
Reset::defaultConfiguration	public	function	Creates default configuration for the layout. Overrides DsFieldTemplateBase::defaultConfiguration
Reset::massageRenderValues	public	function	Massages the values before they get rendered. Overrides DsFieldTemplateBase::massageRenderValues
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.