You are here

Home » API reference » Facebook Comments Box 8 » CustomForm.php

class CustomForm in Facebook Comments Box 8

Configure custom settings for this site.

Hierarchy

Expanded class hierarchy of CustomForm

1 string reference to 'CustomForm'
facebook_comments_box.routing.yml in ./facebook_comments_box.routing.yml
facebook_comments_box.routing.yml

File

src/Form/CustomForm.php, line 11

Namespace

Drupal\facebook_comments_box\Form
View source 
class CustomForm extends ConfigFormBase {

  /**
   * Constructor for ComproCustomForm.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
  }

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return 'facebook_comments_box_admin_form';
  }

  /**
   * Gets the configuration names that will be editable.
   *
   * @return array
   *   An array of configuration object names that are editable if called in
   *   conjunction with the trait's config() method.
   */
  protected function getEditableConfigNames() {
    return [
      'config.facebook_comments_box',
    ];
  }

  /**
   * Form constructor.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form structure.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['facebook_comments_box_global'] = array(
      '#type' => 'fieldset',
      '#title' => t('Global Settings'),
      '#collapsible' => TRUE,
    );
    $form['facebook_comments_box_global']['facebook_comments_box_admin_id'] = array(
      '#type' => 'textfield',
      '#title' => t('Facebook Admin ID'),
      '#default_value' => $this
        ->config('facebook_comments_box.settings')
        ->get('facebook_comments_box_admin_id'),
      '#description' => t('Your Facebook Admin Username, ID or App ID. More than one admin can be separated by commas.'),
      '#required' => TRUE,
    );
    $form['facebook_comments_box_default_block'] = array(
      '#type' => 'fieldset',
      '#title' => t('Default Block Settings'),
      '#collapsible' => TRUE,
    );
    $form['facebook_comments_box_default_block']['facebook_comments_box_default_comments'] = array(
      '#type' => 'select',
      '#title' => t('Default Number of Comments'),
      '#default_value' => $this
        ->config('facebook_comments_box.settings')
        ->get('facebook_comments_box_default_comments'),
      '#options' => array(
        10 => 10,
        20 => 20,
        30 => 30,
        50 => 50,
        100 => 100,
      ),
      '#description' => t('The number of comments to show by default on the page displaying them.'),
      '#required' => TRUE,
    );
    $form['facebook_comments_box_default_block']['facebook_comments_box_default_width'] = array(
      '#type' => 'textfield',
      '#title' => t('Default Width of Comments (in pixels)'),
      '#default_value' => $this
        ->config('facebook_comments_box.settings')
        ->get('facebook_comments_box_default_width'),
      '#size' => 4,
      '#maxlength' => 4,
      '#description' => t('The width of the comments with a minimum of 400px.'),
      '#required' => TRUE,
    );
    $form['facebook_comments_box_default_block']['facebook_comments_box_default_theme'] = array(
      '#type' => 'select',
      '#title' => t('Default Theme'),
      '#default_value' => $this
        ->config('facebook_comments_box.settings')
        ->get('facebook_comments_box_default_theme'),
      '#options' => array(
        'light' => t('Light'),
        'dark' => t('Dark'),
      ),
      '#description' => t('The default theme to use for comments.'),
      '#required' => TRUE,
    );

    //Store the node type keys as values for easier comparison.
    $fcb_all_node_types_keys = array_keys(node_type_get_types());
    $fcb_all_node_types = array();
    foreach ($fcb_all_node_types_keys as $node_type) {
      $fcb_all_node_types[$node_type] = $node_type;
    }
    $form['facebook_comments_box_default_block']['facebook_comments_box_default_node_types'] = array(
      '#type' => 'select',
      '#title' => t('Default Node Types'),
      '#default_value' => $this
        ->config('facebook_comments_box.settings')
        ->get('facebook_comments_box_node_types'),
      '#options' => $fcb_all_node_types,
      '#multiple' => TRUE,
      '#description' => t('The node types to attach comments to. This will make comments available for each of the selected node types.'),
      '#required' => TRUE,
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * Youtube API credentials form validate.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $admin_id = $form_state
      ->getValue('facebook_comments_box_admin_id');
    $default_comments = $form_state
      ->getValue('facebook_comments_box_default_comments');
    $default_width = $form_state
      ->getValue('facebook_comments_box_default_width');
    $default_theme = $form_state
      ->getValue('facebook_comments_box_default_theme');
    $node_types = $form_state
      ->getValue('facebook_comments_box_default_node_types');
    if (isset($admin_id) && isset($default_comments) && isset($default_width) && isset($default_theme) && isset($node_types)) {
      $this
        ->configFactory()
        ->getEditable('facebook_comments_box.settings')
        ->set('facebook_comments_box_admin_id', $admin_id)
        ->save();
      $this
        ->configFactory()
        ->getEditable('facebook_comments_box.settings')
        ->set('facebook_comments_box_default_comments', $default_comments)
        ->save();
      $this
        ->configFactory()
        ->getEditable('facebook_comments_box.settings')
        ->set('facebook_comments_box_default_width', $default_width)
        ->save();
      $this
        ->configFactory()
        ->getEditable('facebook_comments_box.settings')
        ->set('facebook_comments_box_default_theme', $default_theme)
        ->save();
      $this
        ->configFactory()
        ->getEditable('facebook_comments_box.settings')
        ->set('facebook_comments_box_node_types', $node_types)
        ->save();
      drupal_set_message(t('Facebook comments box credentials saved successfully'));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm 26
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
CustomForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CustomForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CustomForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CustomForm::validateForm public function Youtube API credentials form validate. Overrides FormBase::validateForm
CustomForm::__construct public function Constructor for ComproCustomForm. Overrides ConfigFormBase::__construct
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.
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.