ILIAS\COPage\PC\PCDefinition Class Reference

Inheritance diagram for ILIAS\COPage\PC\PCDefinition:

Collaboration diagram for ILIAS\COPage\PC\PCDefinition:

Public Member Functions
	__construct ()
	getRecords ()
	getPCDefinitions ()
	getPCDefinitionByType (string $a_pc_type)
	Get PC definition by type. More...
	getPCDefinitionByName (string $a_pc_name)
	Get PC definition by name. More...
	getPCDefinitionByGUIClassName (string $a_gui_class_name)
	Get PC definition by name. More...
	isPCGUIClassName (string $a_class_name, bool $a_lower_case=false)
	getPCEditorInstanceByName (string $a_name)
	Get instance. More...
	getPCModelProviderByName (string $a_name)

Protected Member Functions
	init ()

Protected Attributes
ilDBInterface	$db
array	$pc_def = []
array	$pc_def_by_name = []
array	$pc_gui_classes = array()
array	$pc_gui_classes_lc = array()
array	$pc_def_by_gui_class_cl = array()

Detailed Description

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 26 of file class.PCDefinition.php.

Constructor & Destructor Documentation

__construct()

ILIAS\COPage\PC\PCDefinition::__construct

(

)

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

References $DIC.

    {
        global $DIC;

        $this->db = $DIC->database();
    }

Member Function Documentation

getPCDefinitionByGUIClassName()

ILIAS\COPage\PC\PCDefinition::getPCDefinitionByGUIClassName

(

string

$a_gui_class_name

)

Get PC definition by name.

Definition at line 93 of file class.PCDefinition.php.

References ILIAS\COPage\PC\PCDefinition\init().

     : array {
        $this->init();
        $a_gui_class_name = strtolower($a_gui_class_name);
        return $this->pc_def_by_gui_class_cl[$a_gui_class_name];
    }

Here is the call graph for this function:

getPCDefinitionByName()

ILIAS\COPage\PC\PCDefinition::getPCDefinitionByName

(

string

$a_pc_name

)

Get PC definition by name.

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

References ILIAS\COPage\PC\PCDefinition\init().

Referenced by ILIAS\COPage\PC\PCDefinition\getPCEditorInstanceByName(), and ILIAS\COPage\PC\PCDefinition\getPCModelProviderByName().

     : array {
        $this->init();
        return $this->pc_def_by_name[$a_pc_name];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPCDefinitionByType()

ILIAS\COPage\PC\PCDefinition::getPCDefinitionByType

(

string

$a_pc_type

)

Get PC definition by type.

Definition at line 74 of file class.PCDefinition.php.

References ILIAS\COPage\PC\PCDefinition\init().

                                                            : ?array
    {
        $this->init();
        return ($this->pc_def[$a_pc_type] ?? null);
    }

Here is the call graph for this function:

getPCDefinitions()

ILIAS\COPage\PC\PCDefinition::getPCDefinitions

(

)

Definition at line 65 of file class.PCDefinition.php.

References ILIAS\COPage\PC\PCDefinition\$pc_def, and ILIAS\COPage\PC\PCDefinition\init().

                                      : array
    {
        $this->init();
        return $this->pc_def;
    }

Here is the call graph for this function:

getPCEditorInstanceByName()

ILIAS\COPage\PC\PCDefinition::getPCEditorInstanceByName

(

string

$a_name

)

Get instance.

Definition at line 116 of file class.PCDefinition.php.

References ILIAS\COPage\PC\PCDefinition\getPCDefinitionByName(), and ILIAS\COPage\PC\PCDefinition\init().

     : ?\ILIAS\COPage\Editor\Components\PageComponentEditor {
        $this->init();
        $pc_def = $this->getPCDefinitionByName($a_name);
        $pc_class = "ilPC" . $pc_def["name"] . "EditorGUI";
        if (class_exists($pc_class)) {
            return new $pc_class();
        }
        return null;
    }

Here is the call graph for this function:

getPCModelProviderByName()

ILIAS\COPage\PC\PCDefinition::getPCModelProviderByName

(

string

$a_name

)

Definition at line 128 of file class.PCDefinition.php.

References ILIAS\COPage\PC\PCDefinition\getPCDefinitionByName(), and ILIAS\COPage\PC\PCDefinition\init().

     : ?\ILIAS\COPage\Editor\Components\PageComponentModelProvider {
        $this->init();
        $pc_def = $this->getPCDefinitionByName($a_name);
        $pc_class = "ilPC" . $pc_def["name"] . "ModelProvider";
        if (class_exists($pc_class)) {
            return new $pc_class();
        }
        return null;
    }

Here is the call graph for this function:

getRecords()

ILIAS\COPage\PC\PCDefinition::getRecords

(

)

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

References ILIAS\COPage\PC\PCDefinition\$db, and ilDBInterface\query().

Referenced by ILIAS\COPage\PC\PCDefinition\init().

                                : array
    {
        $db = $this->db;
        $set = $db->query("SELECT * FROM copg_pc_def ORDER BY order_nr");
        return $db->fetchAll($set);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

init()

ILIAS\COPage\PC\PCDefinition::init ( )

protected

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

References ILIAS\COPage\PC\PCDefinition\$db, and ILIAS\COPage\PC\PCDefinition\getRecords().

Referenced by ILIAS\COPage\PC\PCDefinition\getPCDefinitionByGUIClassName(), ILIAS\COPage\PC\PCDefinition\getPCDefinitionByName(), ILIAS\COPage\PC\PCDefinition\getPCDefinitionByType(), ILIAS\COPage\PC\PCDefinition\getPCDefinitions(), ILIAS\COPage\PC\PCDefinition\getPCEditorInstanceByName(), ILIAS\COPage\PC\PCDefinition\getPCModelProviderByName(), and ILIAS\COPage\PC\PCDefinition\isPCGUIClassName().

                             : void
    {
        $db = $this->db;
        if ($this->pc_def == null) {
            foreach ($this->getRecords() as $rec) {
                $rec["pc_class"] = "ilPC" . $rec["name"];
                $rec["pc_gui_class"] = "ilPC" . $rec["name"] . "GUI";
                $this->pc_gui_classes[] = $rec["pc_gui_class"];
                $this->pc_gui_classes_lc[] = strtolower($rec["pc_gui_class"]);
                $this->pc_def[$rec["pc_type"]] = $rec;
                $this->pc_def_by_name[$rec["name"]] = $rec;
                $this->pc_def_by_gui_class_cl[strtolower($rec["pc_gui_class"])] = $rec;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isPCGUIClassName()

ILIAS\COPage\PC\PCDefinition::isPCGUIClassName	(	string	$a_class_name,
		bool	$a_lower_case = false
	)

Definition at line 101 of file class.PCDefinition.php.

References ILIAS\COPage\PC\PCDefinition\init().

     : bool {
        $this->init();
        if ($a_lower_case) {
            return in_array($a_class_name, $this->pc_gui_classes_lc);
        } else {
            return in_array($a_class_name, $this->pc_gui_classes);
        }
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ILIAS\COPage\PC\PCDefinition::$db

protected

Definition at line 28 of file class.PCDefinition.php.

Referenced by ILIAS\COPage\PC\PCDefinition\getRecords(), and ILIAS\COPage\PC\PCDefinition\init().

$pc_def

array ILIAS\COPage\PC\PCDefinition::$pc_def = []

protected

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

Referenced by ILIAS\COPage\PC\PCDefinition\getPCDefinitions().

$pc_def_by_gui_class_cl

array ILIAS\COPage\PC\PCDefinition::$pc_def_by_gui_class_cl = array()

protected

Definition at line 33 of file class.PCDefinition.php.

$pc_def_by_name

array ILIAS\COPage\PC\PCDefinition::$pc_def_by_name = []

protected

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

$pc_gui_classes

array ILIAS\COPage\PC\PCDefinition::$pc_gui_classes = array()

protected

Definition at line 31 of file class.PCDefinition.php.

$pc_gui_classes_lc

array ILIAS\COPage\PC\PCDefinition::$pc_gui_classes_lc = array()

protected

Definition at line 32 of file class.PCDefinition.php.

---

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

• components/ILIAS/COPage/PC/class.PCDefinition.php