annotate core/lib/Drupal/Core/Menu/StaticMenuLinkOverridesInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Menu;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Defines an interface for objects which overrides menu links defined in YAML.
Chris@0 7 */
Chris@0 8 interface StaticMenuLinkOverridesInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Reloads the overrides from config.
Chris@0 12 *
Chris@0 13 * Forces all overrides to be reloaded from config storage to compare the
Chris@0 14 * override value with the value submitted during test form submission.
Chris@0 15 */
Chris@0 16 public function reload();
Chris@0 17
Chris@0 18 /**
Chris@0 19 * Loads any overrides to the definition of a static (YAML-defined) link.
Chris@0 20 *
Chris@0 21 * @param string $id
Chris@0 22 * A menu link plugin ID.
Chris@0 23 *
Chris@0 24 * @return array|null
Chris@0 25 * An override with following supported keys:
Chris@0 26 * - parent
Chris@0 27 * - weight
Chris@0 28 * - menu_name
Chris@0 29 * - expanded
Chris@0 30 * - enabled
Chris@0 31 * or NULL if there is no override for the given ID.
Chris@0 32 */
Chris@0 33 public function loadOverride($id);
Chris@0 34
Chris@0 35 /**
Chris@0 36 * Deletes any overrides to the definition of a static (YAML-defined) link.
Chris@0 37 *
Chris@0 38 * @param string $id
Chris@0 39 * A menu link plugin ID.
Chris@0 40 */
Chris@0 41 public function deleteOverride($id);
Chris@0 42
Chris@0 43 /**
Chris@0 44 * Deletes multiple overrides to definitions of static (YAML-defined) links.
Chris@0 45 *
Chris@0 46 * @param array $ids
Chris@0 47 * Array of menu link plugin IDs.
Chris@0 48 */
Chris@0 49 public function deleteMultipleOverrides(array $ids);
Chris@0 50
Chris@0 51 /**
Chris@0 52 * Loads overrides to multiple definitions of a static (YAML-defined) link.
Chris@0 53 *
Chris@0 54 * @param array $ids
Chris@0 55 * Array of menu link plugin IDs.
Chris@0 56 *
Chris@0 57 * @return array
Chris@0 58 * One or override keys by plugin ID.
Chris@0 59 *
Chris@0 60 * @see \Drupal\Core\Menu\StaticMenuLinkOverridesInterface
Chris@0 61 */
Chris@0 62 public function loadMultipleOverrides(array $ids);
Chris@0 63
Chris@0 64 /**
Chris@0 65 * Saves the override.
Chris@0 66 *
Chris@0 67 * @param string $id
Chris@0 68 * A menu link plugin ID.
Chris@0 69 * @param array $definition
Chris@0 70 * The definition values to override. Supported keys:
Chris@0 71 * - menu_name
Chris@0 72 * - parent
Chris@0 73 * - weight
Chris@0 74 * - expanded
Chris@0 75 * - enabled
Chris@0 76 *
Chris@0 77 * @return array
Chris@0 78 * A list of properties which got saved.
Chris@0 79 */
Chris@0 80 public function saveOverride($id, array $definition);
Chris@0 81
Chris@0 82 /**
Chris@0 83 * The unique cache tag associated with this menu link override.
Chris@0 84 *
Chris@0 85 * @return string[]
Chris@0 86 * An array of cache tags.
Chris@0 87 */
Chris@0 88 public function getCacheTags();
Chris@0 89
Chris@0 90 }