class RestExampleClientSettings

Same name in other branches
  1. 4.0.x modules/rest_example/src/Form/RestExampleClientSettings.php \Drupal\rest_example\Form\RestExampleClientSettings

Setup form for a Drupal REST client.

Here you configure what the other Drupal installation.

Hierarchy

Expanded class hierarchy of RestExampleClientSettings

Related topics

1 string reference to 'RestExampleClientSettings'
rest_example.routing.yml in modules/rest_example/rest_example.routing.yml
modules/rest_example/rest_example.routing.yml

File

modules/rest_example/src/Form/RestExampleClientSettings.php, line 15

Namespace

Drupal\rest_example\Form
View source
class RestExampleClientSettings extends ConfigFormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'rest_example_client_settings';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['intro'] = [
            '#markup' => t('Set here the remote server options.'),
        ];
        $form['server_url'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Remote server URL'),
            '#description' => $this->t('Format like this: http://www.example.com or http://www.example.com/test-site (no trailing slash)'),
            '#default_value' => $this->config('rest_example.settings')
                ->get('server_url'),
            '#required' => TRUE,
        ];
        $form['server_username'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Remote server username'),
            '#default_value' => $this->config('rest_example.settings')
                ->get('server_username'),
            '#description' => $this->t('A user on the remote system that has the proper rights to use the REST service'),
            '#required' => TRUE,
        ];
        $form['server_password'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Remote server password'),
            '#default_value' => $this->config('rest_example.settings')
                ->get('server_password'),
            '#description' => $this->t('Remote users password'),
            '#required' => TRUE,
        ];
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $form_values = $form_state->getValues();
        $this->config('rest_example.settings')
            ->set('server_url', $form_values['server_url'])
            ->set('server_username', $form_values['server_username'])
            ->set('server_password', $form_values['server_password'])
            ->save();
        parent::submitForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getEditableConfigNames() {
        return [
            'rest_example.settings',
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigFormBase::create public static function Overrides FormBase::create 18
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 17
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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 Overrides FormInterface::validateForm 73
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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.
RestExampleClientSettings::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
RestExampleClientSettings::getEditableConfigNames public function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RestExampleClientSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RestExampleClientSettings::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.