You are here

Home » API reference » Social Feed 8 » InstagramSettingsForm.php

class InstagramSettingsForm in Social Feed 8

Class InstagramSettingsForm.

@package Drupal\socialfeed\Form

Hierarchy

Expanded class hierarchy of InstagramSettingsForm

1 string reference to 'InstagramSettingsForm'
socialfeed.routing.yml in ./socialfeed.routing.yml
socialfeed.routing.yml

File

src/Form/InstagramSettingsForm.php, line 15

Namespace

Drupal\socialfeed\Form
View source 
class InstagramSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('socialfeed.instagramsettings');
    $redirect_uri = Url::fromRoute('socialfeed.instagram_auth', [], [
      'absolute' => TRUE,
    ])
      ->toString();
    $form['header']['#markup'] = $this
      ->t('To get the App ID and App Secret you need to follow steps 1-3 <a href="@site" target="@blank">here</a> (command line not needed). Then add them here and save the page. Once the credentials are saved, a link to generate the Access Token will appear.', [
      '@site' => 'https://developers.facebook.com/docs/instagram-basic-display-api/getting-started',
      '@blank' => '_blank',
    ]);
    $form['client_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('App ID'),
      '#description' => $this
        ->t('App ID from Instagram account'),
      '#default_value' => $config
        ->get('client_id'),
      '#size' => 60,
      '#maxlength' => 100,
      '#required' => TRUE,
    ];
    $form['app_secret'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('App Secret'),
      '#description' => $this
        ->t('App Secret from Instagram account'),
      '#default_value' => $config
        ->get('app_secret'),
      '#size' => 60,
      '#maxlength' => 100,
      '#required' => TRUE,
    ];
    $form['redirect_uri'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Redirect URI'),
      '#markup' => $redirect_uri,
      '#default_value' => $redirect_uri,
    ];
    $token_message = $this
      ->t('Once the App ID and Secret Key have been saved, a link to generate the Access Key will appear.');
    if ($config
      ->get('client_id')) {
      $instagram = new InstagramBasicDisplay([
        'appId' => $config
          ->get('client_id'),
        'appSecret' => $config
          ->get('app_secret'),
        'redirectUri' => $redirect_uri,
      ]);
      $token_message = $this
        ->t('<a href="@this" target="_blank">Login with Instagram to generate the Access Token</a>', [
        '@this' => Url::fromUri($instagram
          ->getLoginUrl())
          ->toString(),
      ]);
    }
    $form['access_token'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Access Token'),
      '#field_prefix' => '<div>' . $token_message . '</div>',
      '#description' => $this
        ->t('This access token will automatically be renewed before the current one expires in 60 days.'),
      '#default_value' => $config
        ->get('access_token'),
      '#size' => 60,
      '#maxlength' => 300,
    ];
    $form['picture_count'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Default Picture Count'),
      '#default_value' => $config
        ->get('picture_count'),
      '#size' => 60,
      '#maxlength' => 100,
      '#min' => 1,
    ];
    $form['video_thumbnail'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show video thumbnails instead of actual videos'),
      '#default_value' => $config
        ->get('video_thumbnail'),
    ];
    $form['post_link'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show post URL'),
      '#default_value' => $config
        ->get('post_link'),
    ];
    if ($config
      ->get('access_token')) {
      $form['feed'] = [
        '#type' => 'item',
        '#title' => $this
          ->t('Feed URL'),
        '#markup' => $this
          ->t('https://graph.instagram.com/me/media?fields=id,media_type,media_url,username,timestamp&limit=@picture_count&access_token=@access_token', [
          '@access_token' => $config
            ->get('access_token'),
          '@picture_count' => $config
            ->get('picture_count'),
        ]),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('socialfeed.instagramsettings');
    foreach ($form_state
      ->getValues() as $key => $value) {
      $config
        ->set($key, $value);
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

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

}

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
InstagramSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
InstagramSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
InstagramSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
InstagramSettingsForm::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.