ilContainerStartObjects Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilContainerStartObjects:

Public Member Functions
	__construct (int $a_object_ref_id, int $a_object_id)
	getObjId ()
	getRefId ()
	getStartObjects ()
	delete (int $a_crs_start_id)
	deleteItem (int $a_item_ref_id)
	exists (int $a_item_ref_id)
	add (int $a_item_ref_id)
	setObjectPos (int $a_start_id, int $a_pos)
	getPossibleStarters ()
	allFullfilled (int $a_user_id)
	isFullfilled (int $a_user_id, int $a_item_id)
	cloneDependencies (int $a_target_id, int $a_copy_id)

Static Public Member Functions
static	isStartObject (int $a_container_id, int $a_item_ref_id)

Protected Member Functions
	setObjId (int $a_id)
	setRefId (int $a_ref_id)
	read ()

Protected Attributes
ilTree	$tree
ilDBInterface	$db
ilObjectDataCache	$obj_data_cache
ilLogger	$log
int	$ref_id
int	$obj_id
array	$start_objs = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning ilContainerStartObjects

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilContainerStartObjects::__construct	(	int	$a_object_ref_id,
		int	$a_object_id
	)

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

References $DIC, read(), setObjId(), and setRefId().

      {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->db = $DIC->database();
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $this->log = $DIC["ilLog"];
        $this->setRefId($a_object_ref_id);
        $this->setObjId($a_object_id);

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilContainerStartObjects::add

(

int

$a_item_ref_id

)

Definition at line 127 of file class.ilContainerStartObjects.php.

References $db, $ilDB, $query, getObjId(), and ILIAS\Repository\int().

Referenced by ilLOSettings\updateStartObjects().

                                           : bool
    {
        $ilDB = $this->db;

        if ($a_item_ref_id) {
            $max_pos = $ilDB->query("SELECT max(pos) pos FROM crs_start" .
                " WHERE crs_id = " . $ilDB->quote($this->getObjId(), "integer"));
            $max_pos = $ilDB->fetchAssoc($max_pos);
            $max_pos = ((int) $max_pos["pos"]) + 10;

            $next_id = $ilDB->nextId('crs_start');
            $query = "INSERT INTO crs_start" .
                " (crs_start_id,crs_id,item_ref_id,pos)" .
                " VALUES" .
                " (" . $ilDB->quote($next_id, 'integer') .
                ", " . $ilDB->quote($this->getObjId(), 'integer') .
                ", " . $ilDB->quote($a_item_ref_id, 'integer') .
                ", " . $ilDB->quote($max_pos, 'integer') .
                ")";
            $ilDB->manipulate($query);
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

allFullfilled()

ilContainerStartObjects::allFullfilled

(

int

$a_user_id

)

Definition at line 185 of file class.ilContainerStartObjects.php.

References getStartObjects(), and isFullfilled().

                                                 : bool
    {
        foreach ($this->getStartObjects() as $item) {
            if (!$this->isFullfilled($a_user_id, $item['item_ref_id'])) {
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

cloneDependencies()

ilContainerStartObjects::cloneDependencies	(	int	$a_target_id,
		int	$a_copy_id
	)

Definition at line 235 of file class.ilContainerStartObjects.php.

References $data, $log, $obj_data_cache, ilCopyWizardOptions\_getInstance(), getStartObjects(), and ilLogger\write().

     : void {
        $ilObjDataCache = $this->obj_data_cache;
        $ilLog = $this->log;

        $ilLog->write(__METHOD__ . ': Begin course start objects...');

        $new_obj_id = $ilObjDataCache->lookupObjId($a_target_id);
        $start = new self($a_target_id, $new_obj_id);

        $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
        $mappings = $cwo->getMappings();
        foreach ($this->getStartObjects() as $data) {
            $item_ref_id = $data['item_ref_id'];
            if (isset($mappings[$item_ref_id]) && $mappings[$item_ref_id]) {
                $ilLog->write(__METHOD__ . ': Clone start object nr. ' . $item_ref_id);
                $start->add($mappings[$item_ref_id]);
            } else {
                $ilLog->write(__METHOD__ . ': No mapping found for start object nr. ' . $item_ref_id);
            }
        }
        $ilLog->write(__METHOD__ . ': ... end course start objects');
    }

Here is the call graph for this function:

delete()

ilContainerStartObjects::delete

(

int

$a_crs_start_id

)

Definition at line 95 of file class.ilContainerStartObjects.php.

References $db, $ilDB, $query, and getObjId().

                                               : void
    {
        $ilDB = $this->db;

        $query = "DELETE FROM crs_start" .
            " WHERE crs_start_id = " . $ilDB->quote($a_crs_start_id, 'integer') .
            " AND crs_id = " . $ilDB->quote($this->getObjId(), 'integer');
        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

deleteItem()

ilContainerStartObjects::deleteItem

(

int

$a_item_ref_id

)

Definition at line 105 of file class.ilContainerStartObjects.php.

References $db, $ilDB, $query, and getObjId().

Referenced by ilLOSettings\updateStartObjects().

                                                  : void
    {
        $ilDB = $this->db;

        $query = "DELETE FROM crs_start" .
            " WHERE crs_id = " . $ilDB->quote($this->getObjId(), 'integer') .
            " AND item_ref_id = " . $ilDB->quote($a_item_ref_id, 'integer');
        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exists()

ilContainerStartObjects::exists

(

int

$a_item_ref_id

)

Definition at line 115 of file class.ilContainerStartObjects.php.

References $db, $ilDB, $query, $res, and getObjId().

Referenced by ilLOSettings\updateStartObjects().

                                              : bool
    {
        $ilDB = $this->db;

        $query = "SELECT * FROM crs_start" .
            " WHERE crs_id = " . $ilDB->quote($this->getObjId(), 'integer') .
            " AND item_ref_id = " . $ilDB->quote($a_item_ref_id, 'integer');
        $res = $ilDB->query($query);

        return (bool) $res->numRows();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjId()

ilContainerStartObjects::getObjId

(

)

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

References $obj_id.

Referenced by add(), delete(), deleteItem(), exists(), read(), and setObjectPos().

                              : int
    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getPossibleStarters()

ilContainerStartObjects::getPossibleStarters

(

)

Definition at line 168 of file class.ilContainerStartObjects.php.

References ilObjectActivation\getItems(), and getRefId().

                                         : array
    {
        $poss_items = [];
        foreach (ilObjectActivation::getItems($this->getRefId(), false) as $node) {
            switch ($node['type']) {
                case 'lm':
                case 'sahs':
                case 'svy':
                case 'copa':
                case 'tst':
                    $poss_items[] = $node['ref_id'];
                    break;
            }
        }
        return $poss_items;
    }

Here is the call graph for this function:

getRefId()

ilContainerStartObjects::getRefId

(

)

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

References $ref_id.

Referenced by getPossibleStarters(), and isFullfilled().

                              : int
    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

getStartObjects()

ilContainerStartObjects::getStartObjects

(

)

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

Referenced by allFullfilled(), and cloneDependencies().

                                     : array
    {
        return $this->start_objs ?: [];
    }

Here is the caller graph for this function:

isFullfilled()

ilContainerStartObjects::isFullfilled	(	int	$a_user_id,
		int	$a_item_id
	)

Definition at line 195 of file class.ilContainerStartObjects.php.

References $obj_data_cache, $type, ilLPStatus\_hasUserCompleted(), ilObjSurveyAccess\_lookupFinished(), ilObjTestAccess\checkCondition(), getRefId(), and ilObjectDataCache\lookupObjId().

Referenced by allFullfilled().

                                                                : bool
    {
        $ilObjDataCache = $this->obj_data_cache;

        $obj_id = $ilObjDataCache->lookupObjId($a_item_id);
        $type = $ilObjDataCache->lookupType($obj_id);

        switch ($type) {
            case 'tst':
                if (!ilObjTestAccess::checkCondition($obj_id, 'finished', '', $a_user_id)) { // #14000
                    return false;
                }
                break;

            case 'svy':

                if (!ilObjSurveyAccess::_lookupFinished($obj_id, $a_user_id)) {
                    return false;
                }
                break;

            case 'copa':
            case 'sahs':
                if (!ilLPStatus::_hasUserCompleted($obj_id, $a_user_id)) {
                    return false;
                }
                break;

            default:
                $lm_continue = new ilCourseLMHistory($this->getRefId(), $a_user_id);
                $continue_data = $lm_continue->getLMHistory();
                if (!isset($continue_data[$a_item_id])) {
                    return false;
                }
                break;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isStartObject()

static ilContainerStartObjects::isStartObject ( int  $a_container_id, int  $a_item_ref_id  )

static

Definition at line 261 of file class.ilContainerStartObjects.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilLOTestQuestionAdapter\isQualifiedStartRun().

     : bool {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT crs_start_id FROM crs_start ' .
            'WHERE crs_id = ' . $ilDB->quote($a_container_id, 'integer') . ' ' .
            'AND item_ref_id = ' . $ilDB->quote($a_item_ref_id, 'integer');
        $res = $ilDB->query($query);

        return $res->numRows() >= 1;
    }

Here is the caller graph for this function:

read()

ilContainerStartObjects::read ( )

protected

Definition at line 75 of file class.ilContainerStartObjects.php.

References $db, $ilDB, $query, $res, $tree, ilDBConstants\FETCHMODE_OBJECT, getObjId(), ILIAS\Repository\int(), and ilTree\isInTree().

Referenced by __construct().

                             : void
    {
        $tree = $this->tree;
        $ilDB = $this->db;

        $this->start_objs = [];

        $query = "SELECT * FROM crs_start" .
            " WHERE crs_id = " . $ilDB->quote($this->getObjId(), 'integer') .
            " ORDER BY pos, crs_start_id";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($tree->isInTree($row->item_ref_id)) {
                $this->start_objs[$row->crs_start_id]['item_ref_id'] = (int) $row->item_ref_id;
            } else {
                $this->delete((int) $row->item_ref_id);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setObjectPos()

ilContainerStartObjects::setObjectPos	(	int	$a_start_id,
		int	$a_pos
	)

Definition at line 152 of file class.ilContainerStartObjects.php.

References $db, $ilDB, and getObjId().

     : void {
        $ilDB = $this->db;

        if (!$a_start_id || !$a_pos) {
            return;
        }

        $ilDB->manipulate("UPDATE crs_start" .
            " SET pos = " . $ilDB->quote($a_pos, "integer") .
            " WHERE crs_id = " . $ilDB->quote($this->getObjId(), 'integer') .
            " AND crs_start_id = " . $ilDB->quote($a_start_id, 'integer'));
    }

Here is the call graph for this function:

setObjId()

ilContainerStartObjects::setObjId ( int  $a_id )

protected

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

Referenced by __construct().

                                          : void
    {
        $this->obj_id = $a_id;
    }

Here is the caller graph for this function:

setRefId()

ilContainerStartObjects::setRefId ( int  $a_ref_id )

protected

Definition at line 60 of file class.ilContainerStartObjects.php.

Referenced by __construct().

                                              : void
    {
        $this->ref_id = $a_ref_id;
    }

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilContainerStartObjects::$db

protected

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

Referenced by add(), delete(), deleteItem(), exists(), read(), and setObjectPos().

$log

ilLogger ilContainerStartObjects::$log

protected

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

Referenced by cloneDependencies().

$obj_data_cache

ilObjectDataCache ilContainerStartObjects::$obj_data_cache

protected

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

Referenced by cloneDependencies(), and isFullfilled().

$obj_id

int ilContainerStartObjects::$obj_id

protected

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

Referenced by getObjId().

$ref_id

int ilContainerStartObjects::$ref_id

protected

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

Referenced by getRefId().

$start_objs

array ilContainerStartObjects::$start_objs = []

protected

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

$tree

ilTree ilContainerStartObjects::$tree

protected

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

Referenced by read().

---

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

• Services/Container/StartObjects/class.ilContainerStartObjects.php