You are here

class TokenFieldForm in Display Suite 8.2

Same name and namespace in other branches
  1. 8.4 src/Form/TokenFieldForm.php \Drupal\ds\Form\TokenFieldForm
  2. 8.3 src/Form/TokenFieldForm.php \Drupal\ds\Form\TokenFieldForm

Configures token fields.

Hierarchy

Expanded class hierarchy of TokenFieldForm

1 file declares its use of TokenFieldForm
DynamicTokenField.php in src/Plugin/Derivative/DynamicTokenField.php
1 string reference to 'TokenFieldForm'
ds.routing.yml in ./ds.routing.yml
ds.routing.yml

File

src/Form/TokenFieldForm.php, line 10

Namespace

Drupal\ds\Form
View source
class TokenFieldForm extends FieldFormBase {

  /**
   * The type of the dynamic ds field.
   */
  const TYPE = 'token';

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'ds_field_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $field_key = '') {
    $form = parent::buildForm($form, $form_state, $field_key);
    $field = $this->field;
    $form['content'] = array(
      '#type' => 'text_format',
      '#title' => $this
        ->t('Field content'),
      '#default_value' => isset($field['properties']['content']['value']) ? $field['properties']['content']['value'] : '',
      '#format' => isset($field['properties']['content']['format']) ? $field['properties']['content']['format'] : 'plain_text',
      '#base_type' => 'textarea',
      '#required' => TRUE,
    );

    // Token support.
    if (\Drupal::moduleHandler()
      ->moduleExists('token')) {
      $form['tokens'] = array(
        '#title' => $this
          ->t('Tokens'),
        '#type' => 'container',
        '#states' => array(
          'invisible' => array(
            'input[name="use_token"]' => array(
              'checked' => FALSE,
            ),
          ),
        ),
      );
      $form['tokens']['help'] = array(
        '#theme' => 'token_tree_link',
        '#token_types' => 'all',
        '#global_types' => FALSE,
        '#dialog' => TRUE,
      );
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getProperties(FormStateInterface $form_state) {
    return array(
      'content' => $form_state
        ->getValue('content'),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getType() {
    return TokenFieldForm::TYPE;
  }

  /**
   * {@inheritdoc}
   */
  public function getTypeLabel() {
    return 'Token field';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
FieldFormBase::$cacheInvalidator protected property Holds the cache invalidator.
FieldFormBase::$entityTypeManager protected property Holds the entity type manager.
FieldFormBase::$field protected property The field properties.
FieldFormBase::$moduleHandler protected property Drupal module handler.
FieldFormBase::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create 1
FieldFormBase::finishSubmitForm public function Finishes the submit.
FieldFormBase::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FieldFormBase::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm 2
FieldFormBase::uniqueFieldName public function Returns whether a field machine name is unique.
FieldFormBase::__construct public function Constructs a \Drupal\system\CustomFieldFormBase object. Overrides ConfigFormBase::__construct 1
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
TokenFieldForm::buildForm public function Form constructor. Overrides FieldFormBase::buildForm
TokenFieldForm::getFormId public function Returns a unique string identifying the form. Overrides FieldFormBase::getFormId
TokenFieldForm::getProperties public function Returns the properties for the custom field. Overrides FieldFormBase::getProperties
TokenFieldForm::getType public function Returns the type of the field. Overrides FieldFormBase::getType
TokenFieldForm::getTypeLabel public function Returns the admin label for the field on the field overview page. Overrides FieldFormBase::getTypeLabel
TokenFieldForm::TYPE constant The type of the dynamic ds field.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.