You are here

class SimpleFbConnectSettingsForm in Simple FB Connect 8.3

Same name and namespace in other branches
  1. 8.2 src/Form/SimpleFbConnectSettingsForm.php \Drupal\simple_fb_connect\Form\SimpleFbConnectSettingsForm

Defines a form that configures Simple FB Connect settings.

Hierarchy

Expanded class hierarchy of SimpleFbConnectSettingsForm

1 string reference to 'SimpleFbConnectSettingsForm'
simple_fb_connect.routing.yml in ./simple_fb_connect.routing.yml
simple_fb_connect.routing.yml

File

src/Form/SimpleFbConnectSettingsForm.php, line 15

Namespace

Drupal\simple_fb_connect\Form
View source
class SimpleFbConnectSettingsForm extends ConfigFormBase {
  protected $requestContext;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Routing\RequestContext $request_context
   *   Holds information about the current request.
   */
  public function __construct(ConfigFactoryInterface $config_factory, RequestContext $request_context) {
    $this
      ->setConfigFactory($config_factory);
    $this->requestContext = $request_context;
  }

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $simple_fb_config = $this
      ->config('simple_fb_connect.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' => $simple_fb_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' => $simple_fb_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']['api_version'] = [
      '#type' => 'textfield',
      '#required' => TRUE,
      '#title' => $this
        ->t('API Version'),
      '#default_value' => $simple_fb_config
        ->get('api_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' => $GLOBALS['base_url'] . '/user/simple-fb-connect/return',
    ];
    $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['module_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Simple FB Connect configurations'),
      '#open' => TRUE,
      '#description' => $this
        ->t('These settings allow you to configure how Simple FB Connect module behaves on your Drupal site'),
    ];
    $form['module_settings']['post_login_path'] = [
      '#type' => 'textfield',
      '#required' => TRUE,
      '#title' => $this
        ->t('Post login path'),
      '#description' => $this
        ->t('Drupal path where the user should be redirected after successful login. Use <em>&lt;front&gt;</em> to redirect user to your front page.'),
      '#default_value' => $simple_fb_config
        ->get('post_login_path'),
    ];
    $form['module_settings']['redirect_user_form'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Redirect new users to Drupal user form'),
      '#description' => $this
        ->t('If you check this, new users are redirected to Drupal user form after the user is created. This is useful if you want to encourage users to fill in additional user fields.'),
      '#default_value' => $simple_fb_config
        ->get('redirect_user_form'),
    ];
    $form['module_settings']['disable_admin_login'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable FB login for administrator'),
      '#description' => $this
        ->t('Disabling FB login for administrator (<em>user 1</em>) can help protect your site if a security vulnerability is ever discovered in Facebook PHP SDK or this module.'),
      '#default_value' => $simple_fb_config
        ->get('disable_admin_login'),
    ];

    // Option to disable FB login for specific roles.
    $roles = user_roles();
    $options = [];
    foreach ($roles as $key => $role_object) {
      if ($key != 'anonymous' && $key != 'authenticated') {
        $options[$key] = Html::escape($role_object
          ->get('label'));
      }
    }
    $form['module_settings']['disabled_roles'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Disable FB login for the following roles'),
      '#options' => $options,
      '#default_value' => $simple_fb_config
        ->get('disabled_roles'),
    ];
    if (empty($roles)) {
      $form['module_settings']['disabled_roles']['#description'] = $this
        ->t('No roles found.');
    }
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->config('simple_fb_connect.settings')
      ->set('app_id', $values['app_id'])
      ->set('app_secret', $values['app_secret'])
      ->set('api_version', $values['api_version'])
      ->set('post_login_path', $values['post_login_path'])
      ->set('redirect_user_form', $values['redirect_user_form'])
      ->set('disable_admin_login', $values['disable_admin_login'])
      ->set('disabled_roles', $values['disabled_roles'])
      ->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 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.
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.
SimpleFbConnectSettingsForm::$requestContext protected property
SimpleFbConnectSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SimpleFbConnectSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SimpleFbConnectSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SimpleFbConnectSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimpleFbConnectSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SimpleFbConnectSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SimpleFbConnectSettingsForm::__construct public function Constructor. Overrides ConfigFormBase::__construct
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.