You are here

Home » API reference » Shorten URLs 8.2 » ShortenShortenForm.php

class ShortenShortenForm in Shorten URLs 8.2

Same name and namespace in other branches
  1. 8 src/Form/ShortenShortenForm.php \Drupal\shorten\Form\ShortenShortenForm

Builds a form which allows shortening of a URL via the UI.

Hierarchy

Expanded class hierarchy of ShortenShortenForm

1 string reference to 'ShortenShortenForm'
shorten.routing.yml in ./shorten.routing.yml
shorten.routing.yml

File

src/Form/ShortenShortenForm.php, line 12

Namespace

Drupal\shorten\Form
View source 
class ShortenShortenForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $form_state_values = $form_state
      ->getValues();
    $storage =& $form_state
      ->getStorage();
    $form['#attached']['library'][] = 'shorten/shorten';

    // Form elements between ['opendiv'] and ['closediv'] will be refreshed via AHAH on form submission.
    $form['opendiv'] = [
      '#markup' => '<div id="shorten_replace">',
    ];
    if (empty($storage)) {
      $storage = [
        'step' => 0,
      ];
    }
    if (isset($storage['short_url'])) {

      // This whole "step" business keeps the form element from being cached.
      $form['shortened_url_' . $storage['step']] = [
        '#type' => 'textfield',
        '#title' => t('Shortened URL'),
        '#default_value' => $storage['short_url'],
        '#size' => 25,
        '#attributes' => [
          'class' => [
            'shorten-shortened-url',
          ],
        ],
      ];
    }
    $form['url_' . $storage['step']] = [
      '#type' => 'textfield',
      '#title' => t('URL'),
      '#default_value' => '',
      '#required' => TRUE,
      '#size' => 25,
      '#maxlength' => 2048,
      '#attributes' => [
        'class' => [
          'shorten-long-url',
        ],
      ],
    ];

    // Form elements between ['opendiv'] and ['closediv'] will be refreshed via AHAH on form submission.
    $form['closediv'] = [
      '#markup' => '</div>',
    ];
    $last_service = NULL;
    if (isset($storage['service'])) {
      $last_service = $storage['service'];
    }
    $service = _shorten_service_form($last_service);
    if (is_array($service)) {
      $form['service'] = $service;
    }
    $form['shorten'] = [
      '#type' => 'submit',
      '#value' => t('Shorten'),
      '#ajax' => [
        'callback' => 'shorten_save_js',
        'wrapper' => 'shorten_replace',
        'effect' => 'fade',
        'method' => 'replace',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $storage =& $form_state
      ->getStorage();
    $url = $values['url_' . $storage['step']];
    if (mb_strlen($url) > 4) {
      if (!strpos($url, '.', 1)) {
        $form_state
          ->setErrorByName('url', $this
          ->t('Please enter a valid URL.'));
      }
    }
    else {
      $form_state
        ->setErrorByName('url', $this
        ->t('Please enter a valid URL.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $storage =& $form_state
      ->getStorage();
    $service = '';
    if (isset($values['service'])) {
      $service = $values['service'];
    }
    $shortened = shorten_url($values['url_' . $storage['step']], $service);
    if (isset($values['service'])) {
      $_SESSION['shorten_service'] = $values['service'];
    }
    $this
      ->messenger()
      ->addStatus($this
      ->t('%original was shortened to %shortened', [
      '%original' => $values['url_' . $storage['step']],
      '%shortened' => $shortened,
    ]));
    $form_state
      ->setRebuild();
    if (empty($storage)) {
      $storage = [];
    }
    $storage['short_url'] = $shortened;
    $storage['service'] = empty($values['service']) ? '' : $values['service'];
    if (isset($storage['step'])) {
      $storage['step']++;
    }
    else {
      $storage['step'] = 0;
    }
    $form_state
      ->setStorage($storage);
  }

}

Members

Namesort descending 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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
ShortenShortenForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ShortenShortenForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ShortenShortenForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ShortenShortenForm::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.