Collaboration diagram for ilCtrlStructureHelper:

Public Member Functions
	__construct (array $base_classes, array $ctrl_structure)
	ilCtrlStructureHelper Constructor More...

	mapStructureReferences ()
	Fluent mapper method that adds vise-versa references for each entry in the current ctrl structure - e.g. More...

	filterUnnecessaryEntries ()
	Fluent filter method that removes structure entries, whose parent- and child-references are empty. More...

	getStructure ()
	Returns the current ctrl structure. More...

Protected Attributes
array	$ctrl_structure

array	$base_classes

Detailed Description

Class ilCtrlStructureHelper.

Author: Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 25 of file class.ilCtrlStructureHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ilCtrlStructureHelper::__construct	(	array	$base_classes,
		array	$ctrl_structure
	)

ilCtrlStructureHelper Constructor

Parameters

array	$base_classes
array	$ctrl_structure

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

References $base_classes, and $ctrl_structure.

     {
         $this->ctrl_structure = $ctrl_structure;
         $this->base_classes = $base_classes;
     }

Member Function Documentation

◆ filterUnnecessaryEntries()

ilCtrlStructureHelper::filterUnnecessaryEntries ( )

Fluent filter method that removes structure entries, whose parent- and child-references are empty.

That means these classes are not considered necessary GUI classes. Such structure entries can be safely removed, because if they have neither children nor parents, they will never be called unless they are a baseclass itself.

Returns: self

Definition at line 76 of file class.ilCtrlStructureHelper.php.

References ilCtrlStructureInterface\KEY_CLASS_CHILDREN, and ilCtrlStructureInterface\KEY_CLASS_PARENTS.

                                               : self
     {
         $this->ctrl_structure = array_filter(
             $this->ctrl_structure,
             function (array $value, string $key): bool {
                 // if the entry is not a baseclass and has no
                 // references, the entry will be removed.
                 return !(
                     !in_array($key, $this->base_classes, true) &&
                     empty($value[ilCtrlStructureInterface::KEY_CLASS_CHILDREN]) &&
                     empty($value[ilCtrlStructureInterface::KEY_CLASS_PARENTS])
                 );
             },
             ARRAY_FILTER_USE_BOTH
         );
 
         return $this;
     }

◆ getStructure()

ilCtrlStructureHelper::getStructure ( )

Returns the current ctrl structure.

Returns: array<string, mixed>

Definition at line 99 of file class.ilCtrlStructureHelper.php.

References $ctrl_structure.

Referenced by mapStructureReferences().

                                   : array
     {
         return $this->ctrl_structure;
     }

Here is the caller graph for this function:

◆ mapStructureReferences()

ilCtrlStructureHelper::mapStructureReferences ( )

Fluent mapper method that adds vise-versa references for each entry in the current ctrl structure - e.g.

if a class has several parent classes, this class is added as a child class to each parent, and vise-versa. This method doesn't necessarily need to be called, as it's performance heavy, but for example when reading the ctrl structure the mappings are wished to be complete.

Returns: self

Definition at line 58 of file class.ilCtrlStructureHelper.php.

References getStructure().

                                             : self
     {
         $this->ctrl_structure = (new ilCtrlStructureMapper(
             $this->ctrl_structure
         ))->getStructure();
 
         return $this;
     }

Here is the call graph for this function:

Field Documentation

◆ $base_classes

array ilCtrlStructureHelper::$base_classes

protected

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

Referenced by __construct().

◆ $ctrl_structure

array ilCtrlStructureHelper::$ctrl_structure

protected

Definition at line 30 of file class.ilCtrlStructureHelper.php.

Referenced by __construct(), and getStructure().

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

components/ILIAS/UICore/classes/Structure/class.ilCtrlStructureHelper.php

Public Member Functions

Protected Attributes