Plaisio\Console\Kernel\Helper\ClassHelper

Complexity

Total Complexity

9

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	classPath()	0	13	2
A	propertyDeclarationLine()	0	12	2
A	searchPattern()	0	11	3
A	classDeclarationLine()	0	11	2

<?php
declare(strict_types=1);

namespace Plaisio\Console\Kernel\Helper;

use Composer\Autoload\ClassLoader;
use Plaisio\Console\Exception\ConfigException;

/**
 * Utility class for classes.
 */
class ClassHelper
{
  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns the first line of the class declaration in the source code of a class.
   *
   * @param string[] $lines The source code of the class.
   * @param string   $class The name of the class.
   *
   * @return int
   */
  public static function classDeclarationLine(array $lines, string $class): int
  {
    $pattern = sprintf('/(\w\s+)?class\s+%s/', preg_quote($class));
    $line    = self::searchPattern($lines, $pattern);

    if ($line===null)
    {
      throw new ConfigException('Unable to find declaration of class %s', $class);
    }

    return $line;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns the path to the source file of a class.
   *
   * @param string $class The fully qualified name of the class.
   *
   * @return string
   */
  public static function classPath(string $class): string
  {
    /** @var ClassLoader $loader */
    $loader = spl_autoload_functions()[0][0];

    // Find the source file of the constant class.
    $filename = $loader->findFile(ltrim($class, '\\'));
    if ($filename===false)
    {
      throw new ConfigException("ClassLoader can not find class '%s'", $class);
    }

    return realpath($filename);
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns the line of a property declaration in the source code of a class.
   *
   * @param string[] $lines The source code of the class.
   * @param string   $name  The name of the property.
   *
   * @return int
   */
  public static function propertyDeclarationLine(array $lines, string $name): int
  {
    $pattern = sprintf('/^.*@property(-read)? (.+) (%s) (.*)$/',
                       preg_quote($name));
    $line    = self::searchPattern($lines, $pattern);

    if ($line===null)
    {
      throw new ConfigException('Unable to find property %s', $name);
    }

    return $line;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns the first line matching a regular expression.
   *
   * @param array  $lines   The source code of the class.
   * @param string $pattern The regular expression.
   *
   * @return int|null
   */
  private static function searchPattern(array $lines, string $pattern): ?int
  {
    foreach ($lines as $key => $line)
    {
      if (preg_match($pattern, $line)==1)
      {
        return $key;
      }
    }

    return null;
  }

  //--------------------------------------------------------------------------------------------------------------------
}

//----------------------------------------------------------------------------------------------------------------------