You are here

class WebformReflectionHelper in Webform 8.5

Same name and namespace in other branches
  1. 6.x src/Utility/WebformReflectionHelper.php \Drupal\webform\Utility\WebformReflectionHelper

Helper class for reflection methods.

Hierarchy

Expanded class hierarchy of WebformReflectionHelper

5 files declare their use of WebformReflectionHelper
webform.install.update.inc in includes/webform.install.update.inc
Archived Webform update hooks.
Webform.php in src/Entity/Webform.php
WebformElementBase.php in src/Plugin/WebformElementBase.php
WebformPluginElementController.php in src/Controller/WebformPluginElementController.php
WebformReflectionHelperTest.php in tests/src/Unit/Utility/WebformReflectionHelperTest.php

File

src/Utility/WebformReflectionHelper.php, line 8

Namespace

Drupal\webform\Utility
View source
class WebformReflectionHelper {

  /**
   * A list of Webform submodules.
   *
   * @var array
   */
  protected static $modules;

  /**
   * Get a list of Webform submodules.
   *
   * @return array
   *   A list of Webform submodules.
   */
  public static function getSubModules() {
    if (isset(self::$modules)) {
      return self::$modules;
    }
    self::$modules = [];
    $files = \Drupal::service('file_system')
      ->scanDirectory(drupal_get_path('module', 'webform') . '/modules', '/.*\\.info\\.yml/');
    foreach ($files as $file) {
      $module_name = str_replace('.info.yml', '', $file->filename);
      self::$modules[$module_name] = $module_name;
    }
    return self::$modules;
  }

  /**
   * Get an object's class hierarchy.
   *
   * @param object $object
   *   An object.
   * @param string $base_class_name
   *   (optional) Base class name to use as the root of object's class
   *   hierarchy.
   *
   * @return array
   *   An array containing this elements class hierarchy.
   */
  public static function getParentClasses($object, $base_class_name = '') {
    $class = get_class($object);
    $parent_classes = [];
    while ($class_name = self::getClassName($class)) {
      $parent_classes[] = $class_name;
      $class = get_parent_class($class);
      if ($class_name === $base_class_name || !$class) {
        break;
      }
    }
    return array_reverse($parent_classes);
  }

  /**
   * Get a class's name without its namespace.
   *
   * @param string $class
   *   A class.
   *
   * @return string
   *   The class's name without its namespace.
   */
  protected static function getClassName($class) {
    $parts = preg_split('#\\\\#', $class);
    return end($parts);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
WebformReflectionHelper::$modules protected static property A list of Webform submodules.
WebformReflectionHelper::getClassName protected static function Get a class's name without its namespace.
WebformReflectionHelper::getParentClasses public static function Get an object's class hierarchy.
WebformReflectionHelper::getSubModules public static function Get a list of Webform submodules.