You are here

interface UltimenuSkinInterface in Ultimenu 8.2

Interface for Ultimenu skins.

Hierarchy

Expanded class hierarchy of UltimenuSkinInterface

All classes that implement UltimenuSkinInterface

2 files declare their use of UltimenuSkinInterface
UltimenuBlock.php in src/Plugin/Block/UltimenuBlock.php
UltimenuSettingsForm.php in src/Form/UltimenuSettingsForm.php

File

src/UltimenuSkinInterface.php, line 8

Namespace

Drupal\ultimenu
View source
interface UltimenuSkinInterface extends UltimenuInterface {

  /**
   * Retrieves stored CSS files for Ultimenu skin options.
   *
   * @return array
   *   An array of available CSS files.
   */
  public function loadMultiple();

  /**
   * A reversed process to convert an option into a full CSS skin path.
   *
   * This silly reversion ensures the setting will be intact when moving around
   * CSS files, or theme and module directory.
   *
   * @param string $path
   *   The path that should be converted to full CSS path.
   *
   * @return string
   *   The CSS path containing ultimenu skins.
   */
  public function getPath($path);

  /**
   * Gets the skin basename.
   *
   * @param string $path
   *   The path to the CSS file.
   *
   * @return string
   *   The skin basename.
   */
  public function getName($path);

  /**
   * Clear the cache definitions.
   *
   * @param bool $all
   *   A flag to check if the clearing is affection all about Ultimenu.
   */
  public function clearCachedDefinitions($all = FALSE);

}

Members

Namesort descending Modifiers Type Description Overrides
UltimenuInterface::getBlockManager public function Returns the block manager. 1
UltimenuInterface::getConfig public function Returns the Config Factory object.
UltimenuInterface::getEntityTypeManager public function Returns the entity type manager. 1
UltimenuInterface::getSetting public function Returns the Ultimenu settings.
UltimenuSkinInterface::clearCachedDefinitions public function Clear the cache definitions. 1
UltimenuSkinInterface::getName public function Gets the skin basename. 1
UltimenuSkinInterface::getPath public function A reversed process to convert an option into a full CSS skin path. 1
UltimenuSkinInterface::loadMultiple public function Retrieves stored CSS files for Ultimenu skin options. 1