class GridStackVariantFormController in GridStack 8.2

Provides controller to load GridStackVariantForm.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\gridstack_ui\Controller\GridStackVariantFormController

Expanded class hierarchy of GridStackVariantFormController

File

modules/gridstack_ui/src/Controller/GridStackVariantFormController.php, line 16

Namespace

Drupal\gridstack_ui\Controller

View source

class GridStackVariantFormController extends ControllerBase {

  /**
   * The request service.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $request;

  /**
   * The gridstack manager.
   *
   * @var \Drupal\gridstack\GridStackManagerInterface
   */
  protected $manager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->request = $container
      ->get('request_stack')
      ->getCurrentRequest();
    $instance->manager = $container
      ->get('gridstack.manager');
    return $instance;
  }

  /**
   * Adds a gridstack variant.
   */
  public function add($gridstack, $gid, $gridstack_variant) {
    $name = str_replace([
      '-',
    ], '_', $gridstack_variant);
    $entity = GridStackVariant::load($name);
    if (empty($entity)) {
      $values = $gridstack
        ->toArray();
      $options = $values['options'];
      $options['icon'] = 'public://gridstack/' . $name . '.png';
      $entity = GridStackVariant::create([
        'name' => $name,
        'label' => str_replace([
          '-',
          '_',
        ], ' ', $gridstack_variant),
        'options' => $options,
        'source' => $gridstack
          ->id(),
      ]);
      $entity
        ->set('id', $name);
      $entity
        ->save();
    }
    return $this
      ->edit($gridstack, $gid, $entity);
  }

  /**
   * Duplicates a gridstack variant.
   */
  public function duplicate($gridstack, $gid, $gridstack_variant) {
    $name = $this->request->query
      ->get('dup', NULL);
    $label = $this->request->query
      ->get('label', NULL);
    if (empty($name)) {
      return [];
    }
    $values = $gridstack_variant
      ->toArray();
    $options = $values['options'];
    $options['icon'] = 'public://gridstack/' . $name . '.png';
    $entity = GridStackVariant::load($name);
    if (empty($entity)) {
      $entity = GridStackVariant::create([
        'name' => $name,
        'label' => $label ?: str_replace([
          '-',
          '_',
        ], ' ', $name),
        'options' => $options,
        'source' => $gridstack
          ->id(),
      ]);
      $entity
        ->set('id', $name);
      $entity
        ->save();
    }
    return $this
      ->edit($gridstack, $gid, $entity);
  }

  /**
   * Deletes a gridstack variant.
   */
  public function delete($gridstack, $gid, $gridstack_variant) {
    $this
      ->messenger()
      ->addMessage($this
      ->t('Variant %label was deleted', [
      '%label' => $gridstack_variant
        ->label(),
    ]));
    $gridstack_variant
      ->delete();
  }

  /**
   * Returns the variant editor.
   */
  public function edit($gridstack, $gid, $gridstack_variant) {
    $name = $this->request->query
      ->get('dup', NULL);
    $label = $this->request->query
      ->get('label', NULL);
    if ($name) {
      $values = $gridstack_variant
        ->toArray();
      $options = $values['options'];
      $options['icon'] = 'public://gridstack/' . $name . '.png';
      $entity = GridStackVariant::load($name);
      if (empty($entity)) {
        $entity = GridStackVariant::create([
          'name' => $name,
          'label' => $label ?: str_replace([
            '-',
            '_',
          ], ' ', $name),
          'options' => $options,
          'source' => $gridstack
            ->id(),
        ]);
        $entity
          ->set('id', $name);
        $entity
          ->save();
      }
      $gridstack_variant = $entity;
    }
    $form = $this
      ->entityFormBuilder()
      ->getForm($gridstack_variant, 'edit') ?: [];
    $response = new AjaxResponse();
    $response
      ->addCommand(new HtmlCommand('#' . GridStackDefault::variantWrapperId($gid), $form));
    return $response;
  }

  /**
   * Cancels layout changes.
   */
  public function cancel($gridstack, $gid) {
    $pub = $this->request->query
      ->get('pub', NULL);
    $vid = $this->request->query
      ->get('vid', NULL);
    $id = $gridstack
      ->id();
    $config = [
      'gid' => $gid,
      'optionset' => $id,
      'vid' => $vid,
      'pub' => $pub,
    ];
    $editor = $this->manager
      ->stylizer()
      ->builder()
      ->getVariantEditor($config, $gridstack);
    $response = new AjaxResponse();
    $response
      ->addCommand(new ReplaceCommand('#' . GridStackDefault::variantWrapperId($gid), $editor['form']));
    return $response;
  }

  /**
   * Returns the variant selection.
   */
  public function selection($gridstack, $gid) {
    $pub = $this->request->query
      ->get('pub', NULL);
    $vid = $this->request->query
      ->get('vid', NULL);
    $id = $gridstack
      ->id();
    $form = $this
      ->formBuilder()
      ->getForm('Drupal\\gridstack_ui\\Form\\GridStackVariantSelectionForm', $id, $gid, $vid, $pub);
    $response = new AjaxResponse();
    $response
      ->addCommand(new HtmlCommand('#' . GridStackDefault::variantWrapperId($gid), $form));
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
GridStackVariantFormController::$manager	protected	property	The gridstack manager.
GridStackVariantFormController::$request	protected	property	The request service.
GridStackVariantFormController::add	public	function	Adds a gridstack variant.
GridStackVariantFormController::cancel	public	function	Cancels layout changes.
GridStackVariantFormController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
GridStackVariantFormController::delete	public	function	Deletes a gridstack variant.
GridStackVariantFormController::duplicate	public	function	Duplicates a gridstack variant.
GridStackVariantFormController::edit	public	function	Returns the variant editor.
GridStackVariantFormController::selection	public	function	Returns the variant selection.
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 GridStackVariantFormController in GridStack 8.2

Hierarchy

File

Namespace

Members

API Navigation