You are here

Home » API reference » GridStack 8.2 » GridStackVariantListBuilder.php

class GridStackVariantListBuilder in GridStack 8.2

Provides a listing of GridStack optionsets.

Hierarchy

Expanded class hierarchy of GridStackVariantListBuilder

File

modules/gridstack_ui/src/Controller/GridStackVariantListBuilder.php, line 10

Namespace

Drupal\gridstack_ui\Controller
View source 
class GridStackVariantListBuilder extends GridStackListBuilder {

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

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [
      'source' => $this
        ->t('Source'),
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['source'] = [
      '#markup' => $entity
        ->source(),
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build[] = parent::render();
    $build[0]['description'] = [
      '#markup' => '<p>' . $this
        ->t("Manage the GridStack layout variants. Add variants via Layout Builder, not here. Use this page as a convenient way to apply changes globally to all pages. Each variant may be re-used at different pages, and their change will apply globally. To have unique variant per page, simply create memorable labels, such as: <code>Twain: About</code> to apply at About page. To edit original layouts, hit <code>Source</code> under <code>Operations</code>.") . '</p>',
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    if (isset($operations['duplicate'])) {
      unset($operations['duplicate']);
    }
    $operations['edit'] = [
      'title' => $this
        ->t('Configure'),
      'url' => $entity
        ->toUrl('edit-form'),
    ];
    $operations['delete'] = [
      'title' => $this
        ->t('Delete'),
      'url' => $entity
        ->toUrl('delete-form'),
    ];
    $access = $this->currentUser
      ->hasPermission('administer gridstack');
    if ($access && ($gridstack = $entity
      ->getOptionset())) {
      $operations['source'] = [
        'title' => $this
          ->t('Source'),
        'url' => $gridstack
          ->toUrl('edit-form'),
      ];
    }
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
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
DraggableListBuilder::$entities protected property The entities being listed. 1
DraggableListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. 3
DraggableListBuilder::$formBuilder protected property The form builder.
DraggableListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder protected function Returns the form builder.
DraggableListBuilder::validateForm public function Form validation handler. Overrides FormInterface::validateForm 2
DraggableListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct 5
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
GridStackListBuilder::$currentUser protected property The current user.
GridStackListBuilder::$manager protected property The gridstack manager.
GridStackListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilder::buildForm
GridStackListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
GridStackListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilder::submitForm
GridStackVariantListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides GridStackListBuilder::buildHeader
GridStackVariantListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides GridStackListBuilder::buildRow
GridStackVariantListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides GridStackListBuilder::getDefaultOperations
GridStackVariantListBuilder::getFormId public function Returns a unique string identifying the form. Overrides GridStackListBuilder::getFormId
GridStackVariantListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides GridStackListBuilder::render
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.