You are here

Home » API reference » jQuery social stream 8.2 » JquerySocialStreamAdminForm.php

class JquerySocialStreamAdminForm in jQuery social stream 8.2

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

Hierarchy

Expanded class hierarchy of JquerySocialStreamAdminForm

1 string reference to 'JquerySocialStreamAdminForm'
jquery_social_stream.routing.yml in ./jquery_social_stream.routing.yml
jquery_social_stream.routing.yml

File

src/Form/JquerySocialStreamAdminForm.php, line 14
Contains \Drupal\jquery_social_stream\Form\JquerySocialStreamAdminForm.

Namespace

Drupal\jquery_social_stream\Form
View source 
class JquerySocialStreamAdminForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return array(
      'jquery_social_stream.settings',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = array();
    $config = $this
      ->config('jquery_social_stream.settings');

    // Twitter.
    $form['twitter'] = array(
      '#type' => 'details',
      '#tree' => FALSE,
      '#title' => t('Twitter settings'),
      '#open' => TRUE,
    );
    $form['twitter']['twitter_api_key'] = array(
      '#type' => 'textfield',
      '#title' => t('Twitter API Key'),
      '#default_value' => $config
        ->get('twitter_api_key'),
    );
    $form['twitter']['twitter_api_secret'] = array(
      '#type' => 'textfield',
      '#title' => t('Twitter API Secret'),
      '#default_value' => $config
        ->get('twitter_api_secret'),
    );
    $form['twitter']['twitter_access_token'] = array(
      '#type' => 'textfield',
      '#title' => t('Twitter Access Token'),
      '#default_value' => $config
        ->get('twitter_access_token'),
    );
    $form['twitter']['twitter_access_token_secret'] = array(
      '#type' => 'textfield',
      '#title' => t('Twitter Access Token Secret'),
      '#default_value' => $config
        ->get('twitter_access_token_secret'),
    );

    // Facebook.
    $form['facebook'] = array(
      '#type' => 'details',
      '#tree' => FALSE,
      '#title' => t('Facebook settings'),
      '#open' => TRUE,
    );
    $form['facebook']['facebook_app_id'] = array(
      '#type' => 'textfield',
      '#title' => t('Facebook App ID'),
      '#default_value' => $config
        ->get('facebook_app_id'),
    );
    $form['facebook']['facebook_app_secret'] = array(
      '#type' => 'textfield',
      '#title' => t('Facebook App Secret'),
      '#default_value' => $config
        ->get('facebook_app_secret'),
    );

    // Google +.
    $form['google'] = array(
      '#type' => 'details',
      '#tree' => FALSE,
      '#title' => t('Google +1 settings'),
      '#open' => TRUE,
    );
    $form['google']['google_key'] = array(
      '#type' => 'textfield',
      '#title' => t('Google +1 API Key'),
      '#default_value' => $config
        ->get('google_key'),
    );

    // YouTube.
    $form['youtube'] = array(
      '#type' => 'details',
      '#tree' => FALSE,
      '#title' => t('YouTube settings'),
      '#open' => TRUE,
    );
    $form['youtube']['youtube_key'] = array(
      '#type' => 'textfield',
      '#title' => t('YouTube Google API Key'),
      '#default_value' => $config
        ->get('youtube_key'),
    );

    // Instagram.
    $form['instagram'] = array(
      '#type' => 'details',
      '#tree' => FALSE,
      '#title' => t('Instagram settings'),
      '#open' => TRUE,
    );
    $form['instagram']['instagram_access_token'] = array(
      '#type' => 'textfield',
      '#title' => t('Instagram Access Token'),
      '#description' => t('Access token created from the authorisation of your OAuth Client'),
      '#default_value' => $config
        ->get('instagram_access_token'),
    );
    $form['instagram']['instagram_redirect_url'] = array(
      '#type' => 'textfield',
      '#title' => t('Instagram Redirect URL'),
      '#description' => t('The URL entered as the redirect URL when registering your new OAuth Client in the Instagram API setup'),
      '#default_value' => $config
        ->get('instagram_redirect_url'),
    );
    $form['instagram']['instagram_client_id'] = array(
      '#type' => 'textfield',
      '#title' => t('Instagram Client ID'),
      '#description' => t('Client ID for API created after registering your new OAuth Client in the instagram API setup'),
      '#default_value' => $config
        ->get('instagram_client_id'),
    );
    $section_names = array(
      'google' => 'Creating Your Own Google API Key',
      'instagram' => 'Creating Your Own Instagram API Client ID & Access Token',
      'facebook' => 'Facebook API Credentials',
      'twitter' => 'Twitter API Credentials',
      'youtube' => 'Creating Your Own Youtube API Key',
    );
    $doc_file = libraries_get_path('jquery-social-stream') . '/index.html';
    $doc_file_exists = file_exists(DRUPAL_ROOT . '/' . $doc_file);
    foreach ($section_names as $provider => $section) {
      if ($doc_file_exists) {
        $form[$provider]['#description'] = t('See section %section in <a href="/!path">jQuery Social Stream plugin documentation</a> for details.', array(
          '!path' => $doc_file,
          '%section' => $section,
        ));
      }
      else {
        $form[$provider]['#description'] = t('See section %section in jQuery Social Stream plugin documentation for details (file <em>index.html</em> in plugin root directory).', array(
          '%section' => $section,
        ));
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('jquery_social_stream.settings');
    $providers = array(
      'twitter',
      'facebook',
      'google',
      'youtube',
      'instagram',
    );
    foreach ($providers as $provider) {
      foreach (Element::children($form[$provider]) as $variable) {
        $config
          ->set($variable, $form_state
          ->getValue($variable));
      }
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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
JquerySocialStreamAdminForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
JquerySocialStreamAdminForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
JquerySocialStreamAdminForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
JquerySocialStreamAdminForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.