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

Collaboration diagram for ilCourseStart:

Public Member Functions
	__construct ($a_course_ref_id, $a_course_obj_id)

	setId (int $a_id)

	getId ()

	setRefId (int $a_ref_id)

	getRefId ()

	getStartObjects ()

	cloneDependencies (int $a_target_id, int $a_copy_id)

	delete (int $a_crs_start_id)

	exists (int $a_item_ref_id)

	add (int $a_item_ref_id)

	getPossibleStarters ()

	allFullfilled ($user_id)

	isFullfilled (int $user_id, int $item_id)

	__read ()

Protected Attributes
ilDBInterface	$db

ilLogger	$logger

ilObjectDataCache	$objectDataCache

ilTree	$tree

Private Attributes
int	$ref_id

int	$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

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

Definition at line 23 of file class.ilCourseStart.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseStart::__construct	(	$a_course_ref_id,
		$a_course_obj_id
	)

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

References $DIC, __read(), ILIAS\Repository\logger(), and ILIAS\Repository\objectDataCache().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->objectDataCache = $DIC['ilObjDataCache'];
         $this->logger = $DIC->logger()->crs();
 
         $this->ref_id = $a_course_ref_id;
         $this->id = $a_course_obj_id;
         $this->__read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __read()

ilCourseStart::__read ( )

Definition at line 184 of file class.ilCourseStart.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, getId(), and ILIAS\Repository\int().

Referenced by __construct().

                             : void
     {
         $this->start_objs = array();
         $query = "SELECT * FROM crs_start " .
             "WHERE crs_id = " . $this->db->quote($this->getId(), 'integer') . " ";
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if ($this->tree->isInTree((int) $row->item_ref_id)) {
                 $this->start_objs[(int) $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:

◆ add()

ilCourseStart::add ( int $a_item_ref_id )

Definition at line 110 of file class.ilCourseStart.php.

References $res, and getId().

                                            : void
     {
         if ($a_item_ref_id) {
             $next_id = $this->db->nextId('crs_start');
             $query = "INSERT INTO crs_start (crs_start_id,crs_id,item_ref_id) " .
                 "VALUES( " .
                 $this->db->quote($next_id, 'integer') . ", " .
                 $this->db->quote($this->getId(), 'integer') . ", " .
                 $this->db->quote($a_item_ref_id, 'integer') . " " .
                 ")";
             $res = $this->db->manipulate($query);
         }
     }

Here is the call graph for this function:

◆ allFullfilled()

ilCourseStart::allFullfilled ( $user_id )

Definition at line 140 of file class.ilCourseStart.php.

References getStartObjects(), and isFullfilled().

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

Here is the call graph for this function:

◆ cloneDependencies()

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

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

References $data, ilCopyWizardOptions\_getInstance(), getStartObjects(), ILIAS\Repository\logger(), and ILIAS\Repository\objectDataCache().

                                                                        : void
     {
         $this->logger->debug('Begin course start objects...');
 
         $new_obj_id = $this->objectDataCache->lookupObjId($a_target_id);
         $start = new ilCourseStart($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]) {
                 $this->logger->debug('Clone start object nr. ' . $item_ref_id);
                 $start->add($mappings[$item_ref_id]);
             } else {
                 $this->logger->debug('No mapping found for start object nr. ' . $item_ref_id);
             }
         }
         $this->logger->debug('... end course start objects');
     }

Here is the call graph for this function:

◆ delete()

ilCourseStart::delete ( int $a_crs_start_id )

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

References $res, and getId().

                                                : void
     {
         $query = "DELETE FROM crs_start " .
             "WHERE crs_start_id = " . $this->db->quote($a_crs_start_id, 'integer') . " " .
             "AND crs_id = " . $this->db->quote($this->getId(), 'integer') . " ";
         $res = $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ exists()

ilCourseStart::exists ( int $a_item_ref_id )

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

References $res, and getId().

                                               : bool
     {
         $query = "SELECT * FROM crs_start " .
             "WHERE crs_id = " . $this->db->quote($this->getId(), 'integer') . " " .
             "AND item_ref_id = " . $this->db->quote($a_item_ref_id, 'integer') . " ";
         $res = $this->db->query($query);
         return (bool) $res->numRows();
     }

Here is the call graph for this function:

◆ getId()

ilCourseStart::getId ( )

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

References $id.

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

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getPossibleStarters()

ilCourseStart::getPossibleStarters ( )

Definition at line 124 of file class.ilCourseStart.php.

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

Referenced by ilCourseStartObjectsTableGUI\getPossibleObjects().

                                          : array
     {
         $poss_items = [];
         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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilCourseStart::getRefId ( )

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

References $ref_id.

Referenced by getPossibleStarters(), and isFullfilled().

                               : int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getStartObjects()

ilCourseStart::getStartObjects ( )

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

References $start_objs.

Referenced by allFullfilled(), cloneDependencies(), ilCourseStartObjectsTableGUI\getStartObjects(), and ilCourseContentGUI\showStartObjects().

                                      : array
     {
         return $this->start_objs;
     }

Here is the caller graph for this function:

◆ isFullfilled()

ilCourseStart::isFullfilled	(	int	$user_id,
		int	$item_id
	)

Definition at line 150 of file class.ilCourseStart.php.

References ilLPStatus\_hasUserCompleted(), ilObjSurveyAccess\_lookupFinished(), ilObjTestAccess\checkCondition(), getRefId(), ILIAS\Repository\objectDataCache(), and ilConditionHandler\OPERATOR_FINISHED.

Referenced by allFullfilled(), and ilCourseContentGUI\showStartObjects().

                                                             : bool
     {
         $lm_continue = new ilCourseLMHistory($this->getRefId(), $user_id);
         $continue_data = $lm_continue->getLMHistory();
 
         $obj_id = $this->objectDataCache->lookupObjId($item_id);
         $type = $this->objectDataCache->lookupType($obj_id);
 
         switch ($type) {
             case 'tst':
 
                 if (!ilObjTestAccess::checkCondition($obj_id, ilConditionHandler::OPERATOR_FINISHED, '', $user_id)) {
                     return false;
                 }
                 break;
             case 'svy':
                 if (!ilObjSurveyAccess::_lookupFinished($obj_id, $user_id)) {
                     return false;
                 }
                 break;
             case 'sahs':
                 if (!ilLPStatus::_hasUserCompleted($obj_id, $user_id)) {
                     return false;
                 }
                 break;
 
             default:
                 if (!isset($continue_data[$item_id])) {
                     return false;
                 }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setId()

ilCourseStart::setId ( int $a_id )

Definition at line 47 of file class.ilCourseStart.php.

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

◆ setRefId()

ilCourseStart::setRefId ( int $a_ref_id )

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

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

Field Documentation

◆ $db

ilDBInterface ilCourseStart::$db

protected

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

◆ $id

int ilCourseStart::$id

private

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

Referenced by getId().

◆ $logger

ilLogger ilCourseStart::$logger

protected

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

◆ $objectDataCache

ilObjectDataCache ilCourseStart::$objectDataCache

protected

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

◆ $ref_id

int ilCourseStart::$ref_id

private

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

Referenced by getRefId().

◆ $start_objs

array ilCourseStart::$start_objs = []

private

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

Referenced by getStartObjects().

◆ $tree

ilTree ilCourseStart::$tree

protected

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

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

Modules/Course/classes/class.ilCourseStart.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __read()

◆ add()

◆ allFullfilled()

◆ cloneDependencies()

◆ delete()

◆ exists()

◆ getId()

◆ getPossibleStarters()

◆ getRefId()

◆ getStartObjects()

◆ isFullfilled()

◆ setId()

◆ setRefId()

Field Documentation

◆ $db

◆ $id

◆ $logger

◆ $objectDataCache

◆ $ref_id

◆ $start_objs

◆ $tree