annotate core/lib/Drupal/Core/Layout/LayoutPluginManagerInterface.php @ 19:fa3358dc1485 tip

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