interface GridLayoutDiscoveryInterface in Paragraphs Collection 8

Provides discovery for a YAML grid layout files in specific directories.

Hierarchy

• interface \Drupal\paragraphs_collection\GridLayoutDiscoveryInterface

2 files declare their use of GridLayoutDiscoveryInterface

OverviewController.php in src/Controller/OverviewController.php

ParagraphsGridLayoutPlugin.php in src/Plugin/paragraphs/Behavior/ParagraphsGridLayoutPlugin.php

File

src/GridLayoutDiscoveryInterface.php, line 8

Namespace

Drupal\paragraphs_collection

interface GridLayoutDiscoveryInterface {

  /**
   * Get a list of library names for the given layout.
   *
   * @param string $layout
   *   The layout name.
   *
   * @return string[]
   *   The library names list.
   */
  public function getLibraries($layout);

  /**
   * Get defined grid layouts.
   *
   * @return array
   *   Array of defined grid layouts.
   */
  public function getGridLayouts();

  /**
   * Gets sorted grid layout titles keyed by their machine names.
   *
   * @return array
   *   Array of availalable layout options in key value pairs, where the key
   *   is the machine name and the value the description.
   */
  public function getLayoutOptions();

  /**
   * Get layout by layout name.
   *
   * @param string $layout
   *   The layout name.
   *
   * @return array
   *   The layout configuration.
   */
  public function getLayout($layout);

}

Members

Name	Modifiers	Type	Description	Overrides
GridLayoutDiscoveryInterface::getGridLayouts	public	function	Get defined grid layouts.	1
GridLayoutDiscoveryInterface::getLayout	public	function	Get layout by layout name.	1
GridLayoutDiscoveryInterface::getLayoutOptions	public	function	Gets sorted grid layout titles keyed by their machine names.	1
GridLayoutDiscoveryInterface::getLibraries	public	function	Get a list of library names for the given layout.	1