class SharrreSettingsForm in Share Message 8

Defines a form that configures Share Message settings.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\sharemessage\Form\SharrreSettingsForm

1 string reference to 'SharrreSettingsForm'

sharemessage.routing.yml in ./sharemessage.routing.yml

sharemessage.routing.yml

File

src/Form/SharrreSettingsForm.php, line 14

Namespace

Drupal\sharemessage\Form

class SharrreSettingsForm extends ConfigFormBase {

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

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

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

    // Check if the library configuration is valid.
    if ($check_form = Sharrre::checkConfiguration(TRUE)) {
      $form['check'] = $check_form;
    }
    $url = 'http://jster.net/library/sharrre';
    $form['library_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Remote URL for Sharrre Library (minimized version)'),
      '#description' => $this
        ->t('Set the URL for a Web-Hosted minimized version of Sharrre library (jquery.sharrre.min.js with the leading slashes), or leave empty if using the library locally. You can retrieve the library from <a href=":url">Sharrre CDN</a>.', [
        ':url' => $url,
      ]),
      '#default_value' => $sharrre_config
        ->get('library_url'),
    ];
    $form['default_services'] = [
      '#title' => t('Default visible services'),
      '#type' => 'select',
      '#multiple' => TRUE,
      '#options' => [
        'googlePlus' => t('Google+'),
        'facebook' => t('Facebook'),
        'twitter' => t('Twitter'),
        'digg' => t('Digg'),
        'delicious' => t('Delicious'),
        'stumbleupon' => t('StumpleUpon'),
        'linkedin' => t('Linkedin'),
        'pinterest' => t('Pinterest'),
      ],
      '#default_value' => $sharrre_config
        ->get('services'),
      '#size' => 10,
    ];
    $form['sharrre_website_documentation'] = [
      '#type' => 'label',
      '#title' => t('See the <a href=":url">Sharrre documentation</a> page for more information.', [
        ':url' => 'http://sharrre.com',
      ]),
    ];
    $form['shorter_total'] = [
      '#type' => 'checkbox',
      '#title' => t('Shorter total'),
      '#description' => t('Format number like 1.2k or 5M.'),
      '#default_value' => $sharrre_config
        ->get('shorter_total'),
    ];
    $form['enable_counter'] = [
      '#type' => 'checkbox',
      '#title' => t('Counter'),
      '#description' => t('Enable the total counter.'),
      '#default_value' => $sharrre_config
        ->get('enable_counter'),
    ];
    $form['enable_hover'] = [
      '#type' => 'checkbox',
      '#title' => t('Hover'),
      '#description' => t('Allow displaying the sharing buttons when hovering over the counter.'),
      '#default_value' => $sharrre_config
        ->get('enable_hover'),
      '#states' => [
        'invisible' => [
          ':input[name="enable_counter"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['enable_tracking'] = [
      '#type' => 'checkbox',
      '#title' => t('Tracking'),
      '#description' => t('Allow tracking social interaction with Google Analytics.'),
      '#default_value' => $sharrre_config
        ->get('enable_tracking'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);

    // Check if the name of the library in the remote URL is as expected.
    $url = $form_state
      ->getValue('library_url');
    $sharrre_cdn_url = 'http://jster.net/library/sharrre';
    if (!empty($url) && parse_url($url, PHP_URL_HOST) && parse_url($url, PHP_URL_PATH)) {
      $js = pathinfo($url, PATHINFO_BASENAME);
      if (!preg_match('/^jquery\\.sharrre-[\\d.]*\\.min\\.js$/', $js)) {
        $this
          ->messenger()
          ->addWarning(t('The naming of the library is unexpected. Double check that this is the real Sharrre library. The URL for the minimized version of the library can be found on <a href=":url">Sharrre CDN</a>.', [
          ':url' => $sharrre_cdn_url,
        ]), 'warning');
      }
    }
    elseif (!empty($url)) {
      $this
        ->messenger()
        ->addError(t('The remote URL is unexpected. Please, provide the correct URL to the minimized version of the library found on <a href=":url">Sharrre CDN</a>.', [
        ':url' => $sharrre_cdn_url,
      ]), 'error');
    }

    // If the profile id changes then we need to rebuild the library cache.
    Cache::invalidateTags([
      'library_info',
    ]);
    $this
      ->config('sharemessage.sharrre')
      ->set('services', $form_state
      ->getValue('default_services'))
      ->set('library_url', $form_state
      ->getValue('library_url'))
      ->set('shorter_total', $form_state
      ->getValue('shorter_total'))
      ->set('enable_hover', $form_state
      ->getValue('enable_hover'))
      ->set('enable_counter', $form_state
      ->getValue('enable_counter'))
      ->set('enable_tracking', $form_state
      ->getValue('enable_tracking'))
      ->save();
  }

}

Members

Name	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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
SharrreSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SharrreSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SharrreSettingsForm::getFormID	public	function
SharrreSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.