interface StaticMenuLinkOverridesInterface (View source)

Defines an interface for objects which overrides menu links defined in YAML.

Methods

reload()

Reloads the overrides from config.

array|null
loadOverride(string $id)

Loads any overrides to the definition of a static (YAML-defined) link.

deleteOverride(string $id)

Deletes any overrides to the definition of a static (YAML-defined) link.

deleteMultipleOverrides(array $ids)

Deletes multiple overrides to definitions of static (YAML-defined) links.

array
loadMultipleOverrides(array $ids)

Loads overrides to multiple definitions of a static (YAML-defined) link.

array
saveOverride(string $id, array $definition)

Saves the override.

string[]
getCacheTags()

The unique cache tag associated with this menu link override.

Details

reload()

Reloads the overrides from config.

Forces all overrides to be reloaded from config storage to compare the override value with the value submitted during test form submission.

array|null loadOverride(string $id)

Loads any overrides to the definition of a static (YAML-defined) link.

Parameters

string $id

A menu link plugin ID.

Return Value

array|null

An override with following supported keys:

  • parent
  • weight
  • menu_name
  • expanded
  • enabled or NULL if there is no override for the given ID.

deleteOverride(string $id)

Deletes any overrides to the definition of a static (YAML-defined) link.

Parameters

string $id

A menu link plugin ID.

deleteMultipleOverrides(array $ids)

Deletes multiple overrides to definitions of static (YAML-defined) links.

Parameters

array $ids

Array of menu link plugin IDs.

array loadMultipleOverrides(array $ids)

Loads overrides to multiple definitions of a static (YAML-defined) link.

Parameters

array $ids

Array of menu link plugin IDs.

Return Value

array

One or override keys by plugin ID.

See also

StaticMenuLinkOverridesInterface

array saveOverride(string $id, array $definition)

Saves the override.

Parameters

string $id

A menu link plugin ID.

array $definition

The definition values to override. Supported keys:

  • menu_name
  • parent
  • weight
  • expanded
  • enabled

Return Value

array

A list of properties which got saved.

string[] getCacheTags()

The unique cache tag associated with this menu link override.

Return Value

string[]

An array of cache tags.