Inheritance diagram for ILIAS\Setup\ImplementationOfInterfaceFinder:

Collaboration diagram for ILIAS\Setup\ImplementationOfInterfaceFinder:

Public Member Functions
	__construct ()

	getMatchingClassNames (string $interface, array $additional_ignore=[], string $matching_path=null)
	The matcher finds the class names implementing the given interface, while ignoring paths in self::$ignore and and the additional patterns provided. More...

Protected Member Functions
	getAllClassNames (array $additional_ignore, string $matching_path=null)

Protected Attributes
string	$root

array	$ignore

array	$classmap = null

Detailed Description

Definition at line 28 of file ImplementationOfInterfaceFinder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\ImplementationOfInterfaceFinder::__construct ( )

Definition at line 52 of file ImplementationOfInterfaceFinder.php.

     {
         $this->root = substr(__FILE__, 0, strpos(__FILE__, DIRECTORY_SEPARATOR . "src"));
         $external_classmap = include "./libs/composer/vendor/composer/autoload_classmap.php";
         $this->classmap = $external_classmap ?: null;
     }

Member Function Documentation

◆ getAllClassNames()

ILIAS\Setup\ImplementationOfInterfaceFinder::getAllClassNames	(	array	$additional_ignore,
		string	$matching_path = `null`
	)

protected

Parameters

string[] $additional_ignore

Definition at line 90 of file ImplementationOfInterfaceFinder.php.

References $path.

Referenced by ILIAS\Setup\ImplementationOfInterfaceFinder\getMatchingClassNames().

                                                                                                : \Iterator
     {
         $ignore = array_merge($this->ignore, $additional_ignore);
 
         if (!is_array($this->classmap)) {
             throw new \LogicException("Composer ClassMap not loaded");
         }
 
         $regexp = implode(
             "|",
             array_map(
                 // fix path-separators to respect windows' backspaces.
                 fn ($v): string => "(" . str_replace('/', '(/|\\\\)', $v) . ")",
                 $ignore
             )
         );
         if ($matching_path) {
             $matching_path = str_replace('/', '(/|\\\\)', $matching_path);
         }
 
 
         foreach ($this->classmap as $class_name => $file_path) {
             $real_path = realpath($file_path);
             if ($real_path === false) {
                 throw new \RuntimeException(
                     "Could not find file for class $class_name (path: $file_path). " .
                     "Please check the composer classmap, maybe it is outdated. " .
                     "You can regenerate it by executing 'composer du' or 'composer install' " .
                     "(which also ensures dependencies are correctly installed) in the ILIAS root directory."
                 );
             }
 
             $path = str_replace($this->root, "", $real_path);
             if ($matching_path && !preg_match("#^" . $matching_path . "$#", $path)) {
                 continue;
             }
             if (!preg_match("#^" . $regexp . "$#", $path)) {
                 yield $class_name;
             }
         }
     }

Here is the caller graph for this function:

◆ getMatchingClassNames()

ILIAS\Setup\ImplementationOfInterfaceFinder::getMatchingClassNames	(	string	$interface,
		array	$additional_ignore = `[]`,
		string	$matching_path = `null`
	)

The matcher finds the class names implementing the given interface, while ignoring paths in self::$ignore and and the additional patterns provided.

Patterns are regexps (without delimiters) to define complete paths on the filesystem to be ignored or selected.

Parameters

string	$interface
	string[]	$additional_ignore
string \| null	$matching_path

Definition at line 70 of file ImplementationOfInterfaceFinder.php.

References Vendor\Package\$e, and ILIAS\Setup\ImplementationOfInterfaceFinder\getAllClassNames().

      : \Iterator {
         foreach ($this->getAllClassNames($additional_ignore, $matching_path) as $class_name) {
             try {
                 $r = new \ReflectionClass($class_name);
                 if ($r->isInstantiable() && $r->implementsInterface($interface)) {
                     yield $class_name;
                 }
             } catch (\Throwable $e) {
                 // noting to do here
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $classmap

array ILIAS\Setup\ImplementationOfInterfaceFinder::$classmap = null

protected

Definition at line 50 of file ImplementationOfInterfaceFinder.php.

◆ $ignore

array ILIAS\Setup\ImplementationOfInterfaceFinder::$ignore

protected

Initial value:

= [
        '.*/src/',
        '.*/libs/',
        '.*/test/',
        '.*/tests/',
        '.*/setup/',
        
        '.*ilSOAPAuth.*',
        
        '.*ilPDExternalFeedBlockGUI.*',
    ]