You are here

Home » API reference » Social Auth Facebook 3.x » FacebookAuthSettingsForm.php

class FacebookAuthSettingsForm in Social Auth Facebook 3.x

Same name and namespace in other branches
  1. 8.2 src/Form/FacebookAuthSettingsForm.php \Drupal\social_auth_facebook\Form\FacebookAuthSettingsForm
  2. 8 src/Form/FacebookAuthSettingsForm.php \Drupal\social_auth_facebook\Form\FacebookAuthSettingsForm

Settings form for Social Auth Facebook.

Hierarchy

Expanded class hierarchy of FacebookAuthSettingsForm

1 string reference to 'FacebookAuthSettingsForm'
social_auth_facebook.routing.yml in ./social_auth_facebook.routing.yml
social_auth_facebook.routing.yml

File

src/Form/FacebookAuthSettingsForm.php, line 17

Namespace

Drupal\social_auth_facebook\Form
View source 
class FacebookAuthSettingsForm extends SocialAuthSettingsForm {

  /**
   * The request context.
   *
   * @var \Drupal\Core\Routing\RequestContext
   */
  protected $requestContext;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
   *   Used to check if route exists.
   * @param \Drupal\Core\Path\PathValidatorInterface $path_validator
   *   Used to check if path is valid and exists.
   * @param \Drupal\Core\Routing\RequestContext $request_context
   *   Holds information about the current request.
   */
  public function __construct(ConfigFactoryInterface $config_factory, RouteProviderInterface $route_provider, PathValidatorInterface $path_validator, RequestContext $request_context) {
    parent::__construct($config_factory, $route_provider, $path_validator);
    $this->requestContext = $request_context;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    // Instantiates this class.
    return new static($container
      ->get('config.factory'), $container
      ->get('router.route_provider'), $container
      ->get('path.validator'), $container
      ->get('router.request_context'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return array_merge(parent::getEditableConfigNames(), [
      'social_auth_facebook.settings',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('social_auth_facebook.settings');
    $form['fb_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Facebook App settings'),
      '#open' => TRUE,
      '#description' => $this
        ->t('You need to first create a Facebook App at <a href="@facebook-dev">@facebook-dev</a>', [
        '@facebook-dev' => 'https://developers.facebook.com/apps',
      ]),
    ];
    $form['fb_settings']['app_id'] = [
      '#type' => 'textfield',
      '#required' => TRUE,
      '#title' => $this
        ->t('Application ID'),
      '#default_value' => $config
        ->get('app_id'),
      '#description' => $this
        ->t('Copy the App ID of your Facebook App here. This value can be found from your App Dashboard.'),
    ];
    $form['fb_settings']['app_secret'] = [
      '#type' => 'textfield',
      '#required' => TRUE,
      '#title' => $this
        ->t('App Secret'),
      '#default_value' => $config
        ->get('app_secret'),
      '#description' => $this
        ->t('Copy the App Secret of your Facebook App here. This value can be found from your App Dashboard.'),
    ];
    $form['fb_settings']['graph_version'] = [
      '#type' => 'textfield',
      '#required' => TRUE,
      '#title' => $this
        ->t('Facebook Graph API version'),
      '#default_value' => $config
        ->get('graph_version'),
      '#description' => $this
        ->t('Copy the API Version of your Facebook App here. This value can be found from your App Dashboard. More information on API versions can be found at <a href="@facebook-changelog">Facebook Platform Changelog</a>', [
        '@facebook-changelog' => 'https://developers.facebook.com/docs/apps/changelog',
      ]),
    ];
    $form['fb_settings']['oauth_redirect_url'] = [
      '#type' => 'textfield',
      '#disabled' => TRUE,
      '#title' => $this
        ->t('Valid OAuth redirect URIs'),
      '#description' => $this
        ->t('Copy this value to <em>Valid OAuth redirect URIs</em> field of your Facebook App settings.'),
      '#default_value' => Url::fromRoute('social_auth_facebook.callback')
        ->setAbsolute()
        ->toString(),
    ];
    $form['fb_settings']['app_domains'] = [
      '#type' => 'textfield',
      '#disabled' => TRUE,
      '#title' => $this
        ->t('App Domains'),
      '#description' => $this
        ->t('Copy this value to <em>App Domains</em> field of your Facebook App settings.'),
      '#default_value' => $this->requestContext
        ->getHost(),
    ];
    $form['fb_settings']['site_url'] = [
      '#type' => 'textfield',
      '#disabled' => TRUE,
      '#title' => $this
        ->t('Site URL'),
      '#description' => $this
        ->t('Copy this value to <em>Site URL</em> field of your Facebook App settings.'),
      '#default_value' => $GLOBALS['base_url'],
    ];
    $form['fb_settings']['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced settings'),
      '#open' => FALSE,
    ];
    $form['fb_settings']['advanced']['scopes'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Scopes for API call'),
      '#default_value' => $config
        ->get('scopes'),
      '#description' => $this
        ->t('Define any additional scopes to be requested, separated by a comma (e.g.: user_birthday,user_location).<br>
                                  The scopes \'email\' and \'public_profile\' are added by default and always requested.<br>
                                  You can see the full list of valid scopes and their description <a href="@scopes">here</a>.', [
        '@scopes' => 'https://developers.facebook.com/docs/facebook-login/permissions/',
      ]),
    ];
    $form['fb_settings']['advanced']['endpoints'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('API calls to be made to collect data'),
      '#default_value' => $config
        ->get('endpoints'),
      '#description' => $this
        ->t('Define the Endpoints to be requested when user authenticates with Facebook for the first time<br>
                                  Enter each endpoint in different lines in the format <em>endpoint</em>|<em>name_of_endpoint</em>.<br>
                                  <b>For instance:</b><br>
                                  /me?fields=birthday|user_birthday<br>
                                  /me?fields=address|user_address'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $graph_version = $form_state
      ->getValue('graph_version');
    if ($graph_version[0] === 'v') {
      $graph_version = substr($graph_version, 1);
      $form_state
        ->setValue('graph_version', $graph_version);
    }
    if (!preg_match('/^([2-9]|[1-9][0-9])\\.[0-9]{1,2}$/', $graph_version)) {
      $form_state
        ->setErrorByName('graph_version', $this
        ->t('Invalid API version. The syntax for API version is for example <em>v2.8</em>'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->config('social_auth_facebook.settings')
      ->set('app_id', $values['app_id'])
      ->set('app_secret', $values['app_secret'])
      ->set('graph_version', $values['graph_version'])
      ->set('scopes', $values['scopes'])
      ->set('endpoints', $values['endpoints'])
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FacebookAuthSettingsForm::$requestContext protected property The request context.
FacebookAuthSettingsForm::buildForm public function Form constructor. Overrides SocialAuthSettingsForm::buildForm
FacebookAuthSettingsForm::create public static function Instantiates a new instance of this class. Overrides SocialAuthSettingsForm::create
FacebookAuthSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides SocialAuthSettingsForm::getEditableConfigNames
FacebookAuthSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides SocialAuthSettingsForm::getFormId
FacebookAuthSettingsForm::submitForm public function Form submission handler. Overrides SocialAuthSettingsForm::submitForm
FacebookAuthSettingsForm::validateForm public function Form validation handler. Overrides SocialAuthSettingsForm::validateForm
FacebookAuthSettingsForm::__construct public function Constructor. Overrides SocialAuthSettingsForm::__construct
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.
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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.
SocialAuthSettingsForm::$routeProvider protected property The route provider.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.