class ReferenceSettingsLinksForm in Bibliography & Citation 8

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\ReferenceSettingsLinksForm

1 string reference to 'ReferenceSettingsLinksForm'

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/ReferenceSettingsLinksForm.php, line 14

Namespace

Drupal\bibcite_entity\Form

class ReferenceSettingsLinksForm extends ConfigFormBase {

  /**
   * Link plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $bibciteLinkManager;

  /**
   * Constructs a new ReferenceSettingsLinksForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $bibcite_link_manager
   *   Link plugin manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, PluginManagerInterface $bibcite_link_manager) {
    parent::__construct($config_factory);
    $this->bibciteLinkManager = $bibcite_link_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('bibcite_entity.reference.settings');
    $links = $config
      ->get('links');
    $form['links'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Label'),
        $this
          ->t('Enabled'),
        $this
          ->t('Weight'),
      ],
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'bibcite-links-order-weight',
        ],
      ],
    ];
    foreach ($this->bibciteLinkManager
      ->getDefinitions() as $plugin_id => $definition) {
      $weight = !empty($links[$plugin_id]['weight']) ? (int) $links[$plugin_id]['weight'] : NULL;
      $form['links'][$plugin_id]['#attributes']['class'][] = 'draggable';
      $form['links'][$plugin_id]['#weight'] = $weight;
      $form['links'][$plugin_id]['label'] = [
        '#plain_text' => $definition['label'],
      ];
      $form['links'][$plugin_id]['enabled'] = [
        '#type' => 'checkbox',
        '#default_value' => isset($links[$plugin_id]['enabled']) ? $links[$plugin_id]['enabled'] : TRUE,
      ];
      $form['links'][$plugin_id]['weight'] = [
        '#type' => 'weight',
        '#title' => t('Weight for @title', [
          '@title' => $definition['label'],
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $weight,
        '#attributes' => [
          'class' => [
            'bibcite-links-order-weight',
          ],
        ],
      ];
    }
    uasort($form['links'], 'Drupal\\Component\\Utility\\SortArray::sortByWeightProperty');
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('bibcite_entity.reference.settings');
    $links = $form_state
      ->getValue('links');
    array_walk($links, function (&$link) {
      $link['enabled'] = (bool) $link['enabled'];
      $link['weight'] = (int) $link['weight'];
    });
    $config
      ->set('links', $links);
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	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.
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.
ReferenceSettingsLinksForm::$bibciteLinkManager	protected	property	Link plugin manager.
ReferenceSettingsLinksForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ReferenceSettingsLinksForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
ReferenceSettingsLinksForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ReferenceSettingsLinksForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ReferenceSettingsLinksForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ReferenceSettingsLinksForm::__construct	public	function	Constructs a new ReferenceSettingsLinksForm object. 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.