Collaboration diagram for ilContainerStartObjects:

Public Member Functions
	__construct ($a_object_ref_id, $a_object_id)

	getObjId ()

	getRefId ()

	getStartObjects ()

	delete ($a_crs_start_id)
	Delete item by sequence id @global type $ilDB. More...

	deleteItem ($a_item_ref_id)
	Delete item by ref_id. More...

	exists ($a_item_ref_id)

	add ($a_item_ref_id)

	__deleteAll ()

	setObjectPos ($a_start_id, $a_pos)

	getPossibleStarters ()

	allFullfilled ($a_user_id)

	isFullfilled ($a_user_id, $a_item_id)

	cloneDependencies ($a_target_id, $a_copy_id)

Static Public Member Functions
static	isStartObject ($a_container_id, $a_item_ref_id)
	Check if object is start object @global type $ilDB. More...

Protected Member Functions
	setObjId ($a_id)

	setRefId ($a_ref_id)

	__read ()

Protected Attributes
	$tree

	$db

	$obj_data_cache

	$log

	$ref_id

	$obj_id

	$start_objs = array()

Detailed Description

ilContainerStartObjects

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

Version

Id: class.ilCourseStart.php 44362 2013-08-22 08:36:03Z jluetzen

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerStartObjects::__construct	(	$a_object_ref_id,
		$a_object_id
	)

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

    {
        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();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ __deleteAll()

ilContainerStartObjects::__deleteAll ( )

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

    {
        $ilDB = $this->db;
        
        $query = "DELETE FROM crs_start" .
            " WHERE crs_id = " . $ilDB->quote($this->getObjId(), 'integer');
        $ilDB->manipulate($query);
        return true;
    }

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

Here is the call graph for this function:

◆ __read()

ilContainerStartObjects::__read ( )

protected

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

    {
        $tree = $this->tree;
        $ilDB = $this->db;
 
        $this->start_objs = array();
 
        $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'] = $row->item_ref_id;
            } else {
                $this->delete($row->item_ref_id);
            }
        }
        return true;
    }

References $db, $ilDB, $query, $res, $row, $tree, ilDBConstants\FETCHMODE_OBJECT, and getObjId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add()

ilContainerStartObjects::add ( $a_item_ref_id )

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

    {
        $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;
    }

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

Referenced by ilLOSettings\updateStartObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ allFullfilled()

ilContainerStartObjects::allFullfilled ( $a_user_id )

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

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

References getStartObjects(), and isFullfilled().

Here is the call graph for this function:

◆ cloneDependencies()

ilContainerStartObjects::cloneDependencies	(	$a_target_id,
		$a_copy_id
	)

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

    {
        $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);
        
        include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
        $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]) and $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');
        return true;
    }

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

Here is the call graph for this function:

◆ delete()

ilContainerStartObjects::delete ( $a_crs_start_id )

Delete item by sequence id @global type $ilDB.

Parameters

type $a_crs_start_id

Returns: boolean

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

    {
        $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);
        return true;
    }

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

Here is the call graph for this function:

◆ deleteItem()

ilContainerStartObjects::deleteItem ( $a_item_ref_id )

Delete item by ref_id.

Parameters

type $a_item_ref_id

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

    {
        $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);
        return true;
    }

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

Referenced by ilLOSettings\updateStartObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists()

ilContainerStartObjects::exists ( $a_item_ref_id )

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

    {
        $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 $res->numRows() ? true : false;
    }

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

Referenced by ilLOSettings\updateStartObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilContainerStartObjects::getObjId ( )

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

    {
        return $this->obj_id;
    }

References $obj_id.

Referenced by __deleteAll(), __read(), add(), delete(), deleteItem(), and exists().

Here is the caller graph for this function:

◆ getPossibleStarters()

ilContainerStartObjects::getPossibleStarters ( )

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

    {
        include_once "Services/Object/classes/class.ilObjectActivation.php";
        foreach (ilObjectActivation::getItems($this->getRefId(), false) as $node) {
            switch ($node['type']) {
                case 'lm':
                case 'sahs':
                case 'svy':
                case 'tst':
                    $poss_items[] = $node['ref_id'];
                    break;
            }
        }
        return $poss_items ? $poss_items : array();
    }

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

Here is the call graph for this function:

◆ getRefId()

ilContainerStartObjects::getRefId ( )

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

    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by getPossibleStarters(), and isFullfilled().

Here is the caller graph for this function:

◆ getStartObjects()

ilContainerStartObjects::getStartObjects ( )

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

    {
        return $this->start_objs ? $this->start_objs : array();
    }

Referenced by allFullfilled(), and cloneDependencies().

Here is the caller graph for this function:

◆ isFullfilled()

ilContainerStartObjects::isFullfilled	(	$a_user_id,
		$a_item_id
	)

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

    {
        $ilObjDataCache = $this->obj_data_cache;
 
        $obj_id = $ilObjDataCache->lookupObjId($a_item_id);
        $type = $ilObjDataCache->lookupType($obj_id);
        
        switch ($type) {
            case 'tst':
                include_once './Modules/Test/classes/class.ilObjTestAccess.php';
                if (!ilObjTestAccess::checkCondition($obj_id, 'finished', '', $a_user_id)) { // #14000
                    return false;
                }
                break;
                
            case 'svy':
                
                include_once './Modules/Survey/classes/class.ilObjSurveyAccess.php';
                if (!ilObjSurveyAccess::_lookupFinished($obj_id, $a_user_id)) {
                    return false;
                }
                break;
                
            case 'sahs':
                include_once 'Services/Tracking/classes/class.ilLPStatus.php';
                if (!ilLPStatus::_hasUserCompleted($obj_id, $a_user_id)) {
                    return false;
                }
                break;
 
            default:
                include_once './Modules/Course/classes/class.ilCourseLMHistory.php';
                $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;
    }

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

Referenced by allFullfilled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isStartObject()

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

static

Check if object is start object @global type $ilDB.

Parameters

type	$a_container_id
type	$a_item_ref_id

Returns: boolean

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

    {
        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);
        if ($res->numRows() >= 1) {
            return true;
        }
        return false;
    }

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

Referenced by ilLOTestQuestionAdapter\isQualifiedStartRun().

Here is the caller graph for this function:

◆ setObjectPos()

ilContainerStartObjects::setObjectPos	(	$a_start_id,
		$a_pos
	)

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

    {
        $ilDB = $this->db;
        
        if (!(int) $a_start_id || !(int) $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'));
    }

References $db, and $ilDB.

◆ setObjId()

ilContainerStartObjects::setObjId ( $a_id )

protected

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

    {
        $this->obj_id = $a_id;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setRefId()

ilContainerStartObjects::setRefId ( $a_ref_id )

protected

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

    {
        $this->ref_id = $a_ref_id;
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $db

ilContainerStartObjects::$db

protected

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

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

◆ $log

ilContainerStartObjects::$log

protected

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

Referenced by cloneDependencies().

◆ $obj_data_cache

ilContainerStartObjects::$obj_data_cache

protected

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

Referenced by cloneDependencies(), and isFullfilled().

◆ $obj_id

ilContainerStartObjects::$obj_id

protected

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

Referenced by getObjId(), and isFullfilled().

◆ $ref_id

ilContainerStartObjects::$ref_id

protected

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

Referenced by getRefId().

◆ $start_objs

ilContainerStartObjects::$start_objs = array()

protected

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

◆ $tree

ilContainerStartObjects::$tree

protected

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

Referenced by __read().

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

Services/Container/classes/class.ilContainerStartObjects.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __deleteAll()

◆ __read()

◆ add()

◆ allFullfilled()

◆ cloneDependencies()

◆ delete()

◆ deleteItem()

◆ exists()

◆ getObjId()

◆ getPossibleStarters()

◆ getRefId()

◆ getStartObjects()

◆ isFullfilled()

◆ isStartObject()

◆ setObjectPos()

◆ setObjId()

◆ setRefId()

Field Documentation

◆ $db

◆ $log

◆ $obj_data_cache

◆ $obj_id

◆ $ref_id

◆ $start_objs

◆ $tree