class ReferenceSettings in Bibliography & Citation 8

Same name and namespace in other branches

2.0.x modules/bibcite_entity/src/Form/ReferenceSettings.php \Drupal\bibcite_entity\Form\ReferenceSettings

Common Reference settings.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\bibcite_entity\Form\ReferenceSettings

Expanded class hierarchy of ReferenceSettings

1 string reference to 'ReferenceSettings'

bibcite_entity.routing.yml in modules/bibcite_entity/bibcite_entity.routing.yml: modules/bibcite_entity/bibcite_entity.routing.yml

File

modules/bibcite_entity/src/Form/ReferenceSettings.php, line 11

Namespace

Drupal\bibcite_entity\Form

View source

class ReferenceSettings extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config_modes = $this->configFactory
      ->listAll('core.entity_view_mode.bibcite_reference');
    $modes = [
      'default' => $this
        ->t('Default'),
    ];
    foreach ($config_modes as $config_name) {
      $mode = $this->configFactory
        ->getEditable($config_name);

      // Get substring 'view_mode_name' from 'bibcite_reference.view_mode_name'
      // id string. String 'bibcite_reference.' contains 18 symbols.
      $name = substr($mode
        ->get('id'), 18);
      $modes[$name] = $this
        ->t($mode
        ->get('label'));
    }
    $config = $this
      ->config('bibcite_entity.reference.settings');
    $form['view_mode'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Reference page view mode'),
      '#tree' => TRUE,
    ];
    $form['view_mode']['reference_page_view_mode'] = [
      '#type' => 'select',
      '#options' => $modes,
      '#title' => $this
        ->t('Reference page view mode'),
      '#description' => $this
        ->t('View mode which is used for rendering reference entities on their own pages.'),
      '#default_value' => $config
        ->get('display_override.reference_page_view_mode'),
    ];
    $form['ui_override'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Interface override'),
      '#tree' => TRUE,
    ];
    $form['ui_override']['enable_form_override'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Override entity forms'),
      '#description' => $this
        ->t("Regroup all base fields of Reference entity to vertical tabs. You can use it if you don't want to configure form display view."),
      '#default_value' => $config
        ->get('ui_override.enable_form_override'),
    ];
    $form['citekey'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Citation key'),
      '#tree' => TRUE,
    ];
    $form['citekey']['citekey_pattern'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Citation key pattern'),
      '#description' => $this
        ->t('Pattern for citation key automatic generation if value is not set.'),
      '#maxlength' => 255,
      '#default_value' => $config
        ->get('citekey.pattern'),
    ];
    $form['citekey']['token_help'] = [
      '#theme' => 'token_tree_link',
      '#token_types' => [
        'bibcite_reference',
      ],
      '#global_types' => TRUE,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('bibcite_entity.reference.settings');
    $config
      ->set('display_override.reference_page_view_mode', $form_state
      ->getValue([
      'view_mode',
      'reference_page_view_mode',
    ]));
    $config
      ->set('ui_override.enable_form_override', (bool) $form_state
      ->getValue([
      'ui_override',
      'enable_form_override',
    ]));
    $config
      ->set('citekey.pattern', $form_state
      ->getValue([
      'citekey',
      'citekey_pattern',
    ]));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

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

You are here

class ReferenceSettings in Bibliography & Citation 8

Hierarchy

File

Namespace

Members

API Navigation