class UltimenuSkin in Ultimenu 8.2

Provides Ultimenu skins utility methods.

Hierarchy

class \Drupal\ultimenu\UltimenuBase implements UltimenuInterface uses StringTranslationTrait, UltimenuTrait
- class \Drupal\ultimenu\UltimenuSkin implements UltimenuSkinInterface

Expanded class hierarchy of UltimenuSkin

1 string reference to 'UltimenuSkin'

ultimenu.services.yml in ./ultimenu.services.yml: ultimenu.services.yml

1 service uses UltimenuSkin

ultimenu.skin in ./ultimenu.services.yml: Drupal\ultimenu\UltimenuSkin

File

src/UltimenuSkin.php, line 18

Namespace

Drupal\ultimenu

View source

class UltimenuSkin extends UltimenuBase implements UltimenuSkinInterface {

  /**
   * The theme handler.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * The cache backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheBackend;

  /**
   * The info parser service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * Static cache for the skin path.
   *
   * @var array
   */
  protected $skinPath;

  /**
   * Static cache of skins.
   *
   * @var array
   */
  protected $skins;

  /**
   * Static cache of libraries.
   *
   * @var array
   */
  protected $libraries;

  /**
   * The cache key.
   *
   * @var string
   */
  protected $cacheKey = 'ultimenu';

  /**
   * Constructs a Ultimenu object.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, BlockManagerInterface $block_manager, ThemeHandlerInterface $theme_handler, FileSystemInterface $file_system, CacheBackendInterface $cache_backend) {
    parent::__construct($config_factory, $entity_type_manager, $block_manager);
    $this->themeHandler = $theme_handler;
    $this->fileSystem = $file_system;
    $this->cacheBackend = $cache_backend;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_type.manager'), $container
      ->get('plugin.manager.block'), $container
      ->get('theme_handler'), $container
      ->get('file_system'), $container
      ->get('cache.default'));
  }

  /**
   * {@inheritdoc}
   */
  public function getPath($uri) {
    if (!isset($this->skinPath[md5($uri)])) {
      list(, $skin_name) = array_pad(array_map('trim', explode("|", $uri, 2)), 2, NULL);
      if (strpos($uri, "module|") !== FALSE) {
        $skin_path = 'css/theme/' . $skin_name . '.css';
      }
      elseif (strpos($uri, "custom|") !== FALSE) {
        $path = $this
          ->getSetting('skins');
        $skin_path = '/' . $path . '/' . $skin_name . '.css';
      }
      elseif (strpos($uri, "theme|") !== FALSE) {
        $theme_default = $this
          ->getConfig('system.theme')
          ->get('default');
        $path = drupal_get_path('theme', $theme_default) . '/css/ultimenu';
        $skin_path = '/' . $path . '/' . $skin_name . '.css';
      }
      $this->skinPath[md5($uri)] = isset($skin_path) ? $skin_path : '';
    }
    return $this->skinPath[md5($uri)];
  }

  /**
   * {@inheritdoc}
   */
  public function getName($path) {
    $skin_name = $this->fileSystem
      ->basename($path, '.css');
    $skin_basename = str_replace("ultimenu--", "", $skin_name);
    return str_replace("-", "_", $skin_basename);
  }

  /**
   * {@inheritdoc}
   */
  public function loadMultiple() {
    if (!isset($this->skins)) {
      if ($cache = $this->cacheBackend
        ->get($this->cacheKey . ':skin')) {
        $this->skins = $cache->data;
      }
      else {
        $theme_default = $this
          ->getConfig('system.theme')
          ->get('default');
        $theme_skin = drupal_get_path('theme', $theme_default) . '/css/ultimenu';
        $custom_skin = $this
          ->getSetting('skins');
        $module_skin = drupal_get_path('module', 'ultimenu') . '/css/theme';
        $mask = '/.css$/';
        $files = [];
        if (is_dir($module_skin)) {
          foreach ($this->fileSystem
            ->scanDirectory($module_skin, $mask) as $filename => $file) {
            $files[$filename] = $file;
          }
        }
        if (!empty($custom_skin) && is_dir($custom_skin)) {
          foreach ($this->fileSystem
            ->scanDirectory($custom_skin, $mask) as $filename => $file) {
            $files[$filename] = $file;
          }
        }
        if (is_dir($theme_skin)) {
          foreach ($this->fileSystem
            ->scanDirectory($theme_skin, $mask) as $filename => $file) {
            $files[$filename] = $file;
          }
        }
        if ($files) {
          $skins = [];
          foreach ($files as $file) {
            $uri = $file->uri;
            $name = $file->name;

            // Simplify lengthy deep directory structure.
            if (strpos($uri, $module_skin) !== FALSE) {
              $uri = "module|" . $name;
            }
            elseif (!empty($custom_skin) && strpos($uri, $custom_skin) !== FALSE) {
              $uri = "custom|" . $name;
            }
            elseif (is_dir($theme_skin) && strpos($uri, $theme_skin) !== FALSE) {
              $uri = "theme|" . $name;
            }

            // Convert file name to CSS friendly for option label and styling.
            $skins[$uri] = Html::cleanCssIdentifier(mb_strtolower($name));
          }
          ksort($skins);
          $this->cacheBackend
            ->set($this->cacheKey . ':skin', $skins, Cache::PERMANENT, [
            'skin',
          ]);
          $this->skins = $skins;
        }
      }
    }
    return $this->skins;
  }

  /**
   * {@inheritdoc}
   */
  public function clearCachedDefinitions($all = FALSE) {

    // Invalidate the theme cache to update ultimenu region-based theme.
    $this->themeHandler
      ->refreshInfo();
    if ($all) {

      // Clear the skins cache.
      $this->skins = NULL;

      // Invalidate the block cache to update ultimenu-based derivatives.
      $this->blockManager
        ->clearCachedDefinitions();
    }
  }

  /**
   * Returns available off-canvas menus.
   */
  public function getOffCanvasSkins() {
    return [
      'bottomsheet',
      'pushdown',
      'scalein',
      'slidein',
      'slidein-oldies',
      'slideover',
      'zoomin',
    ];
  }

  /**
   * Implements hook_library_info_build().
   */
  public function libraryInfoBuild() {
    if (!isset($this->libraries)) {
      $common = [
        'version' => '1.x',
      ];
      $libraries = [];
      foreach ($this
        ->loadMultiple() as $key => $skin) {
        $skin_css_path = $this
          ->getPath($key);
        $skin_basename = $this
          ->getName($skin_css_path);
        $libraries['skin.' . $skin_basename] = [
          'css' => [
            'theme' => [
              $skin_css_path => [],
            ],
          ],
        ];
      }
      foreach ($this
        ->getOffCanvasSkins() as $skin) {
        $libraries['offcanvas.' . $skin] = [
          'css' => [
            'theme' => [
              'css/components/ultimenu.offcanvas.' . $skin . '.css' => [],
            ],
          ],
        ];
      }
      foreach ($libraries as &$library) {
        $library += $common;
        $library['dependencies'][] = 'ultimenu/offcanvas';
      }
      $this->libraries = $libraries;
    }
    return $this->libraries;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UltimenuBase::$blockManager	protected	property	Drupal\Core\Block\BlockManagerInterface.
UltimenuBase::$entityTypeManager	protected	property	The entity type manager service.
UltimenuBase::getBlockManager	public	function	Returns the block manager. Overrides UltimenuInterface::getBlockManager
UltimenuBase::getEntityTypeManager	public	function	Returns the entity type manager. Overrides UltimenuInterface::getEntityTypeManager
UltimenuSkin::$cacheBackend	protected	property	The cache backend.
UltimenuSkin::$cacheKey	protected	property	The cache key.
UltimenuSkin::$fileSystem	protected	property	The info parser service.
UltimenuSkin::$libraries	protected	property	Static cache of libraries.
UltimenuSkin::$skinPath	protected	property	Static cache for the skin path.
UltimenuSkin::$skins	protected	property	Static cache of skins.
UltimenuSkin::$themeHandler	protected	property	The theme handler.
UltimenuSkin::clearCachedDefinitions	public	function	Clear the cache definitions. Overrides UltimenuSkinInterface::clearCachedDefinitions
UltimenuSkin::create	public static	function	Overrides UltimenuBase::create
UltimenuSkin::getName	public	function	Gets the skin basename. Overrides UltimenuSkinInterface::getName
UltimenuSkin::getOffCanvasSkins	public	function	Returns available off-canvas menus.
UltimenuSkin::getPath	public	function	A reversed process to convert an option into a full CSS skin path. Overrides UltimenuSkinInterface::getPath
UltimenuSkin::libraryInfoBuild	public	function	Implements hook_library_info_build().
UltimenuSkin::loadMultiple	public	function	Retrieves stored CSS files for Ultimenu skin options. Overrides UltimenuSkinInterface::loadMultiple
UltimenuSkin::__construct	public	function	Constructs a Ultimenu object. Overrides UltimenuBase::__construct
UltimenuTrait::$configFactory	protected	property	Config Factory Service Object.
UltimenuTrait::getConfig	public	function
UltimenuTrait::getSetting	public	function
UltimenuTrait::getThemeDefault	public	function	Return a shortcut for the default theme.

You are here

class UltimenuSkin in Ultimenu 8.2

Hierarchy

File

Namespace

Members

API Navigation