You are here

Home » API reference » Share Message 8 » ShareMessageSettingsForm.php

class ShareMessageSettingsForm in Share Message 8

Defines a form that configures Share Message global settings.

Hierarchy

Expanded class hierarchy of ShareMessageSettingsForm

1 string reference to 'ShareMessageSettingsForm'
sharemessage.routing.yml in ./sharemessage.routing.yml
sharemessage.routing.yml

File

src/Form/ShareMessageSettingsForm.php, line 12

Namespace

Drupal\sharemessage\Form
View source 
class ShareMessageSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'sharemessage.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'sharemessage_settings_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $config = $this
      ->config('sharemessage.settings');

    // Global setting.
    $form['message_enforcement'] = [
      '#type' => 'checkbox',
      '#title' => t('Allow to enforce Share Messages'),
      '#description' => t('This will enforce loading of a Share Message if the ?smid argument is present in an URL. If something else on your site is using this argument, disable this option.'),
      '#default_value' => $config
        ->get('message_enforcement'),
    ];
    $form['add_twitter_card'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Add meta tags for twitter's summary card with large image"),
      '#description' => $this
        ->t('Enables sharing of images on twitter, check <a href="@url">this</a> for more information.', [
        '@url' => 'https://dev.twitter.com/cards/types/summary-large-image',
      ]),
      '#default_value' => $config
        ->get('add_twitter_card'),
    ];
    $form['twitter_user'] = [
      '#title' => t('Twitter account username'),
      '#description' => t('This is required when enabling the meta tags for twitter cards above.'),
      '#type' => 'textfield',
      '#default_value' => $config
        ->get('twitter_user'),
      '#states' => [
        'visible' => [
          ':input[name="add_twitter_card"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if ($form_state
      ->getValue('add_twitter_card') && empty($form_state
      ->getValue('twitter_user'))) {
      $form_state
        ->setErrorByName('twitter_user', t('Please enter your twitter account username in order to activate meta tags for twitter cards.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('sharemessage.settings')
      ->set('message_enforcement', $form_state
      ->getValue('message_enforcement'))
      ->set('add_twitter_card', $form_state
      ->getValue('add_twitter_card'))
      ->set('twitter_user', $form_state
      ->getValue('twitter_user'))
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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
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.
FormInterface::getFormId public function Returns a unique string identifying the form. 236
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.
ShareMessageSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ShareMessageSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ShareMessageSettingsForm::getFormID public function
ShareMessageSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ShareMessageSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.
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.