class GridStackHook in GridStack 8.2

Provides GridStack utility methods for Drupal hooks.

Hierarchy

• class \Drupal\gridstack\GridStackHook uses StringTranslationTrait

1 string reference to 'GridStackHook'

gridstack.services.yml in ./gridstack.services.yml

gridstack.services.yml

1 service uses GridStackHook

gridstack.hook in ./gridstack.services.yml

Drupal\gridstack\GridStackHook

File

src/GridStackHook.php, line 13

Namespace

Drupal\gridstack

class GridStackHook {
  use StringTranslationTrait;

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

  /**
   * Constructs a GridStack object.
   *
   * @param \Drupal\gridstack\GridStackManagerInterface $manager
   *   The gridstack manager service.
   */
  public function __construct(GridStackManagerInterface $manager) {
    $this->manager = $manager;
  }

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

  /**
   * Implements hook_config_schema_info_alter().
   *
   * @todo: Also verify widget.module, and revisit if any further change.
   * @todo replace with BlazyAlter::configSchemaInfoAlter() post blazy:8.x-2.0.
   */
  public function configSchemaInfoAlter(array &$definitions) {
    if (isset($definitions['layout_plugin.settings'])) {
      $this
        ->mapConfigSchemaInfoAlter($definitions['layout_plugin.settings']);
    }

    // @todo: Remove when DS passes layout.settings to layout_plugin.settings.
    if (isset($definitions['core.entity_view_display.*.*.*.third_party.ds'])) {
      $this
        ->mapConfigSchemaInfoAlter($definitions['core.entity_view_display.*.*.*.third_party.ds']['mapping']['layout']['mapping']['settings']);
    }
    foreach ([
      'gridstack_base',
      'gridstack_vanilla',
    ] as $key) {
      if (isset($definitions[$key])) {
        Blazy::configSchemaInfoAlter($definitions, $key, GridStackDefault::extendedSettings());
      }
    }
  }

  /**
   * Maps config schema.
   */
  public function mapConfigSchemaInfoAlter(array &$mappings, $source = '') {
    foreach (GridStackDefault::layoutSettings() as $key => $value) {
      if (is_array($value)) {
        $mappings['mapping'][$key]['type'] = 'sequence';
        $mappings['mapping'][$key]['label'] = $key;
        $mappings['mapping'][$key]['sequence'][0]['type'] = 'mapping';
        $mappings['mapping'][$key]['sequence'][0]['label'] = $key;
      }
      else {
        $mappings['mapping'][$key]['type'] = 'string';
        $mappings['mapping'][$key]['label'] = ucwords($key);
      }
    }
    foreach (GridStackDefault::regionSettings() as $key => $value) {
      if (is_array($value)) {
        $mappings['mapping']['regions']['sequence'][0]['mapping'][$key]['type'] = 'sequence';
        $mappings['mapping']['regions']['sequence'][0]['mapping'][$key]['label'] = $key;
        $mappings['mapping']['regions']['sequence'][0]['mapping'][$key]['sequence'][0]['type'] = 'mapping';
        $mappings['mapping']['regions']['sequence'][0]['mapping'][$key]['sequence'][0]['label'] = $key;
      }
      else {
        $mappings['mapping']['regions']['sequence'][0]['mapping'][$key]['type'] = 'string';
        $mappings['mapping']['regions']['sequence'][0]['mapping'][$key]['label'] = ucwords($key);
      }
    }
  }

  /**
   * Implements hook_library_info_alter().
   */
  public function libraryInfoAlter(&$libraries, $extension) {
    if ($path = \gridstack_libraries_get_path('gridstack')) {
      $libraries['gridstack']['js'] = [
        '/' . $path . '/dist/gridstack.min.js' => [
          'weight' => -2,
        ],
      ];
    }
    if (isset($libraries['backbone'])) {
      $libraries['backbone']['dependencies'][] = $this->manager
        ->configLoad('dev', 'gridstack.settings') ? 'gridstack/dev' : 'gridstack/all';
    }
    if (isset($libraries['load'])) {
      $libraries['load']['dependencies'][] = $this->manager
        ->configLoad('gridstatic', 'gridstack.settings') ? 'gridstack/gridstatic' : 'gridstack/gridstack';
    }
  }

  /**
   * Implements hook_field_formatter_info_alter().
   */
  public function fieldFormatterInfoAlter(array &$info) {
    $common = [
      'quickedit' => [
        'editor' => 'disabled',
      ],
      'provider' => 'gridstack',
    ];

    // Supports Media Entity via VEM within VEF if available.
    // @todo drop for blazy 2.x with core Media.
    if ($this->manager
      ->getModuleHandler()
      ->moduleExists('video_embed_media')) {
      $info['gridstack_file'] = $common + [
        'id' => 'gridstack_file',
        'label' => $this
          ->t('GridStack Image with VEF (deprecated)'),
        'description' => $this
          ->t('Display the images associated to VEM/ME as a simple mix of GridStack image/video (deprecated for GridStack Media).'),
        'class' => 'Drupal\\gridstack\\Plugin\\Field\\FieldFormatter\\GridStackFileFormatter',
        'field_types' => [
          'entity_reference',
          'image',
        ],
      ];
    }
    if ($this->manager
      ->getModuleHandler()
      ->moduleExists('paragraphs')) {
      $info['gridstack_paragraphs'] = $common + [
        'id' => 'gridstack_paragraphs',
        'label' => $this
          ->t('GridStack Paragraphs'),
        'description' => $this
          ->t('Display the Paragraphs as a GridStack.'),
        'class' => 'Drupal\\gridstack\\Plugin\\Field\\FieldFormatter\\GridStackParagraphsFormatter',
        'field_types' => [
          'entity_reference_revisions',
        ],
      ];
    }
  }

  /**
   * Implements hook_layout_alter().
   */
  public function layoutAlter(&$definitions) {
    $optionsets = $this->manager
      ->entityLoadMultiple('gridstack');
    $excluded = $this->manager
      ->configLoad('excludes', 'gridstack.settings');
    $framework = $this->manager
      ->configLoad('framework', 'gridstack.settings');
    $path = \drupal_get_path('module', 'gridstack');
    $excludes = [
      'default',
    ];
    if (!empty($excluded)) {
      $excludes = array_unique(array_merge($excludes, array_map('trim', explode(",", $excluded))));
    }
    foreach ($optionsets as $key => $optionset) {
      if (in_array($key, $excludes)) {
        continue;
      }
      $static = !empty($framework) && $optionset
        ->getOption('use_framework');
      $id = $optionset
        ->id();
      $layout_id = GridStackDefault::layoutId($id);
      $regions = $optionset
        ->prepareRegions();

      // Defines the layout.
      $definition = [
        'label' => $optionset
          ->label(),
        'category' => $static ? 'GridStack ' . ucwords($framework) : 'GridStack JS',
        'class' => '\\Drupal\\gridstack\\Plugin\\Layout\\GridStackLayout',
        'default_region' => 'gridstack_0',
        'icon' => $optionset
          ->getIconUrl(),
        'id' => $layout_id,
        'provider' => 'gridstack',
        'additional' => [
          'optionset' => $id,
        ],
        'regions' => $regions,
        'theme_hook' => 'gridstack',
        'path' => $path,
        'library' => 'gridstack/layout',
        'config_dependencies' => [
          'config' => [
            'gridstack.optionset.' . $id,
          ],
          'module' => [
            'gridstack',
          ],
        ],
      ];
      $definitions[$layout_id] = new LayoutDefinition($definition);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GridStackHook::$manager	protected	property	The gridstack manager service.
GridStackHook::configSchemaInfoAlter	public	function	Implements hook_config_schema_info_alter().
GridStackHook::create	public static	function
GridStackHook::fieldFormatterInfoAlter	public	function	Implements hook_field_formatter_info_alter().
GridStackHook::layoutAlter	public	function	Implements hook_layout_alter().
GridStackHook::libraryInfoAlter	public	function	Implements hook_library_info_alter().
GridStackHook::mapConfigSchemaInfoAlter	public	function	Maps config schema.
GridStackHook::__construct	public	function	Constructs a GridStack object.
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.