You are here

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

class CustomServicesAddForm in Shorten URLs 8.2

Same name and namespace in other branches
  1. 8 modules/shorten_cs/src/Form/CustomServicesAddForm.php \Drupal\shorten_cs\Form\CustomServicesAddForm

Settings form.

Hierarchy

Expanded class hierarchy of CustomServicesAddForm

1 string reference to 'CustomServicesAddForm'
shorten_cs.routing.yml in modules/shorten_cs/shorten_cs.routing.yml
modules/shorten_cs/shorten_cs.routing.yml

File

modules/shorten_cs/src/Form/CustomServicesAddForm.php, line 19

Namespace

Drupal\shorten_cs\Form
View source 
class CustomServicesAddForm extends ConfigFormBase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * CustomServicesAddForm constructor.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   * @param Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(ModuleHandlerInterface $module_handler, Connection $database, RendererInterface $renderer, ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
    $this->moduleHandler = $module_handler;
    $this->database = $database;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('module_handler'), $container
      ->get('database'), $container
      ->get('renderer'), $container
      ->get('config.factory'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $config = $this
      ->config('shorten.settings');
    $table = $this
      ->shortenCsServicesTable();
    if (!empty($table)) {
      $form['custom_services'] = [
        '#markup' => $table,
      ];
    }
    $form['#attached']['library'][] = 'shorten_cs/shorten_cs';
    if (!isset($form) || !is_array($form)) {
      $form = [];
    }
    $form['#attributes'] = [
      'class' => 'shorten-cs-apply-js',
    ];
    $form['name'] = [
      '#type' => 'textfield',
      '#title' => t('Title'),
      '#description' => t('The name of the service'),
      '#required' => TRUE,
    ];
    $form['url'] = [
      '#type' => 'textfield',
      '#title' => t('API endpoint URL'),
      '#description' => t('The URL of the API endpoint, with parameters,
           such that the long URL can be appended to the end.') . ' ' . t('For example, the endpoint for TinyURL is') . ' <code>http://tinyurl.com/api-create.php?url=</code>. ' . t('Appending a long URL to the endpoint
          and then visiting that address will return data about the shortened URL.'),
      '#required' => TRUE,
    ];
    $form['type'] = [
      '#type' => 'radios',
      '#title' => t('Response type'),
      '#description' => t('The type of response the API endpoint returns.'),
      '#required' => TRUE,
      '#default_value' => 'text',
      '#options' => [
        'text' => t('Text'),
        'xml' => 'XML',
        'json' => 'JSON',
      ],
    ];
    $form['tag'] = [
      '#type' => 'textfield',
      '#title' => t('XML tag or JSON key'),
      '#description' => t('The XML tag or JSON key that identifies the full short URL in the API response.') . ' ' . t('Only required for XML and JSON response types.') . '<br> ' . t('For multidimensional JSON responses, a path can be specified using ' . 'dot notation in order to specify the element in containing the ' . 'short url. For example, the path \'data.url\' would point to the ' . 'url value in the following JSON response: <br>' . '{"data":{"url":"http://ex.am/ple"}}<br>' . 'If a JSON element name itself contains a dot character, it can be ' . 'wrapped in double quotes.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $record = [];
    foreach ([
      'name',
      'url',
      'type',
      'tag',
    ] as $key) {
      $record[$key] = $values[$key];
    }
    $this->database
      ->insert('shorten_cs')
      ->fields($record)
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $v = $form_state
      ->getValues();
    if (($v['type'] == 'xml' || $v['type'] == 'json') && empty($v['tag'])) {
      $form_state
        ->setErrorByName('type', t('An XML tag or JSON key is required for services with a response type of XML or JSON.'));
    }
    $exists = $this->database
      ->query("SELECT COUNT(sid) FROM {shorten_cs} WHERE name = :name", [
      ':name' => $v['name'],
    ])
      ->fetchField();
    if ($exists > 0) {
      $form_state
        ->setErrorByName('name', t('A service with that name already exists.'));
    }
    else {
      $all_services = $this->moduleHandler
        ->invokeAll('shorten_service');
      $all_services['none'] = t('None');
      foreach ($all_services as $key => $value) {
        if ($key == $v['name']) {
          $form_state
            ->setErrorByName('name', t('A service with that name already exists.'));
          break;
        }
      }
    }
  }

  /**
   * Displays the table of existing custom services.
   */
  public function shortenCsServicesTable() {
    $header = [
      t('Name'),
      t('URL'),
      t('Type'),
      t('XML/JSON tag'),
      t('Actions'),
    ];
    $rows = [];
    $result = $this->database
      ->query("SELECT * FROM {shorten_cs} ORDER BY name ASC")
      ->fetchAll();
    foreach ($result as $service) {
      $service = (array) $service;
      $service = [
        'sid' => $service['sid'],
        'name' => Html::escape($service['name']),
        'url' => Html::escape($service['url']),
        'type' => $service['type'],
        'tag' => Html::escape($service['tag']),
      ];
      $options = [
        'absolute' => TRUE,
      ];
      $actions = [
        '#markup' => Link::createFromRoute('edit', 'shorten_cs.edit_form', [
          'service' => $service['sid'],
        ], $options)
          ->toString() . ' ' . Link::createFromRoute('delete', 'shorten_cs.delete_form', [
          'service' => $service['sid'],
        ], $options)
          ->toString(),
      ];
      $service['actions'] = $this->renderer
        ->render($actions);
      unset($service['sid']);
      $rows[] = $service;
    }
    if (!empty($rows)) {
      $table = [
        '#type' => 'table',
        '#header' => $header,
        '#rows' => $rows,
        '#attributes' => [
          'id' => 'shorten_custom_services',
        ],
      ];
      return $this->renderer
        ->render($table);
    }
    return '';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
CustomServicesAddForm::$database protected property The database connection.
CustomServicesAddForm::$moduleHandler protected property The module handler.
CustomServicesAddForm::$renderer protected property The renderer service.
CustomServicesAddForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CustomServicesAddForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
CustomServicesAddForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CustomServicesAddForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CustomServicesAddForm::shortenCsServicesTable public function Displays the table of existing custom services.
CustomServicesAddForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
CustomServicesAddForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
CustomServicesAddForm::__construct public function CustomServicesAddForm constructor. Overrides ConfigFormBase::__construct
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.