ilCtrlStructureMapper Class Reference

Class ilCtrlStructureMapper. More...

Collaboration diagram for ilCtrlStructureMapper:

Public Member Functions
	__construct (array $ctrl_structure)
	ilCtrlStructureMapper Constructor More...
	getStructure ()
	Returns the current structure with mapped vise-versa references of each parent-child relation. More...

Private Member Functions
	addViseVersaMappingByClass (string $class_name, string $key_ref_from, string $key_ref_to)
	If a class has referenced another one as child or parent, this method adds a vise-versa mapping if it doesn't already exist. More...
	mapStructure ()
	Maps the current structures references. More...
	removeReference (array &$reference_list, $index)
	Removes an entry within the given reference list for the given index and re-indexes the reference list afterwards. More...
	isStructureEntryValid ($index)
	Helper function that returns whether an entry in the current structure is valid or not. More...

Private Attributes
array	$ctrl_structure

Detailed Description

Class ilCtrlStructureMapper.

Author

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

Definition at line 12 of file class.ilCtrlStructureMapper.php.

Constructor & Destructor Documentation

__construct()

ilCtrlStructureMapper::__construct

(

array

$ctrl_structure

)

ilCtrlStructureMapper Constructor

Parameters

array<string,mixed>

$ctrl_structure

Definition at line 24 of file class.ilCtrlStructureMapper.php.

References $ctrl_structure, and mapStructure().

    {
        $this->ctrl_structure = $ctrl_structure;
        $this->mapStructure();
    }

Here is the call graph for this function:

Member Function Documentation

addViseVersaMappingByClass()

ilCtrlStructureMapper::addViseVersaMappingByClass ( string  $class_name, string  $key_ref_from, string  $key_ref_to  )

private

If a class has referenced another one as child or parent, this method adds a vise-versa mapping if it doesn't already exist.

Parameters

string	$class_name
string	$key_ref_from
string	$key_ref_to

Definition at line 50 of file class.ilCtrlStructureMapper.php.

References $index, isStructureEntryValid(), and removeReference().

Referenced by mapStructure().

                                                                                                             : void
    {
        if (!empty($this->ctrl_structure[$class_name][$key_ref_from])) {
            foreach ($this->ctrl_structure[$class_name][$key_ref_from] as $index => $reference) {
                $is_reference_available = isset($this->ctrl_structure[$reference]);
                $is_reference_valid = $this->isStructureEntryValid($reference);

                // the vise-versa mapping must only be processed if the
                // reference is available and a valid structure entry.
                if ($is_reference_available && $is_reference_valid) {
                    // create reference list if not yet initialized.
                    if (!isset($this->ctrl_structure[$reference][$key_ref_to])) {
                        $this->ctrl_structure[$reference][$key_ref_to] = [];
                    }

                    // only add vise-versa mapping if it doesn't already exist.
                    if (!in_array($class_name, $this->ctrl_structure[$reference][$key_ref_to], true)) {
                        $this->ctrl_structure[$reference][$key_ref_to][] = $class_name;
                    }
                }

                // if the referenced class does not exist within the current
                // structure, the reference is removed from the reference list.
                if (!$is_reference_available || !$is_reference_valid) {
                    $this->removeReference($this->ctrl_structure[$class_name][$key_ref_from], $index);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStructure()

ilCtrlStructureMapper::getStructure

(

)

Returns the current structure with mapped vise-versa references of each parent-child relation.

Returns

array<string, mixed>

Definition at line 36 of file class.ilCtrlStructureMapper.php.

References $ctrl_structure.

                                  : array
    {
        return $this->ctrl_structure;
    }

isStructureEntryValid()

ilCtrlStructureMapper::isStructureEntryValid (   $index )

private

Helper function that returns whether an entry in the current structure is valid or not.

Parameters

string | int

$index

Returns

bool

Definition at line 130 of file class.ilCtrlStructureMapper.php.

References $index.

Referenced by addViseVersaMappingByClass(), and mapStructure().

                                                  : bool
    {
        // structure entry is not a classname.
        if (!is_string($index)) {
            return false;
        }

        // index is not contained in the structure.
        if (!isset($this->ctrl_structure[$index])) {
            return false;
        }

        // structure value is not an array
        if (!is_array($this->ctrl_structure[$index])) {
            return false;
        }

        return true;
    }

Here is the caller graph for this function:

mapStructure()

ilCtrlStructureMapper::mapStructure ( )

private

Maps the current structures references.

Definition at line 83 of file class.ilCtrlStructureMapper.php.

References $data, addViseVersaMappingByClass(), isStructureEntryValid(), ilCtrlStructureInterface\KEY_CLASS_CHILDREN, and ilCtrlStructureInterface\KEY_CLASS_PARENTS.

Referenced by __construct().

                                   : void
    {
        if (!empty($this->ctrl_structure)) {
            foreach ($this->ctrl_structure as $class_name => $data) {
                if ($this->isStructureEntryValid($class_name)) {
                    $this->addViseVersaMappingByClass(
                        $class_name,
                        ilCtrlStructureInterface::KEY_CLASS_CHILDREN,
                        ilCtrlStructureInterface::KEY_CLASS_PARENTS,
                    );

                    $this->addViseVersaMappingByClass(
                        $class_name,
                        ilCtrlStructureInterface::KEY_CLASS_PARENTS,
                        ilCtrlStructureInterface::KEY_CLASS_CHILDREN,
                    );
                } else {
                    // remove/unset invalid structure entries.
                    unset($this->ctrl_structure[$class_name]);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeReference()

ilCtrlStructureMapper::removeReference ( array &  $reference_list,   $index  )

private

Removes an entry within the given reference list for the given index and re-indexes the reference list afterwards.

Parameters

array	$reference_list
string | int	$index

Definition at line 114 of file class.ilCtrlStructureMapper.php.

References $index.

Referenced by addViseVersaMappingByClass().

                                                                    : void
    {
        // remove the reference of the current index.
        unset($reference_list[$index]);

        // re-index the reference list.
        $reference_list = array_values($reference_list);
    }

Here is the caller graph for this function:

Field Documentation

$ctrl_structure

array ilCtrlStructureMapper::$ctrl_structure

private

Definition at line 17 of file class.ilCtrlStructureMapper.php.

Referenced by __construct(), and getStructure().

---

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

• Services/UICore/classes/Structure/class.ilCtrlStructureMapper.php