class AddToCopyForm in Add link to copied text 8

Provides a configuration form for addtocopy 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\addtocopy\Forms\AddToCopyForm

1 string reference to 'AddToCopyForm'

addtocopy.routing.yml in ./addtocopy.routing.yml

addtocopy.routing.yml

File

src/Forms/AddToCopyForm.php, line 11

Namespace

Drupal\addtocopy\Forms

class AddToCopyForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $addtocopy_config = $this
      ->config('addtocopy.settings');
    $form['addtocopy_selector'] = array(
      '#type' => 'textfield',
      '#title' => t('jQuery selector'),
      '#default_value' => $addtocopy_config
        ->get('addtocopy.selector') ? $addtocopy_config
        ->get('addtocopy.selector') : '#content',
      '#description' => t('jQuery selector expression to apply Add to Copy.'),
      '#required' => TRUE,
    );
    $form['addtocopy_minlen'] = array(
      '#type' => 'textfield',
      '#title' => t('Minimum text length'),
      '#default_value' => $addtocopy_config
        ->get('addtocopy.minlen') ? $addtocopy_config
        ->get('addtocopy.minlen') : '25',
      '#description' => t('Minimum selected text length to activate Add to Copy.'),
      '#required' => TRUE,
    );
    $form['addtocopy_htmlcopytxt'] = array(
      '#type' => 'textfield',
      '#title' => t('HTML to add to selected text'),
      '#default_value' => $addtocopy_config
        ->get('addtocopy.htmlcopytxt') ? $addtocopy_config
        ->get('addtocopy.htmlcopytxt') : '<br>More: <a href="[link]">[link]</a><br>',
      '#description' => t('[link] will be replaced with the current page link.'),
      '#required' => TRUE,
    );
    $form['addtocopy_addcopyfirst'] = array(
      '#type' => 'radios',
      '#title' => t('Add before or after selected text'),
      '#options' => array(
        0 => t('After'),
        1 => t('Before'),
      ),
      '#default_value' => $addtocopy_config
        ->get('addtocopy.addcopyfirst') ? $addtocopy_config
        ->get('addtocopy.addcopyfirst') : '0',
      '#description' => t('jQuery selector expression to apply Add to Copy.'),
      '#required' => TRUE,
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // Check for numeric min length.
    $min_length = $form_state
      ->getValue('addtocopy_minlen');
    if (!is_numeric($min_length)) {

      // Show error for numeric value.
      $form_state
        ->setErrorByName('addtocopy_minlen', $this
        ->t("Please enter numeric value."));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('addtocopy.settings')
      ->set('addtocopy.selector', $form_state
      ->getValue('addtocopy_selector'))
      ->set('addtocopy.minlen', $form_state
      ->getValue('addtocopy_minlen'))
      ->set('addtocopy.htmlcopytxt', $form_state
      ->getValue('addtocopy_htmlcopytxt'))
      ->set('addtocopy.addcopyfirst', $form_state
      ->getValue('addtocopy_addcopyfirst'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddToCopyForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AddToCopyForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AddToCopyForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AddToCopyForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AddToCopyForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.
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.
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.