UltimenuSkinInterface.php in Ultimenu 8.2

Namespace

Drupal\ultimenu

File

src/UltimenuSkinInterface.php

<?php

namespace Drupal\ultimenu;


/**
 * Interface for Ultimenu skins.
 */
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);

}

Interfaces

Name	Description
UltimenuSkinInterface	Interface for Ultimenu skins.