class CustomServicesEditForm in Shorten URLs 8.2

Same name and namespace in other branches

8 modules/shorten_cs/src/Form/CustomServicesEditForm.php \Drupal\shorten_cs\Form\CustomServicesEditForm

Settings form.

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\shorten_cs\Form\CustomServicesEditForm

Expanded class hierarchy of CustomServicesEditForm

1 string reference to 'CustomServicesEditForm'

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/CustomServicesEditForm.php, line 16

Namespace

Drupal\shorten_cs\Form

View source

class CustomServicesEditForm extends ConfigFormBase {

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

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

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * CustomServicesEditForm constructor.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(ModuleHandlerInterface $module_handler, Connection $database, FormBuilderInterface $form_builder, ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
    $this->moduleHandler = $module_handler;
    $this->database = $database;
    $this->formBuilder = $form_builder;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $service = NULL) {
    $form = $this->formBuilder
      ->getForm('Drupal\\shorten_cs\\Form\\CustomServicesAddForm');
    $sid = $service;
    $service = $this->database
      ->select('shorten_cs', 's')
      ->fields('s')
      ->condition('sid', intval($sid))
      ->execute()
      ->fetchAssoc();
    foreach ([
      'name',
      'url',
      'type',
      'tag',
    ] as $key) {
      $form[$key]['#default_value'] = $service[$key];
      unset($form[$key]['#value']);
    }
    $form['sid'] = [
      '#type' => 'value',
      '#value' => $service['sid'],
    ];
    $form['old_name'] = [
      '#type' => 'value',
      '#value' => $service['name'],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $v = $form_state
      ->getValues();
    $config_factory = $this
      ->configFactory();
    $record = [];
    foreach ([
      'name',
      'url',
      'type',
      'tag',
      'sid',
    ] as $key) {
      $record[$key] = $v[$key];
    }
    $this->database
      ->merge('shorten_cs')
      ->fields($record)
      ->key([
      'sid',
    ])
      ->execute();
    if ($v['old_name'] == $this
      ->config('shorten.settings')
      ->get('shorten_service', 'is.gd')) {
      $config_factory
        ->getEditable('shorten.settings')
        ->set('shorten_service', $v['name']);
    }
    if ($v['old_name'] == $this
      ->config('shorten.settings')
      ->get('shorten_service_backup', 'TinyURL')) {
      $config_factory
        ->getEditable('shorten.settings')
        ->set('shorten_service', $v['name']);
    }
    $this
      ->messenger()
      ->addStatus(t('The changes to service %service have been saved.', [
      '%service' => $record['name'],
    ]));
    $form_state
      ->setRedirect('shorten_cs.theme_shorten_cs_admin');
    return;
  }

  /**
   * {@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;
        }
      }
    }
  }

}

Members

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

You are here

class CustomServicesEditForm in Shorten URLs 8.2

Hierarchy

File

Namespace

Members

API Navigation