ilCtrlStructure Class Reference

The CtrlStructure knows how GUIs call each other and where the code of the guis is located. More...

Collaboration diagram for ilCtrlStructure:

Public Member Functions
	__construct (array $class_scripts=[], array $class_children=[])
	withClassScript (string $class, string $file_path)
	withClassChild (string $parent, string $child)
	getClassScripts ()
	getClassChildren ()
	getClassScriptOf (string $class)

Protected Member Functions
	addClassScript (string $class, string $file_path)
	addClassChild (string $parent, string $child)

Protected Attributes
	$class_scripts
	$class_children

Detailed Description

The CtrlStructure knows how GUIs call each other and where the code of the guis is located.

Definition at line 8 of file class.ilCtrlStructure.php.

Constructor & Destructor Documentation

__construct()

ilCtrlStructure::__construct	(	array	$class_scripts = [],
		array	$class_children = []
	)

Definition at line 20 of file class.ilCtrlStructure.php.

References $class_children, $class_scripts, addClassChild(), and addClassScript().

    {
        $this->class_scripts = [];
        $this->class_children = [];
        foreach ($class_scripts as $k => $v) {
            $this->addClassScript($k, $v);
        }
        foreach ($class_children as $k => $vs) {
            foreach ($vs as $v) {
                $this->addClassChild($k, $v);
            }
        }
    }

Here is the call graph for this function:

Member Function Documentation

addClassChild()

ilCtrlStructure::addClassChild ( string  $parent, string  $child  )

protected

Definition at line 90 of file class.ilCtrlStructure.php.

Referenced by __construct(), and withClassChild().

                                                                    : void
    {
        if ($parent == "") {
            throw new \InvalidArgumentException(
                "Can't add class child for an empty parent."
            );
        }

        if (!isset($this->class_children[$parent])) {
            $this->class_children[$parent] = [];
        }

        if (!in_array($child, $this->class_children[$parent])) {
            $this->class_children[$parent][] = $child;
        }
    }

Here is the caller graph for this function:

addClassScript()

ilCtrlStructure::addClassScript ( string  $class, string  $file_path  )

protected

Definition at line 70 of file class.ilCtrlStructure.php.

References Vendor\Package\$e.

Referenced by __construct(), and withClassScript().

                                                                        : void
    {
        if ($class == "") {
            throw new \InvalidArgumentException(
                "Can't add class script for an empty class."
            );
        }

        if (isset($this->class_scripts[$class]) && $this->class_scripts[$class] != $file_path) {
            $e = new \RuntimeException(
                "Can't add script '$file_path' for class '$class', a script for that class already exists."
            );
            $e->file_path = $file_path;
            $e->class = $class;
            throw $e;
        }

        $this->class_scripts[$class] = $file_path;
    }

Here is the caller graph for this function:

getClassChildren()

ilCtrlStructure::getClassChildren

(

)

Definition at line 55 of file class.ilCtrlStructure.php.

Referenced by ilCtrlStructureReader\storeToDB().

                                       : \Generator
    {
        foreach ($this->class_children as $k => $v) {
            yield $k => $v;
        }
    }

Here is the caller graph for this function:

getClassScriptOf()

ilCtrlStructure::getClassScriptOf

(

string

$class

)

Definition at line 62 of file class.ilCtrlStructure.php.

Referenced by ilCtrlStructureReader\readDirTo().

                                                    : ?string
    {
        if (!isset($this->class_scripts[$class])) {
            return null;
        }
        return $this->class_scripts[$class];
    }

Here is the caller graph for this function:

getClassScripts()

ilCtrlStructure::getClassScripts

(

)

Definition at line 48 of file class.ilCtrlStructure.php.

Referenced by ilCtrlStructureReader\storeToDB().

                                      : \Generator
    {
        foreach ($this->class_scripts as $k => $v) {
            yield $k => $v;
        }
    }

Here is the caller graph for this function:

withClassChild()

ilCtrlStructure::withClassChild	(	string	$parent,
		string	$child
	)

Definition at line 41 of file class.ilCtrlStructure.php.

References addClassChild().

Referenced by ilCtrlStructureReader\parseFileTo().

                                                                  : \ilCtrlStructure
    {
        $clone = clone $this;
        $clone->addClassChild($parent, $child);
        return $clone;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withClassScript()

ilCtrlStructure::withClassScript	(	string	$class,
		string	$file_path
	)

Definition at line 34 of file class.ilCtrlStructure.php.

References addClassScript().

Referenced by ilCtrlStructureReader\parseFileTo().

                                                                      : \ilCtrlStructure
    {
        $clone = clone $this;
        $clone->addClassScript($class, $file_path);
        return $clone;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$class_children

ilCtrlStructure::$class_children

protected

Definition at line 18 of file class.ilCtrlStructure.php.

Referenced by __construct().

$class_scripts

ilCtrlStructure::$class_scripts

protected

Definition at line 13 of file class.ilCtrlStructure.php.

Referenced by __construct().

---

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

• Services/UICore/classes/class.ilCtrlStructure.php