annotate core/lib/Drupal/Core/Layout/LayoutPluginManagerInterface.php @ 9:1fc0ff908d1f

Add another data file
author Chris Cannam
date Mon, 05 Feb 2018 12:34:32 +0000
parents 4c8ae668cc8c
children 129ea1e6d783
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Layout;
Chris@0 4
Chris@0 5 use Drupal\Component\Plugin\CategorizingPluginManagerInterface;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Provides the interface for a plugin manager of layouts.
Chris@0 9 */
Chris@0 10 interface LayoutPluginManagerInterface extends CategorizingPluginManagerInterface {
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Gets theme implementations for layouts.
Chris@0 14 *
Chris@0 15 * @return array
Chris@0 16 * An associative array of the same format as returned by hook_theme().
Chris@0 17 *
Chris@0 18 * @see hook_theme()
Chris@0 19 */
Chris@0 20 public function getThemeImplementations();
Chris@0 21
Chris@0 22 /**
Chris@0 23 * {@inheritdoc}
Chris@0 24 *
Chris@0 25 * @return \Drupal\Core\Layout\LayoutInterface
Chris@0 26 */
Chris@0 27 public function createInstance($plugin_id, array $configuration = []);
Chris@0 28
Chris@0 29 /**
Chris@0 30 * {@inheritdoc}
Chris@0 31 *
Chris@0 32 * @return \Drupal\Core\Layout\LayoutDefinition|null
Chris@0 33 */
Chris@0 34 public function getDefinition($plugin_id, $exception_on_invalid = TRUE);
Chris@0 35
Chris@0 36 /**
Chris@0 37 * {@inheritdoc}
Chris@0 38 *
Chris@0 39 * @return \Drupal\Core\Layout\LayoutDefinition[]
Chris@0 40 */
Chris@0 41 public function getDefinitions();
Chris@0 42
Chris@0 43 /**
Chris@0 44 * {@inheritdoc}
Chris@0 45 *
Chris@0 46 * @return \Drupal\Core\Layout\LayoutDefinition[]
Chris@0 47 */
Chris@0 48 public function getSortedDefinitions(array $definitions = NULL);
Chris@0 49
Chris@0 50 /**
Chris@0 51 * {@inheritdoc}
Chris@0 52 *
Chris@0 53 * @return \Drupal\Core\Layout\LayoutDefinition[][]
Chris@0 54 */
Chris@0 55 public function getGroupedDefinitions(array $definitions = NULL);
Chris@0 56
Chris@0 57 /**
Chris@0 58 * Returns an array of layout labels grouped by category.
Chris@0 59 *
Chris@0 60 * @return string[][]
Chris@0 61 * A nested array of labels suitable for #options.
Chris@0 62 */
Chris@0 63 public function getLayoutOptions();
Chris@0 64
Chris@0 65 }