You are here

class SettingsForm in Bibliography & Citation 2.0.x

Same name in this branch
  1. 2.0.x src/Form/SettingsForm.php \Drupal\bibcite\Form\SettingsForm
  2. 2.0.x modules/bibcite_import/src/Form/SettingsForm.php \Drupal\bibcite_import\Form\SettingsForm
Same name and namespace in other branches
  1. 8 src/Form/SettingsForm.php \Drupal\bibcite\Form\SettingsForm

Common configuration.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
bibcite.routing.yml in ./bibcite.routing.yml
bibcite.routing.yml

File

src/Form/SettingsForm.php, line 14

Namespace

Drupal\bibcite\Form
View source
class SettingsForm extends ConfigFormBase {

  /**
   * The styler service.
   *
   * @var \Drupal\bibcite\CitationStylerInterface
   */
  protected $styler;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, CitationStylerInterface $styler) {
    parent::__construct($config_factory);
    $this->styler = $styler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('bibcite.citation_styler'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('bibcite.settings');
    $processor_definitions = $this->styler
      ->getAvailableProcessors();
    $processor_options = array_map(function ($definition) {
      return $definition['label'];
    }, $processor_definitions);
    $form['processor'] = [
      '#type' => 'select',
      '#options' => $processor_options,
      '#title' => $this
        ->t('Processor'),
      '#default_value' => $config
        ->get('processor'),
    ];
    $csl_styles = $this->styler
      ->getAvailableStyles();
    $styles_options = array_map(function ($entity) {

      /** @var \Drupal\bibcite\Entity\CslStyleInterface $entity */
      return $entity
        ->label();
    }, $csl_styles);
    $form['default_style'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default style'),
      '#options' => $styles_options,
      '#default_value' => $config
        ->get('default_style'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('bibcite.settings');
    $config
      ->set('processor', $form_state
      ->getValue('processor'))
      ->set('default_style', $form_state
      ->getValue('default_style'))
      ->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
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
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.
SettingsForm::$styler protected property The styler service.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.