class ConfigForm in GatherContent 8.4

Same name and namespace in other branches

8.5 src/Form/ConfigForm.php \Drupal\gathercontent\Form\ConfigForm
8 src/Form/ConfigForm.php \Drupal\gathercontent\Form\ConfigForm
8.3 src/Form/ConfigForm.php \Drupal\gathercontent\Form\ConfigForm

Class ConfigForm.

@package Drupal\gathercontent\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\gathercontent\Form\ConfigForm

Expanded class hierarchy of ConfigForm

1 string reference to 'ConfigForm'

gathercontent.routing.yml in ./gathercontent.routing.yml: gathercontent.routing.yml

File

src/Form/ConfigForm.php, line 18

Namespace

Drupal\gathercontent\Form

View source

class ConfigForm extends ConfigFormBase {

  /**
   * GatherContent client.
   *
   * @var \Drupal\gathercontent\DrupalGatherContentClient
   */
  protected $client;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, GatherContentClientInterface $client) {
    parent::__construct($config_factory);
    $this->client = $client;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('gathercontent.settings');
    $form['gathercontent_username'] = [
      '#type' => 'email',
      '#title' => $this
        ->t('GatherContent User Email Address'),
      '#description' => $this
        ->t('This is the email address you use to login to GatherContent. Your permissions will determine what accounts, projects and content is available.'),
      '#default_value' => $config
        ->get('gathercontent_username'),
      '#required' => TRUE,
    ];
    $form['gathercontent_api_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('GatherContent API key'),
      '#description' => Link::fromTextAndUrl($this
        ->t('Click to find out where you can generate your API Key'), Url::fromUri('https://gathercontent.com/developers/authentication/')),
      '#maxlength' => 64,
      '#size' => 64,
      '#default_value' => $config
        ->get('gathercontent_api_key'),
      '#required' => TRUE,
    ];
    $form['actions']['#type'] = 'actions';
    if (!$form_state
      ->isSubmitted()) {
      $account = $config
        ->get('gathercontent_account');
      if (!empty($account)) {
        $account = unserialize($account);
        $account = array_pop($account);
        $form['current_account'] = [
          '#type' => 'html_tag',
          '#tag' => 'div',
          '#value' => $this
            ->t('Current account is <strong>@account</strong>.', [
            '@account' => $account,
          ]),
        ];
      }
    }
    if ($form_state
      ->isSubmitted()) {

      /** @var \Cheppers\GatherContent\DataTypes\Account[] $data */
      $data = $this->client
        ->accountsGet();
      $accounts = [];
      if (!is_null($data)) {
        foreach ($data as $account) {
          $accounts[$account->id] = $account->name;
        }
        $form['account'] = [
          '#type' => 'select',
          '#options' => $accounts,
          '#title' => $this
            ->t('Select GatherContent Account'),
          '#required' => TRUE,
          '#description' => $this
            ->t('Multiple accounts will be listed if the GatherContent
       user has more than one account. Please select the account you want to
       import and update content from.'),
        ];
      }
      $form['actions']['submit'] = [
        '#type' => 'submit',
        '#value' => is_null($data) ? $this
          ->t('Verify') : $this
          ->t('Save'),
        '#button_type' => 'primary',
      ];
    }
    else {
      $form['actions']['submit'] = [
        '#type' => 'submit',
        '#value' => !empty($account) ? $this
          ->t('Change GatherContent Account') : $this
          ->t('Verify'),
        '#button_type' => 'primary',
      ];
    }
    if (!empty($account)) {
      $form['actions']['reset'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Reset credentials'),
      ];
    }

    // By default, render the form using theme_system_config_form().
    $form['#theme'] = 'system_config_form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $triggering_element = $form_state
      ->getTriggeringElement();
    if ($triggering_element['#id'] === 'edit-submit') {
      if (!$form_state
        ->hasValue('account')) {
        $this
          ->config('gathercontent.settings')
          ->set('gathercontent_username', $form_state
          ->getValue('gathercontent_username'))
          ->set('gathercontent_api_key', $form_state
          ->getValue('gathercontent_api_key'))
          ->save();
        $this->client
          ->setCredentials();
        $form_state
          ->setSubmitted()
          ->setRebuild();
      }
      else {
        $submitted_account_id = $form_state
          ->getValue('account');

        /** @var \Cheppers\GatherContent\DataTypes\Account[] $data */
        $data = $this->client
          ->accountsGet();
        foreach ($data as $account) {
          if ($account->id == $submitted_account_id) {
            $account_name = $account->name;
            $this
              ->config('gathercontent.settings')
              ->set('gathercontent_account', serialize([
              $submitted_account_id => $account_name,
            ]))
              ->save();
            drupal_set_message(t("Credentials and project were saved."));
            $this
              ->config('gathercontent.settings')
              ->set('gathercontent_urlkey', $account->slug)
              ->save();
            break;
          }
        }
      }
    }
    elseif ($triggering_element['#id'] === 'edit-reset') {
      $this
        ->config('gathercontent.settings')
        ->clear('gathercontent_username')
        ->save();
      $this
        ->config('gathercontent.settings')
        ->clear('gathercontent_api_key')
        ->save();
      $this
        ->config('gathercontent.settings')
        ->clear('gathercontent_account')
        ->save();
      $this
        ->config('gathercontent.settings')
        ->clear('gathercontent_urlkey')
        ->save();
    }
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigForm::$client	protected	property	GatherContent client.
ConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
ConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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 ConfigForm in GatherContent 8.4

Hierarchy

File

Namespace

Members

API Navigation