ilCourseStart Class Reference

Class ilObj<module_name> More...

Inheritance diagram for ilCourseStart:

Collaboration diagram for ilCourseStart:

Public Member Functions
	ilCourseStart ($a_course_ref_id, $a_course_obj_id)
	Constructor public.
	setId ($a_id)
	set object id public
	getId ()
	get object id public
	setRefId ($a_ref_id)
	set reference id public
	getRefId ()
	get reference id public
	getStartObjects ()
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone dependencies.
	delete ($a_crs_start_id)
	exists ($a_item_ref_id)
	add ($a_item_ref_id)
	__deleteAll ()
	getPossibleStarters ()
	allFullfilled ($user_id)
	isFullfilled ($user_id, $item_id)
	__read ()
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ()
	create
	update ()
	update object in db
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!!
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public
	createRoleFolder ()
	creates a local role folder
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneMetaData ($target_obj)
	Copy meta data.
	_lookupCreationDate ($a_id)
	Lookup creation date.

Data Fields
	$db
	$ref_id
	$id
	$start_objs = array()
Data Fields inherited from ilObject
const	TITLE_LENGTH = 128
	max length of object title
	$ilias
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots
	$obj_data_record
	object_data record

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.
static	getLongDescriptions (array $a_obj_ids)
	Get long description data.
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns.

Detailed Description

Class ilObj<module_name>

Author

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

Version

$Id$

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

Member Function Documentation

ilCourseStart::__deleteAll

(

)

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

References $query, $res, and getId().

        {
                global $ilDB;
                
                $query = "DELETE FROM crs_start ".
                        "WHERE crs_id = ".$ilDB->quote($this->getId() ,'integer')." ";
                $res = $ilDB->manipulate($query);

                return true;
        }

Here is the call graph for this function:

ilCourseStart::__read

(

)

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

References $query, $res, $row, DB_FETCHMODE_OBJECT, and getId().

Referenced by ilCourseStart().

        {
                global $tree,$ilDB;

                $this->start_objs = array();

                $query = "SELECT * FROM crs_start ".
                        "WHERE crs_id = ".$ilDB->quote($this->getId() ,'integer')." ";

                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_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;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseStart::add

(

$a_item_ref_id

)

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

References $query, $res, and getId().

Referenced by ilObjCourseGUI\addStarterObject().

        {
                global $ilDB;
                
                if($a_item_ref_id)
                {
                        $next_id = $ilDB->nextId('crs_start');
                        $query = "INSERT INTO crs_start (crs_start_id,crs_id,item_ref_id) ".
                                "VALUES( ".
                                $ilDB->quote($next_id, 'integer').", ".
                                $ilDB->quote($this->getId() ,'integer').", ".
                                $ilDB->quote($a_item_ref_id ,'integer')." ".
                                ")";
                        $res = $ilDB->manipulate($query);
                        return true;
                }
                return false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseStart::allFullfilled

(

$user_id

)

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

References getStartObjects(), and isFullfilled().

        {
                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:

ilCourseStart::cloneDependencies	(		$a_target_id,
			$a_copy_id
	)

Clone dependencies.

public

Parameters

int	target id
int	copy id

Reimplemented from ilObject.

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

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

        {
                global $ilObjDataCache,$ilLog;
                
                $ilLog->write(__METHOD__.': Begin course start objects...');
                
                $new_obj_id = $ilObjDataCache->lookupObjId($a_target_id);
                $start = new ilCourseStart($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 $start_id => $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;
        }

Here is the call graph for this function:

ilCourseStart::delete

(

$a_crs_start_id

)

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

References $query, $res, and getId().

Referenced by ilObjCourseGUI\deleteStarterObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseStart::exists

(

$a_item_ref_id

)

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

References $query, $res, and getId().

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

                return $res->numRows() ? true : false;
        }

Here is the call graph for this function:

ilCourseStart::getId

(

)

get object id public

Returns

integer object id

Reimplemented from ilObject.

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

References $id.

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

        {
                return $this->id;
        }

Here is the caller graph for this function:

ilCourseStart::getPossibleStarters

(

)

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

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

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

Here is the call graph for this function:

ilCourseStart::getRefId

(

)

get reference id public

Returns

integer reference id

Reimplemented from ilObject.

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

References $ref_id.

Referenced by getPossibleStarters(), and isFullfilled().

        {
                return $this->ref_id;
        }

Here is the caller graph for this function:

ilCourseStart::getStartObjects

(

)

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

Referenced by allFullfilled(), ilObjCourseGUI\askDeleteStarterObject(), and cloneDependencies().

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

Here is the caller graph for this function:

ilCourseStart::ilCourseStart	(		$a_course_ref_id,
			$a_course_obj_id
	)

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

References __read().

Referenced by cloneDependencies().

        {
                global $ilDB;

                $this->db =& $ilDB;

                $this->ref_id = $a_course_ref_id;
                $this->id = $a_course_obj_id;

                $this->__read();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseStart::isFullfilled	(		$user_id,
			$item_id
	)

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

References ilObject\$type, ilObjTestAccess\_checkCondition(), ilObjSurveyAccess\_lookupFinished(), ilLPStatus\_lookupStatus(), getRefId(), and LP_STATUS_COMPLETED_NUM.

Referenced by allFullfilled().

        {
                global $ilObjDataCache;

                include_once './Modules/Course/classes/class.ilCourseLMHistory.php';
                $lm_continue =& new ilCourseLMHistory($this->getRefId(),$user_id);
                $continue_data = $lm_continue->getLMHistory();

                $obj_id = $ilObjDataCache->lookupObjId($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',''))
                                {
                                        return false;
                                }
                                break;
                        case 'svy':
                                include_once './Modules/Survey/classes/class.ilObjSurveyAccess.php';
                                if(!ilObjSurveyAccess::_lookupFinished($obj_id, $user_id))
                                {
                                        return false;
                                }
                                break;
                        case 'sahs':
                                include_once 'Services/Tracking/classes/class.ilLPStatus.php';
                                if(ilLPStatus::_lookupStatus($obj_id, $user_id) != LP_STATUS_COMPLETED_NUM)
                                {
                                        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:

ilCourseStart::setId

(

$a_id

)

set object id public

Parameters

integer

$a_id

object id

Reimplemented from ilObject.

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

        {
                $this->id = $a_id;
        }

ilCourseStart::setRefId

(

$a_id

)

set reference id public

Parameters

integer

$a_id

reference id

Reimplemented from ilObject.

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

        {
                $this->ref_id = $a_ref_id;
        }

Field Documentation

ilCourseStart::$db

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

ilCourseStart::$id

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

Referenced by getId().

ilCourseStart::$ref_id

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

Referenced by getRefId().

ilCourseStart::$start_objs = array()

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

---

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

• Modules/Course/classes/class.ilCourseStart.php