class GroupAddForm in Context groups 8.2

Same name and namespace in other branches

8 src/Form/GroupAddForm.php \Drupal\context_groups\Form\GroupAddForm

Class GroupDeleteForm.

@package Drupal\context_groups\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\context_groups\Form\GroupAddForm

Expanded class hierarchy of GroupAddForm

1 string reference to 'GroupAddForm'

context_groups.routing.yml in ./context_groups.routing.yml: context_groups.routing.yml

File

src/Form/GroupAddForm.php, line 23

Namespace

Drupal\context_groups\Form

View source

class GroupAddForm extends FormBase {

  /**
   * Drupal\Core\Entity\EntityTypeManager definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * The Context module context manager.
   *
   * @var \Drupal\context\ContextManager
   */
  protected $contextManager;

  /**
   * Drupal\Core\Entity\Query\QueryFactory definition.
   *
   * @var Drupal\Core\Entity\Query\QueryFactory
   */
  protected $entityQuery;

  /**
   * The context where context group will be created.
   *
   * @var Context
   */
  protected $context;

  /**
   * GroupAddForm constructor.
   *
   * @param EntityTypeManager $entityTypeManager
   *   Entity type manager.
   * @param ContextManager $contextManager
   *   Context manager.
   */
  public function __construct(EntityTypeManager $entityTypeManager, ContextManager $contextManager) {
    $this->entityTypeManager = $entityTypeManager;
    $this->contextManager = $contextManager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'context-group-add-group';
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->saveGroup($form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $context = NULL, $theme = NULL) {
    $this->context = $this->entityTypeManager
      ->getStorage('context')
      ->load($context);

    // Group name field.
    $form['group_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Group name'),
      '#required' => TRUE,
    ];
    $form['name'] = [
      '#type' => 'machine_name',
      '#title' => $this
        ->t('Machine name'),
      '#machine_name' => [
        'source' => [
          'group_name',
        ],
        'exists' => [
          $this,
          'groupExists',
        ],
      ],
    ];
    $form['class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Class'),
      '#descriptions' => $this
        ->t('Set classes to group. Separate multiple classes with space.'),
    ];
    $form['region'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Select region'),
      '#options' => $this
        ->getRegionsList($theme),
      '#description' => $this
        ->t('Select the region where this group should be inserted.'),
    ];
    $form['context_id'] = [
      '#type' => 'hidden',
      '#value' => $context,
    ];
    $form['theme'] = [
      '#type' => 'hidden',
      '#value' => $theme,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add group'),
      '#button_type' => 'primary',
      '#ajax' => [
        'callback' => '::submitFormAjax',
        'wrapper' => 'context-group-add-group',
        'effect' => 'fade',
      ],
    ];
    return $form;
  }

  /**
   * Handle when the form is submitted through AJAX.
   *
   * @return AjaxResponse
   *   Return AjaxResponse object.
   */
  public function submitFormAjax(&$form, FormStateInterface $form_state) {
    $contextForm = $this->contextManager
      ->getForm($this->context, 'edit');
    $response = new AjaxResponse();
    if ($form_state
      ->getErrors()) {
      $output[] = StatusMessages::renderMessages(NULL);
      $output[] = $form;

      // Ajax commands.
      $response
        ->addCommand(new RemoveCommand('.messages.messages--error'));
      $response
        ->addCommand(new ReplaceCommand('[id^="context-group-add-group"]', $output));
    }
    else {
      $response
        ->addCommand(new CloseModalDialogCommand());
      $response
        ->addCommand(new ReplaceCommand('#context-reactions', $contextForm['reactions']));
    }
    return $response;
  }

  /**
   * Get list of regions in theme.
   *
   * @param string $theme
   *   Theme name.
   *
   * @return array
   *   List of regions.
   */
  private function getRegionsList($theme) {
    return system_region_list($theme, BlockRepositoryInterface::REGIONS_ALL);
  }

  /**
   * Check to see if group with the specified name already exists .
   *
   * @param string $name
   *   The machine name to check for.
   * @param array $element
   *   Machine name form element.
   * @param FormStateInterface $form_state
   *   Formstate object.
   *
   * @return bool
   *   True or false.
   */
  public function groupExists($name, array $element, FormStateInterface $form_state) {

    // Get all contexts.
    $query = $this->entityTypeManager
      ->getStorage('context')
      ->getQuery();
    $context_ids = $query
      ->execute();
    $context_storage = $this->entityTypeManager
      ->getStorage('context');
    foreach ($context_ids as $cid) {
      $context = $context_storage
        ->load($cid);
      $groups = $context
        ->getThirdPartySetting('context_groups', $name);
      if (!empty($groups)) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Save group to database.
   *
   * @param FormStateInterface $form_state
   *   FormState object.
   */
  private function saveGroup(FormStateInterface $form_state) {

    // Load current context.
    $cid = $form_state
      ->getValue('context_id');
    $context = $this->entityTypeManager
      ->getStorage('context')
      ->load($cid);

    // Get data of context group.
    $data['name'] = $form_state
      ->getValue('name');
    $data['label'] = $form_state
      ->getValue('group_name');
    $data['region'] = $form_state
      ->getValue('region');
    $data['parent'] = '';
    $data['weight'] = 0;
    $data['theme'] = $form_state
      ->getValue('theme');
    $data['class'] = $form_state
      ->getValue('class');

    // Save group to context.
    $context
      ->setThirdPartySetting('context_groups', $form_state
      ->getValue('name'), $data);

    // Save context.
    $context
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
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
GroupAddForm::$context	protected	property	The context where context group will be created.
GroupAddForm::$contextManager	protected	property	The Context module context manager.
GroupAddForm::$entityQuery	protected	property	Drupal\Core\Entity\Query\QueryFactory definition.
GroupAddForm::$entityTypeManager	protected	property	Drupal\Core\Entity\EntityTypeManager definition.
GroupAddForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
GroupAddForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
GroupAddForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
GroupAddForm::getRegionsList	private	function	Get list of regions in theme.
GroupAddForm::groupExists	public	function	Check to see if group with the specified name already exists .
GroupAddForm::saveGroup	private	function	Save group to database.
GroupAddForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
GroupAddForm::submitFormAjax	public	function	Handle when the form is submitted through AJAX.
GroupAddForm::__construct	public	function	GroupAddForm constructor.
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.

You are here

class GroupAddForm in Context groups 8.2

Hierarchy

File

Namespace

Members

API Navigation