ilTreeAdminNodeAddedObjective Class Reference

Inheritance diagram for ilTreeAdminNodeAddedObjective:

Collaboration diagram for ilTreeAdminNodeAddedObjective:

Public Member Functions
	__construct (string $type, string $title, string $parent_type="")
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	isApplicable (Environment $environment)

Protected Attributes
const	RBAC_OP_EDIT_PERMISSIONS = 1
const	RBAC_OP_VISIBLE = 2
const	RBAC_OP_READ = 3
const	RBAC_OP_WRITE = 4
array	$rbac_ops
string	$type
string	$title
string	$parent_type

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilTreeAdminNodeAddedObjective::__construct	(	string	$type,
		string	$title,
		string	$parent_type = ""
	)

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

    {
        $this->type = $type;
        $this->title = $title;
        $this->parent_type = $parent_type;
    }

References $parent_type, $title, and $type.

Member Function Documentation

achieve()

ilTreeAdminNodeAddedObjective::achieve

(

Environment

$environment

)

Definition at line 72 of file class.ilTreeAdminNodeAddedObjective.php.

                                                     : Environment
    {
        $client_ini = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_INI);
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
 
        // ATTENTION: This is a total abomination. It only exists to allow various
        // sub components of the various readers to run. This is a memento to the
        // fact, that dependency injection is something we want. Currently, every
        // component could just service locate the whole world via the global $DIC.
        $PREVIOUS_DIC = $GLOBALS["DIC"] ?? null;
        $GLOBALS["DIC"] = new Container();
        $GLOBALS["DIC"]["ilDB"] = $db;
 
        try {
            if (!defined("ROOT_FOLDER_ID")) {
                define("ROOT_FOLDER_ID", (int) $client_ini->readVariable("system", "ROOT_FOLDER_ID"));
            }
            if (!defined("SYSTEM_FOLDER_ID")) {
                define("SYSTEM_FOLDER_ID", $client_ini->readVariable("system", "SYSTEM_FOLDER_ID"));
            }
            if (!defined("ILIAS_LOG_ENABLED")) {
                define("ILIAS_LOG_ENABLED", false);
            }
 
            $obj_type_id = $db->nextId("object_data");
            $values = [
                'obj_id' => ['integer', $obj_type_id],
                'type' => ['text', 'typ'],
                'title' => ['text', $this->type],
                'description' => ['text', $this->title],
                'owner' => ['integer', -1],
                'create_date' => ['timestamp', date("Y-m-d H:i:s")],
                'last_update' => ['timestamp', date("Y-m-d H:i:s")]
            ];
            $db->insert("object_data", $values);
 
            $obj_id = $db->nextId("object_data");
            $values = [
                'obj_id' => ['integer', $obj_id],
                'type' => ['text', $this->type],
                'title' => ['text', $this->title],
                'description' => ['text', $this->title],
                'owner' => ['integer', -1],
                'create_date' => ['timestamp', date("Y-m-d H:i:s")],
                'last_update' => ['timestamp', date("Y-m-d H:i:s")]
            ];
            $db->insert("object_data", $values);
 
            $ref_id = $db->nextId("object_reference");
            $values = [
                "obj_id" => ["integer", $obj_id],
                "ref_id" => ["integer", $ref_id]
            ];
            $db->insert("object_reference", $values);
 
            $tree = new ilTree(
                ROOT_FOLDER_ID,
                0,
                $db
            );
            if ($this->parent_type) {
                $set = $db->queryF(
                    "SELECT * FROM object_data " .
                    " WHERE type = %s ",
                    ["text"],
                    [$this->parent_type]
                );
                $rec = $db->fetchAssoc($set);
 
                $set = $db->queryF(
                    "SELECT * FROM object_reference " .
                    " WHERE obj_id = %s ",
                    ["integer"],
                    [$rec["obj_id"]]
                );
                $rec = $db->fetchAssoc($set);
                $parent_type_ref_id = $rec["ref_id"];
 
                $tree->insertNode((int) $ref_id, (int) $parent_type_ref_id);
            } else {
                $tree->insertNode((int) $ref_id, (int) SYSTEM_FOLDER_ID);
            }
 
            foreach ($this->rbac_ops as $ops_id) {
                if (ilRbacReview::_isRBACOperation($obj_type_id, $ops_id, $db)) {
                    continue;
                }
                $values = [
                    "typ_id" => ["integer", $obj_type_id],
                    "ops_id" => ["integer", $ops_id]
                ];
                $db->insert("rbac_ta", $values);
            }
        } finally {
            // reset the abomination again so we don't make objectives flaky.
            $GLOBALS["DIC"] = $PREVIOUS_DIC;
        }
 
        return $environment;
    }

References $GLOBALS, $ref_id, $title, $type, ilRbacReview\_isRBACOperation(), ILIAS\Setup\Environment\getResource(), ROOT_FOLDER_ID, and SYSTEM_FOLDER_ID.

Here is the call graph for this function:

getHash()

ilTreeAdminNodeAddedObjective::getHash

(

)

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

                             : string
    {
        return hash("sha256", self::class . "::" . $this->type);
    }

getLabel()

ilTreeAdminNodeAddedObjective::getLabel

(

)

Definition at line 54 of file class.ilTreeAdminNodeAddedObjective.php.

                              : string
    {
        return "Add new admin node to tree (type=$this->type;title=$this->title)";
    }

getPreconditions()

ilTreeAdminNodeAddedObjective::getPreconditions

(

Environment

$environment

)

Definition at line 64 of file class.ilTreeAdminNodeAddedObjective.php.

                                                              : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new ilDatabaseInitializedObjective()
        ];
    }

isApplicable()

ilTreeAdminNodeAddedObjective::isApplicable

(

Environment

$environment

)

Definition at line 173 of file class.ilTreeAdminNodeAddedObjective.php.

                                                          : bool
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
        return !((bool) ilObject::_getObjectTypeIdByTitle($this->type, $db));
    }

References ilObject\_getObjectTypeIdByTitle(), and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

isNotable()

ilTreeAdminNodeAddedObjective::isNotable

(

)

Definition at line 59 of file class.ilTreeAdminNodeAddedObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$parent_type

string ilTreeAdminNodeAddedObjective::$parent_type

protected

Definition at line 40 of file class.ilTreeAdminNodeAddedObjective.php.

Referenced by __construct().

$rbac_ops

array ilTreeAdminNodeAddedObjective::$rbac_ops

protected

Initial value:

= [
        self::RBAC_OP_EDIT_PERMISSIONS,
        self::RBAC_OP_READ,
        self::RBAC_OP_WRITE
    ]

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

$title

string ilTreeAdminNodeAddedObjective::$title

protected

Definition at line 39 of file class.ilTreeAdminNodeAddedObjective.php.

Referenced by __construct(), and achieve().

$type

string ilTreeAdminNodeAddedObjective::$type

protected

Definition at line 38 of file class.ilTreeAdminNodeAddedObjective.php.

Referenced by __construct(), and achieve().

RBAC_OP_EDIT_PERMISSIONS

const ilTreeAdminNodeAddedObjective::RBAC_OP_EDIT_PERMISSIONS = 1

protected

Definition at line 27 of file class.ilTreeAdminNodeAddedObjective.php.

RBAC_OP_READ

const ilTreeAdminNodeAddedObjective::RBAC_OP_READ = 3

protected

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

RBAC_OP_VISIBLE

const ilTreeAdminNodeAddedObjective::RBAC_OP_VISIBLE = 2

protected

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

RBAC_OP_WRITE

const ilTreeAdminNodeAddedObjective::RBAC_OP_WRITE = 4

protected

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

---

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

• components/ILIAS/Tree/classes/Setup/class.ilTreeAdminNodeAddedObjective.php