Class ilCtrlStructureReader is responsible for reading ilCtrl's control structure. More...

Collaboration diagram for ilCtrlStructureReader:

Public Member Functions
	__construct (ilCtrlIteratorInterface $iterator, ilCtrlStructureCidGenerator $cid_generator)
	ilCtrlStructureReader Constructor More...

	isExecuted ()
	Returns whether this instance was already executed or not. More...

	readStructure ()
	Processes all classes within the ILIAS installation. More...

Data Fields
const	REGEX_GUI_CLASS_NAME = '/^class\.([A-z0-9]*(GUI))\.php$/'

Private Member Functions
	getReferencedClassesByReflection (ReflectionClass $reflection, string $regex)
	Returns all classes referenced by an ilCtrl_Calls or ilCtrl_isCalledBy statement. More...

	getRelativePath (string $absolute_path)
	Returns a given path relative to the ILIAS absolute path. More...

	getChildren (ReflectionClass $reflection)
	Helper function that returns all children references. More...

	getParents (ReflectionClass $reflection)
	Helper function that returns all parent references. More...

	stripWhitespaces (string $string)
	Helper function that replaces all whitespace characters from the given string. More...

	isGuiClass (string $path)
	Returns whether the given file/path matches ILIAS conventions. More...

	isNamespaced (string $class_name)
	Returns if the given classname is namespaced. More...

Private Attributes
const	REGEX_PHPDOC_CALLS = '/(((?i)@ilctrl_calls)\s({CLASS_NAME}(:\s\|\s:\s))\K)([A-z0-9,\s])*/'

const	REGEX_PHPDOC_CALLED_BYS = '/(((?i)@ilctrl_iscalledby)\s({CLASS_NAME}(:\s\|\s:\s))\K)([A-z0-9,\s])*/'

ilCtrlStructureCidGenerator	$cid_generator

ilCtrlIteratorInterface	$iterator

bool	$is_executed = false

string	$ilias_path

Detailed Description

Class ilCtrlStructureReader is responsible for reading ilCtrl's control structure.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 16 of file class.ilCtrlStructureReader.php.

Constructor & Destructor Documentation

◆ __construct()

ilCtrlStructureReader::__construct	(	ilCtrlIteratorInterface	$iterator,
		ilCtrlStructureCidGenerator	$cid_generator
	)

ilCtrlStructureReader Constructor

Parameters

ilCtrlIteratorInterface	$iterator
ilCtrlStructureCidGenerator	$cid_generator

Definition at line 71 of file class.ilCtrlStructureReader.php.

References $cid_generator, and $iterator.

     {
         $this->ilias_path = rtrim(
             (defined('ILIAS_ABSOLUTE_PATH')) ?
                 ILIAS_ABSOLUTE_PATH : dirname(__FILE__, 5),
             '/'
         );
 
         $this->cid_generator = $cid_generator;
         $this->iterator = $iterator;
     }

Member Function Documentation

◆ getChildren()

ilCtrlStructureReader::getChildren ( ReflectionClass $reflection )

private

Helper function that returns all children references.

Parameters

ReflectionClass $reflection

Returns: array

Definition at line 210 of file class.ilCtrlStructureReader.php.

References getReferencedClassesByReflection().

Referenced by readStructure().

                                                              : array
     {
         return $this->getReferencedClassesByReflection($reflection, self::REGEX_PHPDOC_CALLS);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParents()

ilCtrlStructureReader::getParents ( ReflectionClass $reflection )

private

Helper function that returns all parent references.

Parameters

ReflectionClass $reflection

Returns: array

Definition at line 221 of file class.ilCtrlStructureReader.php.

References getReferencedClassesByReflection().

Referenced by readStructure().

                                                             : array
     {
         return $this->getReferencedClassesByReflection($reflection, self::REGEX_PHPDOC_CALLED_BYS);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReferencedClassesByReflection()

ilCtrlStructureReader::getReferencedClassesByReflection	(	ReflectionClass	$reflection,
		string	$regex
	)

private

Returns all classes referenced by an ilCtrl_Calls or ilCtrl_isCalledBy statement.

Parameters

ReflectionClass	$reflection
string	$regex

Returns: array

Definition at line 155 of file class.ilCtrlStructureReader.php.

References stripWhitespaces().

Referenced by getChildren(), and getParents().

                                                                                                  : array
     {
         // abort if the class has no PHPDoc comment.
         if (!$reflection->getDocComment()) {
             return [];
         }
 
         // replace the classname placeholder with the
         // actual one and execute the regex search.
         $name = str_replace('\\', '\\\\', $reflection->getName());
         $regex = str_replace('{CLASS_NAME}', $name, $regex);
         preg_match_all($regex, $reflection->getDocComment(), $matches);
 
         // the first array entry of $matches contains
         // the list's of statements found.
         if (empty($matches[0])) {
             return [];
         }
 
         $referenced_classes = [];
         foreach ($matches[0] as $class_list) {
             // explode lists and strip all whitespaces.
             foreach (explode(',', $class_list) as $class) {
                 $class_name = $this->stripWhitespaces($class);
                 if (!empty($class_name)) {
                     $referenced_classes[] = strtolower($class_name);
                 }
             }
         }
 
         return $referenced_classes;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRelativePath()

ilCtrlStructureReader::getRelativePath ( string $absolute_path )

private

Returns a given path relative to the ILIAS absolute path.

Parameters

string $absolute_path

Returns: string

Definition at line 194 of file class.ilCtrlStructureReader.php.

Referenced by readStructure().

                                                            : string
     {
         // some paths might contain syntax like '../../../' etc.
         // and realpath() resolves that in order to cut off the
         // ilias installation path properly.
         $absolute_path = realpath($absolute_path);
 
         return '.' . str_replace($this->ilias_path, '', $absolute_path);
     }

Here is the caller graph for this function:

◆ isExecuted()

ilCtrlStructureReader::isExecuted ( )

Returns whether this instance was already executed or not.

Returns: bool

Definition at line 88 of file class.ilCtrlStructureReader.php.

References $is_executed.

                                 : bool
     {
         return $this->is_executed;
     }

◆ isGuiClass()

ilCtrlStructureReader::isGuiClass ( string $path )

private

Returns whether the given file/path matches ILIAS conventions.

Parameters

string $path

Returns: bool

Definition at line 244 of file class.ilCtrlStructureReader.php.

Referenced by readStructure().

                                              : bool
     {
         return (bool) preg_match(self::REGEX_GUI_CLASS_NAME, basename($path));
     }

Here is the caller graph for this function:

◆ isNamespaced()

ilCtrlStructureReader::isNamespaced ( string $class_name )

private

Returns if the given classname is namespaced.

Parameters

string $class_name

Returns: bool

Definition at line 255 of file class.ilCtrlStructureReader.php.

Referenced by readStructure().

                                                      : bool
     {
         return (false !== strpos($class_name, '\\'));
     }

Here is the caller graph for this function:

◆ readStructure()

ilCtrlStructureReader::readStructure ( )

Processes all classes within the ILIAS installation.

Returns: array

Definition at line 98 of file class.ilCtrlStructureReader.php.

References Vendor\Package\$e, $path, $structure, getChildren(), getParents(), getRelativePath(), isGuiClass(), isNamespaced(), ilCtrlStructureInterface\KEY_CLASS_CHILDREN, ilCtrlStructureInterface\KEY_CLASS_CID, ilCtrlStructureInterface\KEY_CLASS_NAME, ilCtrlStructureInterface\KEY_CLASS_PARENTS, and ilCtrlStructureInterface\KEY_CLASS_PATH.

                                    : array
     {
         $base_classes = $structure = [];
         foreach ($this->iterator as $class_name => $path) {
             // skip iteration if class doesn't meet ILIAS GUI class criteria.
             if (!$this->isGuiClass($path)) {
                 continue;
             }
 
             $lower_class_name = strtolower($class_name);
             try {
                 // the classes need to be required manually, because
                 // the autoload classmap might not include the plugin
                 // classes when an update is triggered (small structure
                 // reload).
                 require_once $path;
 
                 $reflection = ($this->isNamespaced($class_name)) ?
                     new ReflectionClass("\\$class_name") :
                     new ReflectionClass($class_name)
                 ;
 
                 $structure[$lower_class_name][ilCtrlStructureInterface::KEY_CLASS_CID] = $this->cid_generator->getCid();
                 $structure[$lower_class_name][ilCtrlStructureInterface::KEY_CLASS_NAME] = $class_name;
                 $structure[$lower_class_name][ilCtrlStructureInterface::KEY_CLASS_PATH] = $this->getRelativePath($path);
                 $structure[$lower_class_name][ilCtrlStructureInterface::KEY_CLASS_CHILDREN] = $this->getChildren($reflection);
                 $structure[$lower_class_name][ilCtrlStructureInterface::KEY_CLASS_PARENTS] = $this->getParents($reflection);
 
                 // temporarily store base classes in order to filer the
                 // structure afterwards.
                 if (in_array(ilCtrlBaseClassInterface::class, $reflection->getInterfaceNames(), true)) {
                     $base_classes[] = $lower_class_name;
                 }
             } catch (ReflectionException $e) {
                 continue;
             }
         }
 
         $mapped_structure = (new ilCtrlStructureHelper($base_classes, $structure))
             ->mapStructureReferences()
             ->filterUnnecessaryEntries()
             ->getStructure()
         ;
 
         $this->is_executed = true;
 
         return $mapped_structure;
     }

Here is the call graph for this function:

◆ stripWhitespaces()

ilCtrlStructureReader::stripWhitespaces ( string $string )

private

Helper function that replaces all whitespace characters from the given string.

Parameters

string $string

Returns: string

Definition at line 233 of file class.ilCtrlStructureReader.php.

Referenced by getReferencedClassesByReflection().

                                                      : string
     {
         return (string) preg_replace('/\s+/', '', $string);
     }

Here is the caller graph for this function:

Field Documentation

◆ $cid_generator

ilCtrlStructureCidGenerator ilCtrlStructureReader::$cid_generator

private

Definition at line 42 of file class.ilCtrlStructureReader.php.

Referenced by __construct().

◆ $ilias_path

string ilCtrlStructureReader::$ilias_path

private

Definition at line 63 of file class.ilCtrlStructureReader.php.

◆ $is_executed

bool ilCtrlStructureReader::$is_executed = false

private

Definition at line 56 of file class.ilCtrlStructureReader.php.

Referenced by isExecuted().

◆ $iterator

ilCtrlIteratorInterface ilCtrlStructureReader::$iterator

private

Definition at line 49 of file class.ilCtrlStructureReader.php.

Referenced by __construct().

◆ REGEX_GUI_CLASS_NAME

const ilCtrlStructureReader::REGEX_GUI_CLASS_NAME = '/^class\.([A-z0-9]*(GUI))\.php$/'

Definition at line 22 of file class.ilCtrlStructureReader.php.

◆ REGEX_PHPDOC_CALLED_BYS

const ilCtrlStructureReader::REGEX_PHPDOC_CALLED_BYS = '/(((?i)@ilctrl_iscalledby)\s*({CLASS_NAME}(:\s*|\s*:\s*))\K)([A-z0-9,\s])*/'

private

Definition at line 35 of file class.ilCtrlStructureReader.php.

◆ REGEX_PHPDOC_CALLS

const ilCtrlStructureReader::REGEX_PHPDOC_CALLS = '/(((?i)@ilctrl_calls)\s*({CLASS_NAME}(:\s*|\s*:\s*))\K)([A-z0-9,\s])*/'

private

Definition at line 29 of file class.ilCtrlStructureReader.php.

The documentation for this class was generated from the following file:

Services/UICore/classes/Structure/class.ilCtrlStructureReader.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getChildren()

◆ getParents()

◆ getReferencedClassesByReflection()

◆ getRelativePath()

◆ isExecuted()

◆ isGuiClass()

◆ isNamespaced()

◆ readStructure()

◆ stripWhitespaces()

Field Documentation

◆ $cid_generator

◆ $ilias_path

◆ $is_executed

◆ $iterator

◆ REGEX_GUI_CLASS_NAME

◆ REGEX_PHPDOC_CALLED_BYS

◆ REGEX_PHPDOC_CALLS