class UIkitComponents in UIkit Components 8.3

Provides helper functions for the UIkit Components module.

Hierarchy

• class \Drupal\uikit_components\UIkitComponents

6 files declare their use of UIkitComponents

AdminForm.php in src/Form/AdminForm.php

alter.inc in includes/alter.inc

Modify structured content arrays.

MenuEditForm.php in src/Form/MenuEditForm.php

preprocess.inc in includes/preprocess.inc

Set up variables to be placed within the template (.html.twig) files.

theme.inc in includes/theme.inc

The UIkit Components theme system.

... See full list

File

src/UIkitComponents.php, line 11

Namespace

Drupal\uikit_components

class UIkitComponents {

  /**
   * Loads a project's include file.
   *
   * This function essentially does the same as Drupal core's
   * module_load_include() function, except targeting theme include files. It also
   * allows you to place the include files in a sub-directory of the theme for
   * better organization.
   *
   * Examples:
   * @code
   *   // Load node.admin.inc from the node module.
   *   UIkitComponents::loadIncludeFile('inc', 'node', 'module', 'node.admin');
   *
   *   // Load includes/alter.inc from the uikit theme.
   *   UIkitComponents::loadIncludeFile('inc', 'uikit', 'theme', 'preprocess', 'includes');
   * @endcode
   *
   * Do not use this function in a global context since it requires Drupal to be
   * fully bootstrapped, use require_once DRUPAL_ROOT . '/path/file' instead.
   *
   * @param string $type
   *   The include file's type (file extension).
   * @param string $project
   *   The project to which the include file belongs.
   * @param string $project_type
   *   The project type to which the include file belongs, either "theme" or
   *   "module". Defaults to "module".
   * @param string $name
   *   (optional) The base file name (without the $type extension). If omitted,
   *   $theme is used; i.e., resulting in "$theme.$type" by default.
   * @param string $sub_directory
   *   (optional) The sub-directory to which the include file resides.
   *
   * @return string
   *   The name of the included file, if successful; FALSE otherwise.
   */
  public static function loadIncludeFile($type, $project, $project_type = 'module', $name = NULL, $sub_directory = '') {
    static $files = [];
    if (isset($sub_directory)) {
      $sub_directory = '/' . $sub_directory;
    }
    if (!isset($name)) {
      $name = $project;
    }
    $key = $type . ':' . $project . ':' . $name . ':' . $sub_directory;
    if (isset($files[$key])) {
      return $files[$key];
    }
    if (function_exists('drupal_get_path')) {
      $file = DRUPAL_ROOT . '/' . drupal_get_path($project_type, $project) . "{$sub_directory}/{$name}.{$type}";
      if (is_file($file)) {
        require_once $file;
        $files[$key] = $file;
        return $file;
      }
      else {
        $files[$key] = FALSE;
      }
    }
    return FALSE;
  }

  /**
   * Get the library version from the UIkit base theme.
   *
   * @return string
   *   The major version of the UIkit library from the install UIkit base theme.
   */
  public static function getUIkitLibraryVersion() {
    $theme_list = \Drupal::service('theme_handler')
      ->listInfo();

    // Translatable strings.
    $t_args = [
      ':clear_cache' => Url::fromRoute('system.performance_settings')
        ->toString(),
      ':themes_page' => Url::fromRoute('system.themes_page')
        ->toString(),
      ':uikit_project' => Url::fromUri('https://www.drupal.org/project/uikit')
        ->toString(),
    ];
    if (isset($theme_list['uikit'])) {
      $uikit_libraries = Yaml::parse(file_get_contents(drupal_get_path('theme', 'uikit') . '/uikit.libraries.yml'));
      return $uikit_libraries['uikit']['version'];
    }
    else {
      \Drupal::messenger()
        ->addError(t('The UIkit base theme is either not installed or enabled. Please <a href=":themes_page">enable</a>, or <a href=":uikit_project" target="_blank">download</a> and <a href=":themes_page">install</a> UIkit. If UIkit is installed and enabled, try <a href=":clear_cache">clearing all caches</a>.', $t_args));
      return FALSE;
    }
  }

  /**
   * Get the UIkit list of components to define as render elements.
   *
   * Since UIkit Components will not define all UIkit components as render
   * elements, this list serves as the list of components defined as render
   * elements using the Render API.
   *
   * @return array
   *   Returns an array of UIkit component short-names for render elements.
   */
  public static function getRenderElementList() {
    return [
      'accordion',
      'alert',
      'article',
      'badge',
      'breadcrumb',
      'button',
      'card',
      'comment',
      'countdown',
      'cover',
      'description_list',
      'dotnav',
      'drop',
      'dropdown',
      'icon',
      'iconnav',
      'lightbox',
      'list',
      'modal',
      'nav',
      'navbar',
      'notification',
      'overlay',
      'pagination',
      'progress',
      'section',
      'slidenav',
      'slideshow',
      'spinner',
      'subnav',
      'switcher',
      'tab',
      'table',
      'thumbnav',
      'tile',
      'tooltip',
      'video',
    ];
  }

  /**
   * Get the UIkit documentation URL for the given component.
   *
   * @param string $component
   *   The component to return a URL for.
   *
   * @return string
   *   Returns a URL for the given component if set, FALSE otherwise.
   */
  public static function getComponentURL($component) {
    if (!$component) {
      \Drupal::messenger()
        ->addWarning(t('URL cannot be returned, no component was given in <em class="placeholder">UIkitComponents::getComponentURL()</em>.'));
      return FALSE;
    }
    else {
      $uri = 'https://getuikit.com/docs/' . $component;
      return Url::fromUri($uri)
        ->toString();
    }
  }

  /**
   * Returns the menu style.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @return bool
   *   Returns menu style, FALSE otherwise.
   */
  public static function getMenuStyle($menu) {
    return \Drupal::state()
      ->get($menu . '_menu_style') ?: 0;
  }

  /**
   * Sets the menu style.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @param string $value
   *   The style value to set for the menu.
   */
  public static function setMenuStyle($menu, $value) {
    \Drupal::state()
      ->set($menu . '_menu_style', $value);
  }

  /**
   * Returns the large modifier.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @return bool
   *   Returns TRUE if the large modifier is set, FALSE otherwise.
   */
  public static function getLargeList($menu) {
    return \Drupal::state()
      ->get($menu . '_menu_style_list_large') ?: 0;
  }

  /**
   * Sets the large modifier setting.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @param string $value
   *   The large modifier value to set for the menu.
   */
  public static function setLargeList($menu, $value) {
    \Drupal::state()
      ->set($menu . '_menu_style_list_large', $value);
  }

  /**
   * Returns the nav style modifier.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @return bool
   *   Returns TRUE if nav style modifier is set, FALSE otherwise.
   */
  public static function getNavStyleModifier($menu) {
    return \Drupal::state()
      ->get($menu . '_menu_style_nav_style_modifiers') ?: 0;
  }

  /**
   * Sets the nav style modifier.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @param string $value
   *   The nav style modifier value to set for the menu.
   */
  public static function setNavStyleModifier($menu, $value) {
    \Drupal::state()
      ->set($menu . '_menu_style_nav_style_modifiers', $value);
  }

  /**
   * Returns the nav center modifier setting.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @return bool
   *   Returns TRUE if nav center modifier is set, FALSE otherwise.
   */
  public static function getNavCenterModifier($menu) {
    return \Drupal::state()
      ->get($menu . '_menu_style_nav_center_modifier') ?: 0;
  }

  /**
   * Sets the nav center modifier.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @param string $value
   *   The nav center modifier value to set for the menu.
   */
  public static function setNavCenterModifier($menu, $value) {
    \Drupal::state()
      ->set($menu . '_menu_style_nav_center_modifier', $value);
  }

  /**
   * Returns the menu nav width classes.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @return bool
   *   Returns TRUE if the nav width classes are set, FALSE otherwise.
   */
  public static function getNavWidthClasses($menu) {
    return \Drupal::state()
      ->get($menu . '_menu_style_wrapper_widths') ?: 0;
  }

  /**
   * Sets the nav center modifier.
   *
   * @param string $menu
   *   The name of the menu.
   *
   * @param string $value
   *   The nav center modifier value to set for the menu.
   */
  public static function setNavWidthClasses($menu, $value) {
    \Drupal::state()
      ->set($menu . '_menu_style_wrapper_widths', $value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UIkitComponents::getComponentURL	public static	function	Get the UIkit documentation URL for the given component.
UIkitComponents::getLargeList	public static	function	Returns the large modifier.
UIkitComponents::getMenuStyle	public static	function	Returns the menu style.
UIkitComponents::getNavCenterModifier	public static	function	Returns the nav center modifier setting.
UIkitComponents::getNavStyleModifier	public static	function	Returns the nav style modifier.
UIkitComponents::getNavWidthClasses	public static	function	Returns the menu nav width classes.
UIkitComponents::getRenderElementList	public static	function	Get the UIkit list of components to define as render elements.
UIkitComponents::getUIkitLibraryVersion	public static	function	Get the library version from the UIkit base theme.
UIkitComponents::loadIncludeFile	public static	function	Loads a project's include file.
UIkitComponents::setLargeList	public static	function	Sets the large modifier setting.
UIkitComponents::setMenuStyle	public static	function	Sets the menu style.
UIkitComponents::setNavCenterModifier	public static	function	Sets the nav center modifier.
UIkitComponents::setNavStyleModifier	public static	function	Sets the nav style modifier.
UIkitComponents::setNavWidthClasses	public static	function	Sets the nav center modifier.