class ParagraphsGridConfigForm in Paragraphs grid 8

Class ParagraphsGridConfigForm.

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\paragraphs_grid\Form\ParagraphsGridConfigForm

Expanded class hierarchy of ParagraphsGridConfigForm

1 string reference to 'ParagraphsGridConfigForm'

paragraphs_grid.routing.yml in ./paragraphs_grid.routing.yml: paragraphs_grid.routing.yml

File

src/Form/ParagraphsGridConfigForm.php, line 15

Namespace

Drupal\paragraphs_grid\Form

View source

class ParagraphsGridConfigForm extends ConfigFormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * List of all available entities of type grid_entity.
   *
   * @var array
   */
  protected $grids;

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The great and only Entity-Type-Manager.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The great and only EntityType Manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
    $this->entityFieldManager = $entity_field_manager;
  }

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

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

  /**
   * Returns grid entities as an array.
   *
   * @return array|\Drupal\Core\Entity\EntityInterface[]
   *   Grid entities.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getGrids() {
    if (!$this->grids) {
      $this->grids = $this->entityTypeManager
        ->getStorage('grid_entity')
        ->loadMultiple();
    }
    return $this->grids;
  }

  /**
   * Returns an option pack for select.
   *
   * @return array
   *   The grids as select options.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getGridTypeOptions() {
    $options = [];
    foreach ($this
      ->getGrids() as $grid) {

      /** @var \Drupal\paragraphs_grid\Entity\GridEntity $grid */
      $options['paragraphs_grid.grid_entity.' . $grid
        ->id()] = $grid
        ->label();
    }
    return $options;
  }

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

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $field_map = $this->entityFieldManager
      ->getFieldMapByFieldType('grid_field_type');
    if (count($field_map) && in_array('administrator', $this
      ->currentUser()
      ->getRoles())) {
      $this
        ->messenger()
        ->addWarning('Grid classes of current type are already in use. Data will be lost if you change the grid type.');
      $disable_grid_type = FALSE;
    }
    elseif (count($field_map)) {
      $disable_grid_type = TRUE;
    }
    else {
      $disable_grid_type = FALSE;
    }
    $config = $this
      ->config('paragraphs_grid.settings');
    $form['gridtype'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Grid type'),
      '#description' => $this
        ->t('Select the grid type you want to use. If you do not find your grid, you can create your own. Follow instructions on http://drupal.org/project/paragraphs_grid.'),
      '#options' => $this
        ->getGridTypeOptions(),
      '#default_value' => $config
        ->get('gridtype'),
      '#disabled' => $disable_grid_type,
    ];
    $use_css = $this
      ->t('Use CSS delivered from Paragraphs Grid');
    $form['uselibrary'] = [
      '#type' => 'checkbox',
      '#title' => $use_css,
      '#description' => $this
        ->t('Disable this checkbox, if your theme already includes the grid css and javascript.'),
      '#default_value' => $config
        ->get('uselibrary'),
    ];
    $form['use_lib_admin_pages'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Load grid-CSS even on administration pages.'),
      '#description' => $this
        ->t('Enable if grids are displayed on admin pages. Has no effect if the Option "%above" is disabled', [
        '%above' => $use_css,
      ]),
      '#default_value' => $config
        ->get('use_lib_admin_pages'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('paragraphs_grid.settings')
      ->set('gridtype', $form_state
      ->getValue('gridtype'))
      ->set('uselibrary', $form_state
      ->getValue('uselibrary'))
      ->set('use_lib_admin_pages', $form_state
      ->getValue('use_lib_admin_pages'))
      ->save();
  }

}

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.
ParagraphsGridConfigForm::$entityFieldManager	protected	property	The entity field manager.
ParagraphsGridConfigForm::$entityTypeManager	protected	property	The entity type manager.
ParagraphsGridConfigForm::$grids	protected	property	List of all available entities of type grid_entity.
ParagraphsGridConfigForm::buildForm	public	function	Overrides ConfigFormBase::buildForm
ParagraphsGridConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
ParagraphsGridConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ParagraphsGridConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ParagraphsGridConfigForm::getGrids	protected	function	Returns grid entities as an array.
ParagraphsGridConfigForm::getGridTypeOptions	protected	function	Returns an option pack for select.
ParagraphsGridConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ParagraphsGridConfigForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.

You are here

class ParagraphsGridConfigForm in Paragraphs grid 8

Hierarchy

File

Namespace

Members

API Navigation