ilObjCourse Class Reference

Class ilObjCourse. More...

Inheritance diagram for ilObjCourse:

Collaboration diagram for ilObjCourse:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	getShowMembersExport ()
	setShowMembersExport ($a_mem_export)
	getRegistrationAccessCode ()
	get access code More...
	setRegistrationAccessCode ($a_code)
	Set refistration access code. More...
	isRegistrationAccessCodeEnabled ()
	Check if access code is enabled. More...
	enableRegistrationAccessCode ($a_status)
	En/disable registration access code. More...
	getImportantInformation ()
	setImportantInformation ($a_info)
	getSyllabus ()
	setSyllabus ($a_syllabus)
	getTargetGroup ()
	setTargetGroup (?string $a_tg)
	getContactName ()
	setContactName ($a_cn)
	getContactConsultation ()
	setContactConsultation ($a_value)
	getContactPhone ()
	setContactPhone ($a_value)
	getContactEmail ()
	setContactEmail ($a_value)
	getContactResponsibility ()
	setContactResponsibility ($a_value)
	getActivationUnlimitedStatus ()
	get activation unlimited no start or no end More...
	getActivationStart ()
	setActivationStart ($a_value)
	getActivationEnd ()
	setActivationEnd ($a_value)
	setActivationVisibility ($a_value)
	getActivationVisibility ()
	getSubscriptionLimitationType ()
	setSubscriptionLimitationType ($a_type)
	getSubscriptionUnlimitedStatus ()
	getSubscriptionStart ()
	setSubscriptionStart ($a_value)
	getSubscriptionEnd ()
	setSubscriptionEnd ($a_value)
	getSubscriptionType ()
	setSubscriptionType ($a_value)
	getSubscriptionPassword ()
	setSubscriptionPassword ($a_value)
	enabledObjectiveView ()
	enabledWaitingList ()
	enableWaitingList ($a_status)
	inSubscriptionTime ()
	enableSessionLimit ($a_status)
	en/disable limited number of sessions More...
	isSessionLimitEnabled ()
	enableSubscriptionMembershipLimitation ($a_status)
	enable max members More...
	setNumberOfPreviousSessions ($a_num)
	Set number of previous sessions. More...
	getNumberOfPreviousSessions ()
	Set number of previous sessions. More...
	setNumberOfNextSessions ($a_num)
	Set number of previous sessions. More...
	getNumberOfNextSessions ()
	Set number of previous sessions. More...
	isSubscriptionMembershipLimited ()
	is membership limited More...
	getSubscriptionMaxMembers ()
	setSubscriptionMaxMembers ($a_value)
	getSubItems ( $a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0, \ilContainerUserFilter $container_user_filter=null)
	Get subitems of container. More...
	getSubscriptionNotify ()
	setSubscriptionNotify ($a_value)
	setViewMode ($a_mode)
	getViewMode ()
	setTimingMode ($a_mode)
	getTimingMode ()
	getArchiveStart ()
	setArchiveStart ($a_value)
	getArchiveEnd ()
	setArchiveEnd ($a_value)
	getArchiveType ()
	setArchiveType ($a_value)
	setAboStatus ($a_status)
	getAboStatus ()
	setShowMembers ($a_status)
	getShowMembers ()
	setMailToMembersType ($a_type)
	Set mail to members type. More...
	getMailToMembersType ()
	Get mail to members type. More...
	getMessage ()
	setMessage ($a_message)
	appendMessage ($a_message)
	isActivated ()
	Check if course is active and not offline. More...
	allowAbo ()
	read ()
	create ($a_upload=false)
	setLatitude ($a_latitude)
	Set Latitude. More...
	getLatitude ()
	Get Latitude. More...
	setLongitude ($a_longitude)
	Set Longitude. More...
	getLongitude ()
	Get Longitude. More...
	setLocationZoom ($a_locationzoom)
	Set LocationZoom. More...
	getLocationZoom ()
	Get LocationZoom. More...
	setEnableCourseMap ($a_enablemap)
	Set Enable Course Map. More...
	getEnableMap ()
	Type independent wrapper. More...
	getEnableCourseMap ()
	Get Enable Course Map. More...
	setCoursePeriod (\ilDateTime $start=null, \ilDateTime $end=null)
	getCourseStartTimeIndication ()
	getCourseStart ()
	getCourseEnd ()
	setCancellationEnd (ilDate $a_value=null)
	getCancellationEnd ()
	setSubscriptionMinMembers ($a_value)
	getSubscriptionMinMembers ()
	setWaitingListAutoFill ($a_value)
	hasWaitingListAutoFill ()
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone course (no member data) More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (start objects, preconditions) More...
	cloneAutoGeneratedRoles ($new_obj)
	Clone automatic genrated roles (permissions and template permissions) More...
	validate ()
	validateInfoSettings ()
	hasContactData ()
	delete ()
	delete course and all related data More...
	update ()
	update complete object More...
	updateSettings ()
	Update settings. More...
	cloneSettings (\ilObjCourse $new_obj)
	Clone entries in settings table. More...
	__createDefaultSettings ()
	__readSettings ()
	initWaitingList ()
	getMemberObject ()
	Get course member object. More...
	getMembersObject ()
	initDefaultRoles ()
	setParentRolePermissions ($a_parent_ref)
	This method is called before "initDefaultRoles". More...
	__getCrsNonMemberTemplateId ()
	get course non-member template private More...
	getLocalCourseRoles ($a_translate=false)
	get ALL local roles of course, also those created and defined afterwards only fetch data once from database. More...
	getDefaultCourseRoles ($a_crs_id="")
	get default course roles, returns the defaultlike create roles il_crs_tutor, il_crs_admin and il_crs_member public More...
	__getLocalRoles ()
	__deleteSettings ()
	getDefaultMemberRole ()
	getDefaultTutorRole ()
	getDefaultAdminRole ()
	MDUpdateListener ($a_element)
	Overwriten Metadata update listener for ECS functionalities. More...
	addAdditionalSubItemInformation (&$a_item_data)
	Add additional information to sub item, e.g. More...
	register ($a_user_id, $a_role=ilCourseConstants::CRS_MEMBER, $a_force_registration=false)
	getAutoNotification ()
	Returns automatic notification status from $this->auto_notification. More...
	setAutoNotification ($value)
	Sets automatic notification status in $this->auto_notification, using given $status. More...
	setStatusDetermination ($a_value)
	Set status determination mode. More...
	getStatusDetermination ()
	Get status determination mode. More...
	syncMembersStatusWithLP ()
	Set course status for all members by lp status. More...
	checkLPStatusSync ($a_member_id)
	sync course status from lp More...
	getOrderType ()
	handleAutoFill ()
	Handle course auto fill. More...
Public Member Functions inherited from ilContainer
	__construct ($a_id=0, $a_reference=true)
	getObjectTranslation ()
	Get object translation. More...
	setObjectTranslation (ilObjectTranslation $obj_trans)
	Get object translation. More...
	createContainerDirectory ()
	Create directory for the container. More...
	getContainerDirectory ()
	Get the container directory. More...
	setHiddenFilesFound ($a_hiddenfilesfound)
	Set Found hidden files (set by getSubItems). More...
	getHiddenFilesFound ()
	Get Found hidden files (set by getSubItems). More...
	getStyleSheetId ()
	get ID of assigned style sheet object More...
	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object More...
	setNewsTimeline ($a_val)
	Set news timeline. More...
	getNewsTimeline ()
	Get news timeline. More...
	setNewsTimelineAutoEntries ($a_val)
	Set news timeline auto entries. More...
	getNewsTimelineAutoEntries ()
	Get news timeline auto entries. More...
	setNewsTimelineLandingPage ($a_val)
	Set news timline is landing page. More...
	getNewsTimelineLandingPage ()
	Get news timline is landing page. More...
	isNewsTimelineEffective ()
	Is news timeline effective? More...
	isNewsTimelineLandingPageEffective ()
	Is news timeline landing page effective? More...
	setNewsBlockActivated ($a_val)
	Set news block activated. More...
	getNewsBlockActivated ()
	Get news block activated. More...
	setUseNews ($a_val)
	Set use news. More...
	getUseNews ()
	Get use news. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (container sorting) More...
	cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false, $a_submode=1)
	clone all objects according to this container More...
	delete ()
	delete category and all related data More...
	getViewMode ()
	Get container view mode. More...
	getOrderType ()
	Get order type default implementation. More...
	setOrderType ($a_value)
	isClassificationFilterActive ()
	Is classification filter active? More...
	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...
	getSubItems ( $a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0, \ilContainerUserFilter $container_user_filter=null)
	Get subitems of container. More...
	gotItems ()
	Check whether we got any items. More...
	addAdditionalSubItemInformation (&$object)
	Add additional information to sub item, e.g. More...
	getGroupedObjTypes ()
	Get grouped repository object types. More...
	enablePageEditing ()
	Check whether page editing is allowed for container. More...
	create ()
	Create. More...
	putInTree ($a_parent_ref)
	update ()
	Update. More...
	read ()
	read More...
	readContainerSettings ()
	Read container settings. More...
	removeTranslations ()
	Remove all translations of container. More...
	deleteTranslation ($a_lang)
	Delete translation. More...
	addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
	Add translation. More...
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ()
	read object data from db into object More...
	getId ()
	get object id public More...
	setId ($a_id)
	set object id public More...
	setRefId ($a_id)
	set reference id public More...
	getRefId ()
	get reference id public More...
	getType ()
	get object type public More...
	setType ($a_type)
	set object type public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title public More...
	getUntranslatedTitle ()
	get untranslated object title public More...
	setTitle ($a_title)
	set object title More...
	getDescription ()
	get object description More...
	setDescription ($a_desc)
	set object description More...
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	get import id More...
	setImportId ($a_import_id)
	set import id More...
	setOfflineStatus ($a_status)
	Set offline status. More...
	getOfflineStatus ()
	Get offline status. More...
	supportsOfflineHandling ()
	Check whether object supports offline handling. More...
	getOwner ()
	get object owner More...
	getOwnerName ()
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date public More...
	getLastUpdateDate ()
	get last update date public More...
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	create ()
	create More...
	update ()
	update object in db More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	updateOwner ()
	update owner of object in db More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object More...
	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!! More...
	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 More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...
	cloneMetaData ($target_obj)
	Copy meta data. More...
	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...
Public Member Functions inherited from ilMembershipRegistrationCodes
	register ($a_user_id)
	Register an user. More...

Static Public Member Functions
static	lookupShowMembersEnabled ($a_obj_id)
	Check if show member is enabled. More...
static	_isSubscriptionNotificationEnabled ($a_course_id)
	Check if subscription notification is enabled. More...
static	lookupTimingMode ($a_obj_id)
static	_lookupViewMode ($a_id)
	lookup view mode of container More...
static	_lookupAboStatus ($a_id)
static	_isActivated ($a_obj_id)
	Is activated. More...
static	_registrationEnabled ($a_obj_id)
	Registration enabled? Method is in Access class, since it is needed by Access/ListGUI. More...
static	lookupCourseNonMemberTemplatesId ()
	Lookup course non member id. More...
static	_deleteUser ($a_usr_id)
static	lookupObjectsByCode ($a_code)
static	mayLeave ($a_course_id, $a_user_id=null, &$a_date=null)
static	findCoursesWithNotEnoughMembers ()
	Minimum members check type $ilDB. More...
Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory ($a_id)
	Get the container directory. More...
static	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
	Lookup a container setting. More...
static	_writeContainerSetting ($a_id, $a_keyword, $a_value)
static	_getContainerSettings ($a_id)
static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)
static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)
static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupImportId ($a_obj_id)
static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
static	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner ($a_id)
	lookup object owner More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id, $a_deleted_by)
static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...
static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...
static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...
static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate ($a_id)
	Lookup creation date. More...
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
const	CAL_REG_START = 1
const	CAL_REG_END = 2
const	CAL_ACTIVATION_START = 3
const	CAL_ACTIVATION_END = 4
const	CAL_COURSE_START = 5
const	CAL_COURSE_END = 6
const	CAL_COURSE_TIMING_START = 7
const	CAL_COURSE_TIMING_END = 8
const	STATUS_DETERMINATION_LP = 1
const	STATUS_DETERMINATION_MANUAL = 2
	$archives_obj
Data Fields inherited from ilContainer
const	VIEW_SESSIONS = 0
const	VIEW_OBJECTIVE = 1
const	VIEW_TIMING = 2
const	VIEW_ARCHIVE = 3
const	VIEW_SIMPLE = 4
const	VIEW_BY_TYPE = 5
const	VIEW_INHERIT = 6
const	VIEW_DEFAULT = self::VIEW_BY_TYPE
const	SORT_TITLE = 0
const	SORT_MANUAL = 1
const	SORT_ACTIVATION = 2
const	SORT_INHERIT = 3
const	SORT_CREATION = 4
const	SORT_DIRECTION_ASC = 0
const	SORT_DIRECTION_DESC = 1
const	SORT_NEW_ITEMS_POSITION_TOP = 0
const	SORT_NEW_ITEMS_POSITION_BOTTOM = 1
const	SORT_NEW_ITEMS_ORDER_TITLE = 0
const	SORT_NEW_ITEMS_ORDER_CREATION = 1
const	SORT_NEW_ITEMS_ORDER_ACTIVATION = 2
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...
const	DESC_LENGTH = 128
	$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

Protected Member Functions
	toggleCourseStartTimeIndication (bool $time_indication)
	setCourseStart (ilDateTime $a_value=null)
	setCourseEnd (ilDateTime $a_value=null)
	initCourseMemberObject ()
	Init course member object ilObjUser $ilUser. More...
	initCourseMembersObject ()
	Init course member object ilObjUser $ilUser. More...
	prepareAppointments ($a_mode='create')
	Prepare calendar appointments. More...
Protected Member Functions inherited from ilContainer
	getInitialSubitems ()
	Get initial subitems. More...
	applyContainerUserFilter ($objects, ilContainerUserFilter $container_user_filter=null)
	Apply container user filter on objects. More...
	legacyOnlineFilter ($obj_ids, $objects, $val)
	Legacy online filter. More...

Protected Attributes
	$course_logger = null
	$course_start_time_indication = false
	$crs_start
	$crs_end
	$leave_end
	$min_members
	$auto_fill_from_waiting
	$member_export = false
Protected Attributes inherited from ilContainer
	$news
	$db
	$log
	$access
	$error
	$rbacsystem
	$tree
	$user
	$obj_definition
	$order_type = 0
	$hiddenfilesfound = false
	$news_timeline = false
	$news_timeline_auto_entries = false
	$setting
	$obj_trans = null
	$recommended_content_manager
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Private Attributes
	$member_obj = null
	$members_obj = null
	$latitude = ''
	$longitude = ''
	$locationzoom = 0
	$enablemap = 0
	$session_limit = 0
	$session_prev = -1
	$session_next = -1
	$reg_access_code = ''
	$reg_access_code_enabled = false
	$status_dt = null
	$mail_members = ilCourseConstants::MAIL_ALLOWED_ALL
	$timing_mode = ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE
	$auto_notification = true
	$target_group = ''

Additional Inherited Members
Static Public Attributes inherited from ilContainer
static	$data_preloaded = false

Detailed Description

Class ilObjCourse.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilObjCourse::__construct	(		$a_id = 0,
			$a_call_by_reference = true
	)

Constructor public.

Parameters

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

Definition at line 125 of file class.ilObjCourse.php.

References $GLOBALS, ILIAS\GlobalScreen\Provider\__construct(), and setStatusDetermination().

    {
        
        #define("ILIAS_MODULE","course");
        #define("KEEP_IMAGE_PATH",1);

        $this->SUBSCRIPTION_DEACTIVATED = 1;
        $this->SUBSCRIPTION_CONFIRMATION = 2;
        $this->SUBSCRIPTION_DIRECT = 3;
        $this->SUBSCRIPTION_PASSWORD = 4;
        $this->SUBSCRIPTION_AUTOSUBSCRIPTION = 5;
        $this->ARCHIVE_DISABLED = 1;
        $this->ARCHIVE_READ = 2;
        $this->ARCHIVE_DOWNLOAD = 3;
        $this->ABO_ENABLED = 1;
        $this->ABO_DISABLED = 0;
        $this->SHOW_MEMBERS_ENABLED = 1;
        $this->SHOW_MEMBERS_DISABLED = 0;
        $this->setStatusDetermination(self::STATUS_DETERMINATION_LP);

        $this->type = "crs";
        
        $this->course_logger = $GLOBALS['DIC']->logger()->crs();

        parent::__construct($a_id, $a_call_by_reference);
    }

Here is the call graph for this function:

Member Function Documentation

__createDefaultSettings()

ilObjCourse::__createDefaultSettings

(

)

Definition at line 1425 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, __readSettings(), ilMembershipRegistrationCodeUtils\generateCode(), getAutoNotification(), getContactConsultation(), getContactEmail(), getContactName(), getContactPhone(), getContactResponsibility(), getEnableCourseMap(), ilObject\getId(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getNumberOfPreviousSessions(), getRegistrationAccessCode(), getStatusDetermination(), getSubscriptionEnd(), getSubscriptionMaxMembers(), getSubscriptionPassword(), getSubscriptionStart(), getSyllabus(), IL_CRS_SUBSCRIPTION_DEACTIVATED, IL_CRS_SUBSCRIPTION_DIRECT, IL_CRS_VIEW_TIMING_ABSOLUTE, isRegistrationAccessCodeEnabled(), isSessionLimitEnabled(), setRegistrationAccessCode(), and ilContainer\SORT_MANUAL.

Referenced by create(), and updateSettings().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        include_once './Services/Membership/classes/class.ilMembershipRegistrationCodeUtils.php';
        $this->setRegistrationAccessCode(ilMembershipRegistrationCodeUtils::generateCode());

        $query = "INSERT INTO crs_settings (obj_id,syllabus,contact_name,contact_responsibility," .
            "contact_phone,contact_email,contact_consultation," .
            "sub_limitation_type,sub_start,sub_end,sub_type,sub_password,sub_mem_limit," .
            "sub_max_members,sub_notify,view_mode,timing_mode,abo," .
            "latitude,longitude,location_zoom,enable_course_map,waiting_list,show_members,show_members_export, " .
            "session_limit,session_prev,session_next, reg_ac_enabled, reg_ac, auto_notification, status_dt,mail_members_type) " .
            "VALUES( " .
            $ilDB->quote($this->getId(), 'integer') . ", " .
            $ilDB->quote($this->getSyllabus(), 'text') . ", " .
            $ilDB->quote($this->getContactName(), 'text') . ", " .
            $ilDB->quote($this->getContactResponsibility(), 'text') . ", " .
            $ilDB->quote($this->getContactPhone(), 'text') . ", " .
            $ilDB->quote($this->getContactEmail(), 'text') . ", " .
            $ilDB->quote($this->getContactConsultation(), 'text') . ", " .
            $ilDB->quote(IL_CRS_SUBSCRIPTION_DEACTIVATED, 'integer') . ", " .
            $ilDB->quote($this->getSubscriptionStart(), 'integer') . ", " .
            $ilDB->quote($this->getSubscriptionEnd(), 'integer') . ", " .
            $ilDB->quote(IL_CRS_SUBSCRIPTION_DIRECT, 'integer') . ", " .
            $ilDB->quote($this->getSubscriptionPassword(), 'text') . ", " .
            "0, " .
            $ilDB->quote($this->getSubscriptionMaxMembers(), 'integer') . ", " .
            "1, " .
            "0, " .
            $ilDB->quote(IL_CRS_VIEW_TIMING_ABSOLUTE, 'integer') . ', ' .
            $ilDB->quote($this->ABO_ENABLED, 'integer') . ", " .
            $ilDB->quote($this->getLatitude(), 'text') . ", " .
            $ilDB->quote($this->getLongitude(), 'text') . ", " .
            $ilDB->quote($this->getLocationZoom(), 'integer') . ", " .
            $ilDB->quote($this->getEnableCourseMap(), 'integer') . ", " .
            #"objective_view = '0', ".
            "1, " .
            "1," .
            '0,' .
            $ilDB->quote($this->isSessionLimitEnabled(), 'integer') . ', ' .
            $ilDB->quote($this->getNumberOfPreviousSessions(), 'integer') . ', ' .
            $ilDB->quote($this->getNumberOfPreviousSessions(), 'integer') . ', ' .
            $ilDB->quote($this->isRegistrationAccessCodeEnabled(), 'integer') . ', ' .
            $ilDB->quote($this->getRegistrationAccessCode(), 'text') . ', ' .
            $ilDB->quote((int) $this->getAutoNotification(), 'integer') . ', ' .
            $ilDB->quote((int) $this->getStatusDetermination(), 'integer') . ', ' .
            $ilDB->quote((int) $this->getMailToMembersType(), 'integer') . ' ' .
            ")";
            
        $res = $ilDB->manipulate($query);
        $this->__readSettings();

        include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
        $sorting = new ilContainerSortingSettings($this->getId());
        $sorting->setSortMode(ilContainer::SORT_MANUAL);
        $sorting->update();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__deleteSettings()

ilObjCourse::__deleteSettings

(

)

Definition at line 1828 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, and ilObject\getId().

Referenced by delete().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "DELETE FROM crs_settings " .
            "WHERE obj_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:

__getCrsNonMemberTemplateId()

ilObjCourse::__getCrsNonMemberTemplateId

(

)

get course non-member template private

Parameters

return

obj_id of roletemplate containing permissionsettings for non-member roles of a course.

Definition at line 1704 of file class.ilObjCourse.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by setParentRolePermissions().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $q = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_crs_non_member'";
        $res = $this->ilias->db->query($q);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);

        return $row["obj_id"];
    }

Here is the caller graph for this function:

__getLocalRoles()

ilObjCourse::__getLocalRoles

(

)

Definition at line 1817 of file class.ilObjCourse.php.

References $DIC, ilObject\$rbacreview, and ilObject\getRefId().

Referenced by getDefaultAdminRole(), getDefaultMemberRole(), and getDefaultTutorRole().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];

        // GET role_objects of predefined roles
        
        return $rbacreview->getRolesOfRoleFolder($this->getRefId(), false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__readSettings()

ilObjCourse::__readSettings

(

)

Definition at line 1487 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, ilPrivacySettings\_getInstance(), enableRegistrationAccessCode(), enableSessionLimit(), enableSubscriptionMembershipLimitation(), enableWaitingList(), ilDBConstants\FETCHMODE_OBJECT, ilObject\getId(), ilObjectActivation\getItem(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, setAboStatus(), setActivationEnd(), setActivationStart(), setActivationVisibility(), setAutoNotification(), setCancellationEnd(), setContactConsultation(), setContactEmail(), setContactName(), setContactPhone(), setContactResponsibility(), setCoursePeriod(), setEnableCourseMap(), setImportantInformation(), setLatitude(), setLocationZoom(), setLongitude(), setMailToMembersType(), setNumberOfNextSessions(), setNumberOfPreviousSessions(), ilObject\setOfflineStatus(), setRegistrationAccessCode(), setShowMembers(), setShowMembersExport(), setStatusDetermination(), setSubscriptionEnd(), setSubscriptionLimitationType(), setSubscriptionMaxMembers(), setSubscriptionMinMembers(), setSubscriptionNotify(), setSubscriptionPassword(), setSubscriptionStart(), setSubscriptionType(), setSyllabus(), setTargetGroup(), setTimingMode(), setViewMode(), setWaitingListAutoFill(), ilObjectActivation\TIMINGS_ACTIVATION, toggleCourseStartTimeIndication(), and ilTimeZone\UTC.

Referenced by __createDefaultSettings(), and read().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setSyllabus($row->syllabus);
            $this->setTargetGroup($row->target_group);
            $this->setContactName($row->contact_name);
            $this->setContactResponsibility($row->contact_responsibility);
            $this->setContactPhone($row->contact_phone);
            $this->setContactEmail($row->contact_email);
            $this->setContactConsultation($row->contact_consultation);
            $this->setOfflineStatus(!(bool) $row->activation_type); // see below
            $this->setSubscriptionLimitationType($row->sub_limitation_type);
            $this->setSubscriptionStart($row->sub_start);
            $this->setSubscriptionEnd($row->sub_end);
            $this->setSubscriptionType($row->sub_type);
            $this->setSubscriptionPassword($row->sub_password);
            $this->enableSubscriptionMembershipLimitation($row->sub_mem_limit);
            $this->setSubscriptionMaxMembers($row->sub_max_members);
            $this->setSubscriptionNotify($row->sub_notify);
            $this->setViewMode($row->view_mode);
            $this->setTimingMode((int) $row->timing_mode);
            $this->setAboStatus($row->abo);
            $this->enableWaitingList($row->waiting_list);
            $this->setImportantInformation($row->important);
            $this->setShowMembers($row->show_members);

            if (\ilPrivacySettings::_getInstance()->participantsListInCoursesEnabled()) {
                $this->setShowMembersExport($row->show_members_export);
            } else {
                $this->setShowMembersExport(false);
            }
            $this->setLatitude($row->latitude);
            $this->setLongitude($row->longitude);
            $this->setLocationZoom($row->location_zoom);
            $this->setEnableCourseMap($row->enable_course_map);
            $this->enableSessionLimit($row->session_limit);
            $this->setNumberOfPreviousSessions($row->session_prev);
            $this->setNumberOfNextSessions($row->session_next);
            $this->enableRegistrationAccessCode($row->reg_ac_enabled);
            $this->setRegistrationAccessCode($row->reg_ac);
            $this->setAutoNotification($row->auto_notification == 1 ? true : false);
            $this->setStatusDetermination((int) $row->status_dt);
            $this->setMailToMembersType($row->mail_members_type);

            if ($row->period_time_indication) {
                $this->setCoursePeriod(
                    new \ilDateTime($row->period_start, IL_CAL_DATETIME, \ilTimeZone::UTC),
                    new \ilDateTime($row->period_end, IL_CAL_DATETIME, \ilTimeZone::UTC)
                );
            } elseif (!is_null($row->period_start) && !is_null($row->period_end)) {
                $this->setCoursePeriod(
                    new \ilDate($row->period_start, IL_CAL_DATE),
                    new \ilDate($row->period_end, IL_CAL_DATE)
                );
            }
            $this->toggleCourseStartTimeIndication((bool) $row->period_time_indication);
            $this->setCancellationEnd($row->leave_end ? new ilDate($row->leave_end, IL_CAL_UNIX) : null);
            $this->setWaitingListAutoFill($row->auto_wait);
            $this->setSubscriptionMinMembers($row->min_members ? $row->min_members : null);
        }
        
        // moved activation to ilObjectActivation
        if ($this->ref_id) {
            include_once "./Services/Object/classes/class.ilObjectActivation.php";
            $activation = ilObjectActivation::getItem($this->ref_id);
            switch ($activation["timing_type"]) {
                case ilObjectActivation::TIMINGS_ACTIVATION:
                    $this->setActivationStart($activation["timing_start"]);
                    $this->setActivationEnd($activation["timing_end"]);
                    $this->setActivationVisibility($activation["visible"]);
                    break;
        }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_deleteUser()

static ilObjCourse::_deleteUser (   $a_usr_id )

static

Definition at line 1881 of file class.ilObjCourse.php.

References ilCourseLMHistory\_deleteUser(), ilParticipants\_deleteUser(), and ilLOUserResults\deleteResultsForUser().

Referenced by ilObjUser\delete().

    {
        // Delete all user related data
        // delete lm_history
        include_once './Modules/Course/classes/class.ilCourseLMHistory.php';
        ilCourseLMHistory::_deleteUser($a_usr_id);

        include_once './Modules/Course/classes/class.ilCourseParticipants.php';
        ilCourseParticipants::_deleteUser($a_usr_id);

        // Course objectives
        include_once "Modules/Course/classes/Objectives/class.ilLOUserResults.php";
        ilLOUserResults::deleteResultsForUser($a_usr_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isActivated()

static ilObjCourse::_isActivated (   $a_obj_id )

static

Is activated.

Method is in Access class, since it is needed by Access/ListGUI.

Parameters

int	id of user

Returns

boolean

Definition at line 718 of file class.ilObjCourse.php.

References ilObjCourseAccess\_isActivated().

Referenced by ilStartUpGUI\_checkGoto(), and ilObjCourseGUI\executeCommand().

    {
        include_once("./Modules/Course/classes/class.ilObjCourseAccess.php");
        return ilObjCourseAccess::_isActivated($a_obj_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isSubscriptionNotificationEnabled()

static ilObjCourse::_isSubscriptionNotificationEnabled (   $a_course_id )

static

Check if subscription notification is enabled.

public

Parameters

int

course_id

Definition at line 487 of file class.ilObjCourse.php.

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM crs_settings " .
            "WHERE obj_id = " . $ilDB->quote($a_course_id, 'integer') . " " .
            "AND sub_notify = 1";
        $res = $ilDB->query($query);
        return $res->numRows() ? true : false;
    }

_lookupAboStatus()

static ilObjCourse::_lookupAboStatus (   $a_id )

static

Definition at line 603 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjGroupGUI\modifyItemGUI(), ilObjSessionGUI\modifyItemGUI(), and ilObjFolderGUI\modifyItemGUI().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT abo FROM crs_settings WHERE obj_id = " . $ilDB->quote($a_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->abo;
        }
        return false;
    }

Here is the caller graph for this function:

_lookupViewMode()

static ilObjCourse::_lookupViewMode (   $a_id )

static

lookup view mode of container

Parameters

int

$a_id

Returns

mixed int | bool

Definition at line 589 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjCourseGUI\_modifyItemGUI(), ilCourseLP\checkObjectives(), ilCalendarScheduleFilterTimings\enabledCourseTimings(), ilObjFolderGUI\forwardToTimingsView(), ilPortfolioPageGUI\getCoursesOfUser(), and ilObjGroup\translateViewMode().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT view_mode FROM crs_settings WHERE obj_id = " . $ilDB->quote($a_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->view_mode;
        }
        return false;
    }

Here is the caller graph for this function:

_registrationEnabled()

static ilObjCourse::_registrationEnabled (   $a_obj_id )

static

Registration enabled? Method is in Access class, since it is needed by Access/ListGUI.

Parameters

int	id of user

Returns

boolean

Definition at line 730 of file class.ilObjCourse.php.

References ilObjCourseAccess\_registrationEnabled().

Referenced by ilStartUpGUI\_checkGoto(), and ilObjCourseGUI\executeCommand().

    {
        include_once("./Modules/Course/classes/class.ilObjCourseAccess.php");
        return ilObjCourseAccess::_registrationEnabled($a_obj_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addAdditionalSubItemInformation()

ilObjCourse::addAdditionalSubItemInformation

(

&

$a_item_data

)

Add additional information to sub item, e.g.

used in courses for timings information etc.

Definition at line 1927 of file class.ilObjCourse.php.

References ilObjectActivation\addAdditionalSubItemInformation().

    {
        include_once './Services/Object/classes/class.ilObjectActivation.php';
        ilObjectActivation::addAdditionalSubItemInformation($a_item_data);
    }

Here is the call graph for this function:

allowAbo()

ilObjCourse::allowAbo

(

)

Definition at line 737 of file class.ilObjCourse.php.

    {
        return $this->ABO == $this->ABO_ENABLED;
    }

appendMessage()

ilObjCourse::appendMessage

(

$a_message

)

Definition at line 685 of file class.ilObjCourse.php.

References getMessage().

Referenced by validate().

    {
        if ($this->getMessage()) {
            $this->message .= "<br /> ";
        }
        $this->message .= $a_message;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkLPStatusSync()

ilObjCourse::checkLPStatusSync

(

$a_member_id

)

sync course status from lp

as lp data is not deleted on course exit new members may already have lp completed

Parameters

int

$a_member_id

Definition at line 2220 of file class.ilObjCourse.php.

References ilObjUserTracking\_enabledLearningProgress(), ilLPStatus\_lookupStatus(), ilObject\getId(), getMembersObject(), getStatusDetermination(), ilLPStatus\LP_STATUS_COMPLETED_NUM, and STATUS_DETERMINATION_LP.

Referenced by handleAutoFill().

    {
        // #11113
        include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
        if (ilObjUserTracking::_enabledLearningProgress() &&
            $this->getStatusDetermination() == ilObjCourse::STATUS_DETERMINATION_LP) {
            include_once("Services/Tracking/classes/class.ilLPStatus.php");
            // #13811 - we need to suppress creation if status entry
            $has_completed = (ilLPStatus::_lookupStatus($this->getId(), $a_member_id, false) == ilLPStatus::LP_STATUS_COMPLETED_NUM);
            $this->getMembersObject()->updatePassed($a_member_id, $has_completed, false, true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneAutoGeneratedRoles()

ilObjCourse::cloneAutoGeneratedRoles

(

$new_obj

)

Clone automatic genrated roles (permissions and template permissions)

public

Parameters

object

new course object

Definition at line 1094 of file class.ilObjCourse.php.

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, getDefaultAdminRole(), getDefaultMemberRole(), getDefaultTutorRole(), and ilObject\getRefId().

Referenced by cloneObject().

    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
        
        $admin = $this->getDefaultAdminRole();
        $new_admin = $new_obj->getDefaultAdminRole();
        
        if (!$admin || !$new_admin || !$this->getRefId() || !$new_obj->getRefId()) {
            $ilLog->write(__METHOD__ . ' : Error cloning auto generated role: il_crs_admin');
        }
        $rbacadmin->copyRolePermissions($admin, $this->getRefId(), $new_obj->getRefId(), $new_admin, true);
        $ilLog->write(__METHOD__ . ' : Finished copying of role crs_admin.');
        
        $tutor = $this->getDefaultTutorRole();
        $new_tutor = $new_obj->getDefaultTutorRole();
        if (!$tutor || !$new_tutor) {
            $ilLog->write(__METHOD__ . ' : Error cloning auto generated role: il_crs_tutor');
        }
        $rbacadmin->copyRolePermissions($tutor, $this->getRefId(), $new_obj->getRefId(), $new_tutor, true);
        $ilLog->write(__METHOD__ . ' : Finished copying of role crs_tutor.');
        
        $member = $this->getDefaultMemberRole();
        $new_member = $new_obj->getDefaultMemberRole();
        if (!$member || !$new_member) {
            $ilLog->write(__METHOD__ . ' : Error cloning auto generated role: il_crs_member');
        }
        $rbacadmin->copyRolePermissions($member, $this->getRefId(), $new_obj->getRefId(), $new_member, true);
        $ilLog->write(__METHOD__ . ' : Finished copying of role crs_member.');
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneDependencies()

ilObjCourse::cloneDependencies	(		$a_target_id,
			$a_copy_id
	)

Clone object dependencies (start objects, preconditions)

public

Parameters

int	target ref id of new course
int	copy id

Definition at line 1055 of file class.ilObjCourse.php.

References ilObjCourseGrouping\_getGroupings(), ilObject\_lookupObjId(), ilObjectActivation\cloneDependencies(), ilLOSettings\cloneSettings(), ilObject\getId(), ilLoggerFactory\getLogger(), and ilObject\getRefId().

    {
        parent::cloneDependencies($a_target_id, $a_copy_id);
        
        // Clone course start objects
        include_once('Services/Container/classes/class.ilContainerStartObjects.php');
        $start = new ilContainerStartObjects($this->getRefId(), $this->getId());
        $start->cloneDependencies($a_target_id, $a_copy_id);

        // Clone course item settings
        include_once('Services/Object/classes/class.ilObjectActivation.php');
        ilObjectActivation::cloneDependencies($this->getRefId(), $a_target_id, $a_copy_id);
        
        // clone objective settings
        include_once './Modules/Course/classes/Objectives/class.ilLOSettings.php';
        ilLOSettings::cloneSettings($a_copy_id, $this->getId(), ilObject::_lookupObjId($a_target_id));

        // Clone course learning objectives
        include_once('Modules/Course/classes/class.ilCourseObjective.php');
        $crs_objective = new ilCourseObjective($this);
        $crs_objective->ilClone($a_target_id, $a_copy_id);
        
        // clone membership limitation
        foreach (\ilObjCourseGrouping::_getGroupings($this->getId()) as $grouping_id) {
            \ilLoggerFactory::getLogger('crs')->info('Handling grouping id: ' . $grouping_id);
            $grouping = new \ilObjCourseGrouping($grouping_id);
            $grouping->cloneGrouping($a_target_id, $a_copy_id);
        }

        return true;
    }

Here is the call graph for this function:

cloneObject()

ilObjCourse::cloneObject	(		$a_target_id,
			$a_copy_id = 0,
			$a_omit_tree = false
	)

Clone course (no member data)

public

Parameters

int	target ref_id
int	copy id

Definition at line 978 of file class.ilObjCourse.php.

References $DIC, $ilDB, $ilUser, ilCourseDefinedFieldDefinition\_clone(), ilCourseFile\_cloneFiles(), ilCopyWizardOptions\_getInstance(), cloneAutoGeneratedRoles(), ilObject\cloneMetaData(), cloneSettings(), ilObject\getId(), ilBadge\getInstancesByParentId(), IL_CRS_ADMIN, and ilObject\setOfflineStatus().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        $certificateLogger = $DIC->logger()->cert();


        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);

        $this->cloneAutoGeneratedRoles($new_obj);
        $this->cloneMetaData($new_obj);

        // Assign admin
        $new_obj->getMemberObject()->add($ilUser->getId(), IL_CRS_ADMIN);
        // cognos-blu-patch: begin
        $new_obj->getMemberObject()->updateContact($ilUser->getId(), 1);
        // cognos-blu-patch: end
        
            
        // #14596
        $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
        if ($cwo->isRootNode($this->getRefId())) {
            $this->setOfflineStatus(true);
        }
        
        // Copy settings
        $this->cloneSettings($new_obj);
    
        // Course Defined Fields
        include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
        ilCourseDefinedFieldDefinition::_clone($this->getId(), $new_obj->getId());
        
        // Clone course files
        include_once('Modules/Course/classes/class.ilCourseFile.php');
        ilCourseFile::_cloneFiles($this->getId(), $new_obj->getId());
        
        // Copy learning progress settings
        include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);
        
        // clone certificate (#11085)
        $pathFactory = new ilCertificatePathFactory();
        $templateRepository = new ilCertificateTemplateRepository($ilDB);

        $cloneAction = new ilCertificateCloneAction(
            $ilDB,
            $pathFactory,
            $templateRepository,
            $DIC->filesystem()->web(),
            $certificateLogger,
            new ilCertificateObjectHelper()
        );
        $cloneAction->cloneCertificate($this, $new_obj);

        $book_service = new ilBookingService();
        $book_service->cloneSettings($this->getId(), $new_obj->getId());

        $badges = ilBadge::getInstancesByParentId($this->getId());
        foreach ($badges as $badge) {
            $badge->clone($new_obj->getId());
        }

        return $new_obj;
    }

Here is the call graph for this function:

cloneSettings()

ilObjCourse::cloneSettings

(

\ilObjCourse

$new_obj

)

Clone entries in settings table.

public

Parameters

ilObjCourse

new course object

Definition at line 1368 of file class.ilObjCourse.php.

References enabledWaitingList(), enableRegistrationAccessCode(), enableSessionLimit(), enableSubscriptionMembershipLimitation(), enableWaitingList(), ilMembershipRegistrationCodeUtils\generateCode(), getAboStatus(), getActivationEnd(), getActivationStart(), getActivationVisibility(), getAutoNotification(), getCancellationEnd(), getContactConsultation(), getContactEmail(), getContactName(), getContactPhone(), getContactResponsibility(), getCourseEnd(), getCourseStart(), getEnableCourseMap(), getImportantInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getNumberOfNextSessions(), getNumberOfPreviousSessions(), ilObject\getOfflineStatus(), getOrderType(), getShowMembers(), getShowMembersExport(), getStatusDetermination(), getSubscriptionEnd(), getSubscriptionLimitationType(), getSubscriptionMaxMembers(), getSubscriptionMinMembers(), getSubscriptionNotify(), getSubscriptionPassword(), getSubscriptionStart(), getSubscriptionType(), getSyllabus(), getTargetGroup(), getTimingMode(), getViewMode(), hasWaitingListAutoFill(), isRegistrationAccessCodeEnabled(), isSessionLimitEnabled(), isSubscriptionMembershipLimited(), setAboStatus(), setActivationEnd(), setActivationStart(), setActivationVisibility(), setAutoNotification(), setCancellationEnd(), setContactConsultation(), setContactEmail(), setContactName(), setContactPhone(), setContactResponsibility(), setCoursePeriod(), setEnableCourseMap(), setImportantInformation(), setLatitude(), setLocationZoom(), setLongitude(), setMailToMembersType(), setNumberOfNextSessions(), setNumberOfPreviousSessions(), ilObject\setOfflineStatus(), ilContainer\setOrderType(), setRegistrationAccessCode(), setShowMembers(), setShowMembersExport(), setStatusDetermination(), setSubscriptionEnd(), setSubscriptionLimitationType(), setSubscriptionMaxMembers(), setSubscriptionMinMembers(), setSubscriptionNotify(), setSubscriptionPassword(), setSubscriptionStart(), setSubscriptionType(), setSyllabus(), setTargetGroup(), setTimingMode(), setViewMode(), setWaitingListAutoFill(), and update().

Referenced by cloneObject().

    {
        $new_obj->setSyllabus($this->getSyllabus());
        $new_obj->setContactName($this->getContactName());
        $new_obj->setContactResponsibility($this->getContactResponsibility());
        $new_obj->setContactPhone($this->getContactPhone());
        $new_obj->setContactEmail($this->getContactEmail());
        $new_obj->setContactConsultation($this->getContactConsultation());
        $new_obj->setOfflineStatus($this->getOfflineStatus()); // #9914
        $new_obj->setActivationStart($this->getActivationStart());
        $new_obj->setActivationEnd($this->getActivationEnd());
        $new_obj->setActivationVisibility($this->getActivationVisibility());
        $new_obj->setSubscriptionLimitationType($this->getSubscriptionLimitationType());
        $new_obj->setSubscriptionStart($this->getSubscriptionStart());
        $new_obj->setSubscriptionEnd($this->getSubscriptionEnd());
        $new_obj->setSubscriptionType($this->getSubscriptionType());
        $new_obj->setSubscriptionPassword($this->getSubscriptionPassword());
        $new_obj->enableSubscriptionMembershipLimitation($this->isSubscriptionMembershipLimited());
        $new_obj->setSubscriptionMaxMembers($this->getSubscriptionMaxMembers());
        $new_obj->setSubscriptionNotify($this->getSubscriptionNotify());
        $new_obj->setViewMode($this->getViewMode());
        $new_obj->setTimingMode($this->getTimingMode());
        $new_obj->setOrderType($this->getOrderType());
        $new_obj->setAboStatus($this->getAboStatus());
        $new_obj->enableWaitingList($this->enabledWaitingList());
        $new_obj->setImportantInformation($this->getImportantInformation());
        $new_obj->setTargetGroup($this->getTargetGroup());
        $new_obj->setShowMembers($this->getShowMembers());
        // patch mem_exp
        $new_obj->setShowMembersExport($this->getShowMembersExport());
        // patch mem_exp
        $new_obj->enableSessionLimit($this->isSessionLimitEnabled());
        $new_obj->setNumberOfPreviousSessions($this->getNumberOfPreviousSessions());
        $new_obj->setNumberOfNextSessions($this->getNumberOfNextSessions());
        $new_obj->setAutoNotification($this->getAutoNotification());
        $new_obj->enableRegistrationAccessCode($this->isRegistrationAccessCodeEnabled());
        include_once './Services/Membership/classes/class.ilMembershipRegistrationCodeUtils.php';
        $new_obj->setRegistrationAccessCode(ilMembershipRegistrationCodeUtils::generateCode());
        $new_obj->setStatusDetermination($this->getStatusDetermination());
        $new_obj->setMailToMembersType($this->getMailToMembersType());
        $new_obj->setCoursePeriod(
            $this->getCourseStart(),
            $this->getCourseEnd()
        );
        $new_obj->setCancellationEnd($this->getCancellationEnd());
        $new_obj->setWaitingListAutoFill($this->hasWaitingListAutoFill());
        $new_obj->setSubscriptionMinMembers($this->getSubscriptionMinMembers());
        
        // #10271
        $new_obj->setEnableCourseMap($this->getEnableCourseMap());
        $new_obj->setLatitude($this->getLatitude());
        $new_obj->setLongitude($this->getLongitude());
        $new_obj->setLocationZoom($this->getLocationZoom());
        
        $new_obj->update();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilObjCourse::create

(

$a_upload = false

)

Definition at line 754 of file class.ilObjCourse.php.

References $DIC, __createDefaultSettings(), ilObject\createMetaData(), ilObject\getId(), and prepareAppointments().

    {
        global $DIC;

        $ilAppEventHandler = $DIC['ilAppEventHandler'];
        
        parent::create($a_upload);

        if (!$a_upload) {
            $this->createMetaData();
        }
        $this->__createDefaultSettings();
        
        $ilAppEventHandler->raise(
            'Modules/Course',
            'create',
            array('object' => $this,
                'obj_id' => $this->getId(),
                'appointments' => $this->prepareAppointments('create'))
        );
    }

Here is the call graph for this function:

delete()

ilObjCourse::delete

(

)

delete course and all related data

public

Returns

boolean true if all object data were removed; false if only a references were removed

Definition at line 1203 of file class.ilObjCourse.php.

References $DIC, __deleteSettings(), ilObjCourseGrouping\_deleteAll(), ilCourseObjective\_deleteAll(), ilParticipants\_deleteAllEntries(), ilCourseDefinedFieldDefinition\_deleteByContainer(), ilCourseFile\_deleteByCourse(), ilObject\deleteMetaData(), ilObject\getId(), and prepareAppointments().

    {
        global $DIC;

        $ilAppEventHandler = $DIC['ilAppEventHandler'];
        
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }

        // delete meta data
        $this->deleteMetaData();

        // put here course specific stuff

        $this->__deleteSettings();

        include_once('Modules/Course/classes/class.ilCourseParticipants.php');
        ilCourseParticipants::_deleteAllEntries($this->getId());

        include_once './Modules/Course/classes/class.ilCourseObjective.php';
        ilCourseObjective::_deleteAll($this->getId());

        include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
        ilObjCourseGrouping::_deleteAll($this->getId());

        include_once './Modules/Course/classes/class.ilCourseFile.php';
        ilCourseFile::_deleteByCourse($this->getId());
        
        include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
        ilCourseDefinedFieldDefinition::_deleteByContainer($this->getId());
        
        $ilAppEventHandler->raise(
            'Modules/Course',
            'delete',
            array('object' => $this,
                'obj_id' => $this->getId(),
                'appointments' => $this->prepareAppointments('delete'))
        );
        
        
        return true;
    }

Here is the call graph for this function:

enabledObjectiveView()

ilObjCourse::enabledObjectiveView

(

)

Definition at line 368 of file class.ilObjCourse.php.

References IL_CRS_VIEW_OBJECTIVE.

Referenced by getOrderType().

    {
        return $this->view_mode == IL_CRS_VIEW_OBJECTIVE;
    }

Here is the caller graph for this function:

enabledWaitingList()

ilObjCourse::enabledWaitingList

(

)

Definition at line 373 of file class.ilObjCourse.php.

Referenced by cloneSettings(), handleAutoFill(), register(), updateSettings(), and validate().

    {
        return (bool) $this->waiting_list;
    }

Here is the caller graph for this function:

enableRegistrationAccessCode()

ilObjCourse::enableRegistrationAccessCode

(

$a_status

)

En/disable registration access code.

Parameters

object

$a_status

Returns

Definition at line 211 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->reg_access_code_enabled = $a_status;
    }

Here is the caller graph for this function:

enableSessionLimit()

ilObjCourse::enableSessionLimit

(

$a_status

)

en/disable limited number of sessions

Returns

Parameters

object

$a_status

Definition at line 399 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->session_limit = $a_status;
    }

Here is the caller graph for this function:

enableSubscriptionMembershipLimitation()

ilObjCourse::enableSubscriptionMembershipLimitation

(

$a_status

)

enable max members

public

Parameters

bool

status

Returns

Definition at line 416 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->subscription_membership_limitation = $a_status;
    }

Here is the caller graph for this function:

enableWaitingList()

ilObjCourse::enableWaitingList

(

$a_status

)

Definition at line 378 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->waiting_list = (bool) $a_status;
    }

Here is the caller graph for this function:

findCoursesWithNotEnoughMembers()

static ilObjCourse::findCoursesWithNotEnoughMembers ( )

static

Minimum members check type $ilDB.

Returns

array

Definition at line 2321 of file class.ilObjCourse.php.

References $GLOBALS, $ilDB, $res, ilContainer\$tree, ilObject\_getAllReferences(), IL_CAL_DAY, and IL_CAL_UNIX.

Referenced by ilMembershipCronMinMembers\getCourses().

    {
        $ilDB = $GLOBALS['DIC']->database();
        $tree = $GLOBALS['DIC']->repositoryTree();
        
        $res = array();

        $before = new ilDateTime(time(), IL_CAL_UNIX);
        $before->increment(IL_CAL_DAY, -1);
        $now = $before->get(IL_CAL_UNIX);

        include_once "Modules/Course/classes/class.ilCourseParticipants.php";
        
        $set = $ilDB->query("SELECT obj_id, min_members" .
            " FROM crs_settings" .
            " WHERE min_members > " . $ilDB->quote(0, "integer") .
            " AND sub_mem_limit = " . $ilDB->quote(1, "integer") . // #17206
            " AND ((leave_end IS NOT NULL" .
                " AND leave_end < " . $ilDB->quote($now, "text") . ")" .
                " OR (leave_end IS NULL" .
                " AND sub_end IS NOT NULL" .
                " AND sub_end < " . $ilDB->quote($now, "text") . "))" .
            " AND (period_start IS NULL OR period_start > " . $ilDB->quote($now, "integer") . ")");
        while ($row = $ilDB->fetchAssoc($set)) {
            $refs = ilObject::_getAllReferences($row['obj_id']);
            $ref = end($refs);
            
            if ($tree->isDeleted($ref)) {
                continue;
            }
            
            $part = new ilCourseParticipants($row["obj_id"]);
            $reci = $part->getNotificationRecipients();
            if (sizeof($reci)) {
                $missing = (int) $row["min_members"] - $part->getCountMembers();
                if ($missing > 0) {
                    $res[$row["obj_id"]] = array($missing, $reci);
                }
            }
        }
        
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAboStatus()

ilObjCourse::getAboStatus

(

)

Definition at line 645 of file class.ilObjCourse.php.

Referenced by cloneSettings(), and updateSettings().

    {
        return $this->abo;
    }

Here is the caller graph for this function:

getActivationEnd()

ilObjCourse::getActivationEnd

(

)

Definition at line 306 of file class.ilObjCourse.php.

Referenced by cloneSettings(), getActivationUnlimitedStatus(), isActivated(), prepareAppointments(), and updateSettings().

    {
        return $this->activation_end;
    }

Here is the caller graph for this function:

getActivationStart()

ilObjCourse::getActivationStart

(

)

Definition at line 298 of file class.ilObjCourse.php.

Referenced by cloneSettings(), getActivationUnlimitedStatus(), isActivated(), prepareAppointments(), and updateSettings().

    {
        return $this->activation_start;
    }

Here is the caller graph for this function:

getActivationUnlimitedStatus()

ilObjCourse::getActivationUnlimitedStatus

(

)

get activation unlimited no start or no end

Returns

bool

Definition at line 294 of file class.ilObjCourse.php.

References getActivationEnd(), and getActivationStart().

Referenced by isActivated(), and prepareAppointments().

    {
        return !$this->getActivationStart() || !$this->getActivationEnd();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActivationVisibility()

ilObjCourse::getActivationVisibility

(

)

Definition at line 318 of file class.ilObjCourse.php.

Referenced by cloneSettings(), and updateSettings().

    {
        return $this->activation_visibility;
    }

Here is the caller graph for this function:

getArchiveEnd()

ilObjCourse::getArchiveEnd

(

)

Definition at line 625 of file class.ilObjCourse.php.

    {
        return $this->archive_end ? $this->archive_end : mktime(0, 0, 0, 12, 12, date("Y", time()) + 2);
    }

getArchiveStart()

ilObjCourse::getArchiveStart

(

)

Definition at line 617 of file class.ilObjCourse.php.

    {
        return $this->archive_start ? $this->archive_start : time();
    }

getArchiveType()

ilObjCourse::getArchiveType

(

)

Definition at line 633 of file class.ilObjCourse.php.

References IL_CRS_ARCHIVE_DOWNLOAD, and IL_CRS_ARCHIVE_NONE.

    {
        return $this->archive_type ? IL_CRS_ARCHIVE_DOWNLOAD : IL_CRS_ARCHIVE_NONE;
    }

getAutoNotification()

ilObjCourse::getAutoNotification

(

)

Returns automatic notification status from $this->auto_notification.

Returns

boolean

Definition at line 2154 of file class.ilObjCourse.php.

References $auto_notification.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return $this->auto_notification;
    }

Here is the caller graph for this function:

getCancellationEnd()

ilObjCourse::getCancellationEnd

(

)

Definition at line 942 of file class.ilObjCourse.php.

References $leave_end.

Referenced by cloneSettings(), and updateSettings().

    {
        return $this->leave_end;
    }

Here is the caller graph for this function:

getContactConsultation()

ilObjCourse::getContactConsultation

(

)

Definition at line 257 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), hasContactData(), and updateSettings().

    {
        return $this->contact_consultation;
    }

Here is the caller graph for this function:

getContactEmail()

ilObjCourse::getContactEmail

(

)

Definition at line 273 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), hasContactData(), updateSettings(), and validateInfoSettings().

    {
        return $this->contact_email;
    }

Here is the caller graph for this function:

getContactName()

ilObjCourse::getContactName

(

)

Definition at line 249 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), hasContactData(), and updateSettings().

    {
        return $this->contact_name;
    }

Here is the caller graph for this function:

getContactPhone()

ilObjCourse::getContactPhone

(

)

Definition at line 265 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), hasContactData(), and updateSettings().

    {
        return $this->contact_phone;
    }

Here is the caller graph for this function:

getContactResponsibility()

ilObjCourse::getContactResponsibility

(

)

Definition at line 281 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), hasContactData(), and updateSettings().

    {
        return $this->contact_responsibility;
    }

Here is the caller graph for this function:

getCourseEnd()

ilObjCourse::getCourseEnd

(

)

Returns

|null

Definition at line 932 of file class.ilObjCourse.php.

References $crs_end.

Referenced by cloneSettings(), prepareAppointments(), updateSettings(), and validate().

                                   : ?\ilDateTime
    {
        return $this->crs_end;
    }

Here is the caller graph for this function:

getCourseStart()

ilObjCourse::getCourseStart

(

)

Returns

| null

Definition at line 916 of file class.ilObjCourse.php.

References $crs_start.

Referenced by cloneSettings(), prepareAppointments(), updateSettings(), and validate().

                                     : ?\ilDateTime
    {
        return $this->crs_start;
    }

Here is the caller graph for this function:

getCourseStartTimeIndication()

ilObjCourse::getCourseStartTimeIndication

(

)

Returns

bool

Definition at line 899 of file class.ilObjCourse.php.

References $course_start_time_indication.

Referenced by prepareAppointments(), and updateSettings().

                                                   : bool
    {
        return $this->course_start_time_indication;
    }

Here is the caller graph for this function:

getDefaultAdminRole()

ilObjCourse::getDefaultAdminRole

(

)

Definition at line 1867 of file class.ilObjCourse.php.

References __getLocalRoles(), ilObjectFactory\getInstanceByObjId(), and ilObject\getRefId().

Referenced by cloneAutoGeneratedRoles().

    {
        $local_roles = $this->__getLocalRoles();

        foreach ($local_roles as $role_id) {
            if ($tmp_role = &ilObjectFactory::getInstanceByObjId($role_id, false)) {
                if (!strcmp($tmp_role->getTitle(), "il_crs_admin_" . $this->getRefId())) {
                    return $role_id;
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultCourseRoles()

ilObjCourse::getDefaultCourseRoles

(

$a_crs_id = ""

)

get default course roles, returns the defaultlike create roles il_crs_tutor, il_crs_admin and il_crs_member public

Parameters

returns

the obj_ids of course specific roles in an associative array. key=descripiton of the role (i.e. "il_crs_tutor", "il_crs_admin", "il_crs_member". value=obj_id of the role

Definition at line 1779 of file class.ilObjCourse.php.

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, and ilObject\getRefId().

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];

        if (strlen($a_crs_id) > 0) {
            $crs_id = $a_crs_id;
        } else {
            $crs_id = $this->getRefId();
        }

        $role_arr = $rbacreview->getRolesOfRoleFolder($crs_id);

        foreach ($role_arr as $role_id) {
            $role_Obj = &$this->ilias->obj_factory->getInstanceByObjId($role_id);

            $crs_Member = "il_crs_member_" . $crs_id;
            $crs_Admin = "il_crs_admin_" . $crs_id;
            $crs_Tutor = "il_crs_tutor_" . $crs_id;

            if (strcmp($role_Obj->getTitle(), $crs_Member) == 0) {
                $arr_crsDefaultRoles["crs_member_role"] = $role_Obj->getId();
            }

            if (strcmp($role_Obj->getTitle(), $crs_Admin) == 0) {
                $arr_crsDefaultRoles["crs_admin_role"] = $role_Obj->getId();
            }

            if (strcmp($role_Obj->getTitle(), $crs_Tutor) == 0) {
                $arr_crsDefaultRoles["crs_tutor_role"] = $role_Obj->getId();
            }
        }

        return $arr_crsDefaultRoles;
    }

Here is the call graph for this function:

getDefaultMemberRole()

ilObjCourse::getDefaultMemberRole

(

)

Definition at line 1842 of file class.ilObjCourse.php.

References ilObject\$title, __getLocalRoles(), and ilObject\_lookupTitle().

Referenced by cloneAutoGeneratedRoles().

    {
        $local_roles = $this->__getLocalRoles();

        foreach ($local_roles as $role_id) {
            $title = ilObject::_lookupTitle($role_id);
            if (substr($title, 0, 8) == 'il_crs_m') {
                return $role_id;
            }
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultTutorRole()

ilObjCourse::getDefaultTutorRole

(

)

Definition at line 1854 of file class.ilObjCourse.php.

References __getLocalRoles(), ilObjectFactory\getInstanceByObjId(), and ilObject\getRefId().

Referenced by cloneAutoGeneratedRoles().

    {
        $local_roles = $this->__getLocalRoles();

        foreach ($local_roles as $role_id) {
            if ($tmp_role = &ilObjectFactory::getInstanceByObjId($role_id, false)) {
                if (!strcmp($tmp_role->getTitle(), "il_crs_tutor_" . $this->getRefId())) {
                    return $role_id;
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEnableCourseMap()

ilObjCourse::getEnableCourseMap

(

)

Get Enable Course Map.

Returns

boolean Enable Course Map

Definition at line 860 of file class.ilObjCourse.php.

References $enablemap.

Referenced by __createDefaultSettings(), cloneSettings(), getEnableMap(), and updateSettings().

    {
        return $this->enablemap;
    }

Here is the caller graph for this function:

getEnableMap()

ilObjCourse::getEnableMap

(

)

Type independent wrapper.

Returns

type

Definition at line 850 of file class.ilObjCourse.php.

References getEnableCourseMap().

    {
        return $this->getEnableCourseMap();
    }

Here is the call graph for this function:

getImportantInformation()

ilObjCourse::getImportantInformation

(

)

Definition at line 216 of file class.ilObjCourse.php.

Referenced by cloneSettings(), and updateSettings().

    {
        return $this->important;
    }

Here is the caller graph for this function:

getLatitude()

ilObjCourse::getLatitude

(

)

Get Latitude.

Returns

string Latitude

Definition at line 791 of file class.ilObjCourse.php.

References $latitude.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return $this->latitude;
    }

Here is the caller graph for this function:

getLocalCourseRoles()

ilObjCourse::getLocalCourseRoles

(

$a_translate = false

)

get ALL local roles of course, also those created and defined afterwards only fetch data once from database.

info is stored in object variable public

Returns

return array [title|id] of roles...

Definition at line 1740 of file class.ilObjCourse.php.

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, ilObjRole\_getTranslation(), and ilObject\getRefId().

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];

        if (empty($this->local_roles)) {
            $this->local_roles = array();
            $role_arr = $rbacreview->getRolesOfRoleFolder($this->getRefId());

            foreach ($role_arr as $role_id) {
                if ($rbacreview->isAssignable($role_id, $this->getRefId()) == true) {
                    $role_Obj = $this->ilias->obj_factory->getInstanceByObjId($role_id);

                    if ($a_translate) {
                        $role_name = ilObjRole::_getTranslation($role_Obj->getTitle());
                    } else {
                        $role_name = $role_Obj->getTitle();
                    }
                    $this->local_roles[$role_name] = $role_Obj->getId();
                }
            }
        }

        return $this->local_roles;
    }

Here is the call graph for this function:

getLocationZoom()

ilObjCourse::getLocationZoom

(

)

Get LocationZoom.

Returns

int LocationZoom

Definition at line 831 of file class.ilObjCourse.php.

References $locationzoom.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return $this->locationzoom;
    }

Here is the caller graph for this function:

getLongitude()

ilObjCourse::getLongitude

(

)

Get Longitude.

Returns

string Longitude

Definition at line 811 of file class.ilObjCourse.php.

References $longitude.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return $this->longitude;
    }

Here is the caller graph for this function:

getMailToMembersType()

ilObjCourse::getMailToMembersType

(

)

Get mail to members type.

Returns

int

Definition at line 672 of file class.ilObjCourse.php.

References $mail_members.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return $this->mail_members;
    }

Here is the caller graph for this function:

getMemberObject()

ilObjCourse::getMemberObject

(

)

Get course member object.

Returns

ilCourseParticipant

Definition at line 1617 of file class.ilObjCourse.php.

References $member_obj, and initCourseMemberObject().

    {
        if (!$this->member_obj instanceof ilCourseParticipant) {
            $this->initCourseMemberObject();
        }
        return $this->member_obj;
    }

Here is the call graph for this function:

getMembersObject()

ilObjCourse::getMembersObject

(

)

Returns

ilCourseParticipants

Definition at line 1628 of file class.ilObjCourse.php.

References $members_obj, and initCourseMembersObject().

Referenced by checkLPStatusSync(), handleAutoFill(), and syncMembersStatusWithLP().

    {
        if (!$this->members_obj instanceof ilCourseParticipants) {
            $this->initCourseMembersObject();
        }
        return $this->members_obj;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMessage()

ilObjCourse::getMessage

(

)

Definition at line 677 of file class.ilObjCourse.php.

References $message.

Referenced by appendMessage(), and validate().

    {
        return $this->message;
    }

Here is the caller graph for this function:

getNumberOfNextSessions()

ilObjCourse::getNumberOfNextSessions

(

)

Set number of previous sessions.

Returns

Definition at line 454 of file class.ilObjCourse.php.

References $session_next.

Referenced by cloneSettings(), and updateSettings().

    {
        return $this->session_next;
    }

Here is the caller graph for this function:

getNumberOfPreviousSessions()

ilObjCourse::getNumberOfPreviousSessions

(

)

Set number of previous sessions.

Returns

Definition at line 435 of file class.ilObjCourse.php.

References $session_prev.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return $this->session_prev;
    }

Here is the caller graph for this function:

getOrderType()

ilObjCourse::getOrderType

(

)

Definition at line 2233 of file class.ilObjCourse.php.

References enabledObjectiveView(), and ilContainer\SORT_MANUAL.

Referenced by cloneSettings(), and update().

    {
        if ($this->enabledObjectiveView()) {
            return ilContainer::SORT_MANUAL;
        }
        return parent::getOrderType();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRegistrationAccessCode()

ilObjCourse::getRegistrationAccessCode

(

)

get access code

Returns

Definition at line 182 of file class.ilObjCourse.php.

References $reg_access_code.

Referenced by __createDefaultSettings(), and updateSettings().

    {
        return $this->reg_access_code;
    }

Here is the caller graph for this function:

getShowMembers()

ilObjCourse::getShowMembers

(

)

Definition at line 653 of file class.ilObjCourse.php.

Referenced by cloneSettings(), and updateSettings().

    {
        return $this->show_members;
    }

Here is the caller graph for this function:

getShowMembersExport()

ilObjCourse::getShowMembersExport

(

)

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

References $member_export.

Referenced by cloneSettings(), and updateSettings().

    {
        return $this->member_export;
    }

Here is the caller graph for this function:

getStatusDetermination()

ilObjCourse::getStatusDetermination

(

)

Get status determination mode.

Returns

int

Definition at line 2196 of file class.ilObjCourse.php.

References $status_dt.

Referenced by __createDefaultSettings(), checkLPStatusSync(), cloneSettings(), updateSettings(), and validate().

    {
        return $this->status_dt;
    }

Here is the caller graph for this function:

getSubItems()

ilObjCourse::getSubItems	(		$a_admin_panel_enabled = false,
			$a_include_side_block = false,
			$a_get_single = 0,
		\ilContainerUserFilter	$container_user_filter = null
	)

Get subitems of container.

Parameters

bool	$a_admin_panel_enabled,[optional]
bool	$a_include_side_block,[optional]

Returns

array

Definition at line 506 of file class.ilObjCourse.php.

References ilContainerSessionsContentGUI\prepareSessionPresentationLimitation().

      {
        // Caching
        if (is_array($this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block])) {
            return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
        }

        // Results are stored in $this->items
        parent::getSubItems($a_admin_panel_enabled, $a_include_side_block, $a_get_single);
        $this->items = ilContainerSessionsContentGUI::prepareSessionPresentationLimitation(
            $this->items,
            $this,
            (bool) $a_admin_panel_enabled,
            (bool) $a_include_side_block
        );
        return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
    }

Here is the call graph for this function:

getSubscriptionEnd()

ilObjCourse::getSubscriptionEnd

(

)

Definition at line 343 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), inSubscriptionTime(), prepareAppointments(), updateSettings(), and validate().

    {
        return $this->subscription_end;
    }

Here is the caller graph for this function:

getSubscriptionLimitationType()

ilObjCourse::getSubscriptionLimitationType

(

)

Definition at line 323 of file class.ilObjCourse.php.

Referenced by cloneSettings(), prepareAppointments(), register(), updateSettings(), and validate().

    {
        return $this->subscription_limitation_type;
    }

Here is the caller graph for this function:

getSubscriptionMaxMembers()

ilObjCourse::getSubscriptionMaxMembers

(

)

Definition at line 470 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), handleAutoFill(), register(), updateSettings(), and validate().

    {
        return $this->subscription_max_members;
    }

Here is the caller graph for this function:

getSubscriptionMinMembers()

ilObjCourse::getSubscriptionMinMembers

(

)

Definition at line 955 of file class.ilObjCourse.php.

References $min_members.

Referenced by cloneSettings(), updateSettings(), and validate().

    {
        return $this->min_members;
    }

Here is the caller graph for this function:

getSubscriptionNotify()

ilObjCourse::getSubscriptionNotify

(

)

Definition at line 528 of file class.ilObjCourse.php.

Referenced by cloneSettings(), and updateSettings().

    {
        return true;
        return $this->subscription_notify ? true : false;
    }

Here is the caller graph for this function:

getSubscriptionPassword()

ilObjCourse::getSubscriptionPassword

(

)

Definition at line 360 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), updateSettings(), and validate().

    {
        return $this->subscription_password;
    }

Here is the caller graph for this function:

getSubscriptionStart()

ilObjCourse::getSubscriptionStart

(

)

Definition at line 335 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), inSubscriptionTime(), prepareAppointments(), updateSettings(), and validate().

    {
        return $this->subscription_start;
    }

Here is the caller graph for this function:

getSubscriptionType()

ilObjCourse::getSubscriptionType

(

)

Definition at line 351 of file class.ilObjCourse.php.

References IL_CRS_SUBSCRIPTION_DIRECT.

Referenced by cloneSettings(), updateSettings(), and validate().

    {
        return $this->subscription_type ? $this->subscription_type : IL_CRS_SUBSCRIPTION_DIRECT;
        #return $this->subscription_type ? $this->subscription_type : $this->SUBSCRIPTION_DEACTIVATED;
    }

Here is the caller graph for this function:

getSubscriptionUnlimitedStatus()

ilObjCourse::getSubscriptionUnlimitedStatus

(

)

Definition at line 331 of file class.ilObjCourse.php.

References IL_CRS_SUBSCRIPTION_UNLIMITED.

Referenced by inSubscriptionTime().

    {
        return $this->subscription_limitation_type == IL_CRS_SUBSCRIPTION_UNLIMITED;
    }

Here is the caller graph for this function:

getSyllabus()

ilObjCourse::getSyllabus

(

)

Definition at line 224 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return $this->syllabus;
    }

Here is the caller graph for this function:

getTargetGroup()

ilObjCourse::getTargetGroup

(

)

Returns

string|null

Definition at line 236 of file class.ilObjCourse.php.

References $target_group.

Referenced by cloneSettings(), and updateSettings().

                                     : ?string
    {
        return $this->target_group;
    }

Here is the caller graph for this function:

getTimingMode()

ilObjCourse::getTimingMode

(

)

Returns

int

Definition at line 578 of file class.ilObjCourse.php.

References $timing_mode.

Referenced by cloneSettings(), and updateSettings().

    {
        return $this->timing_mode;
    }

Here is the caller graph for this function:

getViewMode()

ilObjCourse::getViewMode

(

)

Definition at line 542 of file class.ilObjCourse.php.

Referenced by cloneSettings(), prepareAppointments(), and updateSettings().

    {
        return $this->view_mode;
    }

Here is the caller graph for this function:

handleAutoFill()

ilObjCourse::handleAutoFill

(

)

Handle course auto fill.

Definition at line 2244 of file class.ilObjCourse.php.

References checkLPStatusSync(), enabledWaitingList(), ilObject\getId(), ilObjectFactory\getInstanceByObjId(), getMembersObject(), ilObject\getRefId(), getSubscriptionMaxMembers(), ilObject\getTitle(), hasWaitingListAutoFill(), IL_CRS_MEMBER, and ilParticipants\lookupNumberOfMembers().

    {
        if (
            !$this->enabledWaitingList() or
            !$this->hasWaitingListAutoFill()
        ) {
            $this->course_logger->debug('Waiting list or auto fill disabled.');
            return;
        }
        
        $max = $this->getSubscriptionMaxMembers();
        $now = ilCourseParticipants::lookupNumberOfMembers($this->getRefId());

        $this->course_logger->debug('Max members: ' . $max);
        $this->course_logger->debug('Current members: ' . $now);
        
        if ($max <= $now) {
            return;
        }

        // see assignFromWaitingListObject()
        include_once('./Modules/Course/classes/class.ilCourseWaitingList.php');
        $waiting_list = new ilCourseWaitingList($this->getId());

        foreach ($waiting_list->getUserIds() as $user_id) {
            if (!$tmp_obj = ilObjectFactory::getInstanceByObjId($user_id, false)) {
                $this->course_logger->warning('Cannot create user instance for id: ' . $user_id);
                continue;
            }
            if ($this->getMembersObject()->isAssigned($user_id)) {
                $this->course_logger->warning('User is already assigned to course. uid: ' . $user_id . ' course_id: ' . $this->getRefId());
                continue;
            }
            $this->getMembersObject()->add($user_id, IL_CRS_MEMBER);
            $this->getMembersObject()->sendNotification($this->getMembersObject()->NOTIFY_ACCEPT_USER, $user_id, true);
            $waiting_list->removeFromList($user_id);
            $this->checkLPStatusSync($user_id);
            
            $this->course_logger->info('Assigned user from waiting list to course: ' . $this->getTitle());
            $now++;
            if ($now >= $max) {
                break;
            }
        }
    }

Here is the call graph for this function:

hasContactData()

ilObjCourse::hasContactData

(

)

Definition at line 1187 of file class.ilObjCourse.php.

References getContactConsultation(), getContactEmail(), getContactName(), getContactPhone(), and getContactResponsibility().

    {
        return strlen($this->getContactName()) or
            strlen($this->getContactResponsibility()) or
            strlen($this->getContactEmail()) or
            strlen($this->getContactPhone()) or
            strlen($this->getContactConsultation());
    }

Here is the call graph for this function:

hasWaitingListAutoFill()

ilObjCourse::hasWaitingListAutoFill

(

)

Definition at line 965 of file class.ilObjCourse.php.

References $auto_fill_from_waiting.

Referenced by cloneSettings(), handleAutoFill(), and updateSettings().

    {
        return (bool) $this->auto_fill_from_waiting;
    }

Here is the caller graph for this function:

initCourseMemberObject()

ilObjCourse::initCourseMemberObject ( )

protected

Init course member object ilObjUser $ilUser.

Returns

<type>

Definition at line 1586 of file class.ilObjCourse.php.

References $DIC, $ilUser, ilCourseParticipant\_getInstanceByObjId(), and ilObject\getId().

Referenced by getMemberObject().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];

        include_once "./Modules/Course/classes/class.ilCourseParticipant.php";
        $this->member_obj = ilCourseParticipant::_getInstanceByObjId($this->getId(), $ilUser->getId());
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCourseMembersObject()

ilObjCourse::initCourseMembersObject ( )

protected

Init course member object ilObjUser $ilUser.

Returns

<type>

Definition at line 1602 of file class.ilObjCourse.php.

References $DIC, $ilUser, ilCourseParticipants\_getInstanceByObjId(), and ilObject\getId().

Referenced by getMembersObject().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];

        include_once "./Modules/Course/classes/class.ilCourseParticipants.php";
        $this->members_obj = ilCourseParticipants::_getInstanceByObjId($this->getId());
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initDefaultRoles()

ilObjCourse::initDefaultRoles

(

)

Definition at line 1639 of file class.ilObjCourse.php.

References $DIC, $ilDB, ilObject\$rbacadmin, ilObject\$rbacreview, ilObjRole\createDefaultRole(), ilObject\getId(), and ilObject\getRefId().

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
        $ilDB = $DIC['ilDB'];

        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        $role = ilObjRole::createDefaultRole(
            'il_crs_admin_' . $this->getRefId(),
            "Admin of crs obj_no." . $this->getId(),
            'il_crs_admin',
            $this->getRefId()
        );
        $role = ilObjRole::createDefaultRole(
            'il_crs_tutor_' . $this->getRefId(),
            "Tutor of crs obj_no." . $this->getId(),
            'il_crs_tutor',
            $this->getRefId()
        );
        $role = ilObjRole::createDefaultRole(
            'il_crs_member_' . $this->getRefId(),
            "Member of crs obj_no." . $this->getId(),
            'il_crs_member',
            $this->getRefId()
        );
        
        return array();
    }

Here is the call graph for this function:

initWaitingList()

ilObjCourse::initWaitingList

(

)

Definition at line 1570 of file class.ilObjCourse.php.

References ilObject\getId().

    {
        include_once "./Modules/Course/classes/class.ilCourseWaitingList.php";

        if (!is_object($this->waiting_list_obj)) {
            $this->waiting_list_obj = new ilCourseWaitingList($this->getId());
        }
        return true;
    }

Here is the call graph for this function:

inSubscriptionTime()

ilObjCourse::inSubscriptionTime

(

)

Definition at line 383 of file class.ilObjCourse.php.

References getSubscriptionEnd(), getSubscriptionStart(), and getSubscriptionUnlimitedStatus().

Referenced by register().

    {
        if ($this->getSubscriptionUnlimitedStatus()) {
            return true;
        }
        if (time() > $this->getSubscriptionStart() and time() < $this->getSubscriptionEnd()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isActivated()

ilObjCourse::isActivated

(

)

Check if course is active and not offline.

Returns

bool

Definition at line 697 of file class.ilObjCourse.php.

References getActivationEnd(), getActivationStart(), getActivationUnlimitedStatus(), and ilObject\getOfflineStatus().

    {
        if ($this->getOfflineStatus()) {
            return false;
        }
        if ($this->getActivationUnlimitedStatus()) {
            return true;
        }
        if (time() < $this->getActivationStart() or
           time() > $this->getActivationEnd()) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

isRegistrationAccessCodeEnabled()

ilObjCourse::isRegistrationAccessCodeEnabled

(

)

Check if access code is enabled.

Returns

Definition at line 201 of file class.ilObjCourse.php.

References $reg_access_code_enabled.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return (bool) $this->reg_access_code_enabled;
    }

Here is the caller graph for this function:

isSessionLimitEnabled()

ilObjCourse::isSessionLimitEnabled

(

)

Definition at line 404 of file class.ilObjCourse.php.

References $session_limit.

Referenced by __createDefaultSettings(), cloneSettings(), and updateSettings().

    {
        return (bool) $this->session_limit;
    }

Here is the caller graph for this function:

isSubscriptionMembershipLimited()

ilObjCourse::isSubscriptionMembershipLimited

(

)

is membership limited

public

Parameters

Definition at line 465 of file class.ilObjCourse.php.

Referenced by cloneSettings(), register(), updateSettings(), and validate().

    {
        return (bool) $this->subscription_membership_limitation;
    }

Here is the caller graph for this function:

lookupCourseNonMemberTemplatesId()

static ilObjCourse::lookupCourseNonMemberTemplatesId ( )

static

Lookup course non member id.

Returns

int

Definition at line 1721 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilRbacAdmin\adjustMovedObjectPermissions().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT obj_id FROM object_data WHERE type = ' . $ilDB->quote('rolt', 'text') . ' AND title = ' . $ilDB->quote('il_crs_non_member', 'text');
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
        
        return isset($row['obj_id']) ? $row['obj_id'] : 0;
    }

Here is the caller graph for this function:

lookupObjectsByCode()

static ilObjCourse::lookupObjectsByCode (   $a_code )

static

See also

interface.ilMembershipRegistrationCodes

Returns

array obj ids

Implements ilMembershipRegistrationCodes.

Definition at line 2041 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMembershipRegistrationCodeUtils\lookupObjectsByCode().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT obj_id FROM crs_settings " .
            "WHERE reg_ac_enabled = " . $ilDB->quote(1, 'integer') . " " .
            "AND reg_ac = " . $ilDB->quote($a_code, 'text');
        $res = $ilDB->query($query);
        
        $obj_ids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_ids[] = $row->obj_id;
        }
        return $obj_ids;
    }

Here is the caller graph for this function:

lookupShowMembersEnabled()

static ilObjCourse::lookupShowMembersEnabled (   $a_obj_id )

static

Check if show member is enabled.

Parameters

int

$a_obj_id

Returns

bool

Definition at line 157 of file class.ilObjCourse.php.

References $GLOBALS, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilAwarenessUserProviderCurrentCourse\getInitialUserSet(), and ilParticipants\hasParticipantListAccess().

    {
        $query = 'SELECT show_members FROM crs_settings ' .
                'WHERE obj_id = ' . $GLOBALS['DIC']['ilDB']->quote($a_obj_id, 'integer');
        $res = $GLOBALS['DIC']['ilDB']->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (bool) $row->show_members;
        }
        return false;
    }

Here is the caller graph for this function:

lookupTimingMode()

static ilObjCourse::lookupTimingMode (   $a_obj_id )

static

Parameters

$a_obj_id

Returns

int

Definition at line 551 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ilCourseConstants\IL_CRS_VIEW_TIMING_ABSOLUTE.

Referenced by ilCalendarScheduleFilterTimings\addCustomEvents(), ilCourseAppEventListener\initializeTimings(), ilObjectActivationGUI\initTimingMode(), and ilCalendarScheduleFilterTimings\modifyEvent().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT timing_mode FROM crs_settings ' .
            'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
        $res = $ilDB->query($query);

        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->timing_mode;
        }
        return ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE;
    }

Here is the caller graph for this function:

mayLeave()

static ilObjCourse::mayLeave (   $a_course_id,   $a_user_id = null, &  $a_date = null  )

static

Definition at line 2290 of file class.ilObjCourse.php.

References $DIC, $ilDB, $ilUser, and IL_CAL_DATE.

Referenced by ilObjCourseAccess\_checkAccess().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];
        
        if (!$a_user_id) {
            $a_user_id = $ilUser->getId();
        }
        
        $set = $ilDB->query("SELECT leave_end" .
            " FROM crs_settings" .
            " WHERE obj_id = " . $ilDB->quote($a_course_id, "integer"));
        $row = $ilDB->fetchAssoc($set);
        if ($row && $row["leave_end"]) {
            // timestamp to date
            $limit = date("Ymd", $row["leave_end"]);
            if ($limit < date("Ymd")) {
                $a_date = new ilDate(date("Y-m-d", $row["leave_end"]), IL_CAL_DATE);
                return false;
            }
        }
        return true;
    }

Here is the caller graph for this function:

MDUpdateListener()

ilObjCourse::MDUpdateListener

(

$a_element

)

Overwriten Metadata update listener for ECS functionalities.

public

Definition at line 1902 of file class.ilObjCourse.php.

References $DIC.

    {
        global $DIC;

        $ilLog = $DIC['ilLog'];

        parent::MDUpdateListener($a_element);

        switch ($a_element) {
            case 'General':
                // Update ecs content
                include_once 'Modules/Course/classes/class.ilECSCourseSettings.php';
                $ecs = new ilECSCourseSettings($this);
                $ecs->handleContentUpdate();
                break;
                
            default:
                return true;
        }
    }

prepareAppointments()

ilObjCourse::prepareAppointments (   $a_mode = 'create' )

protected

Prepare calendar appointments.

protected

Parameters

string

mode UPDATE|CREATE|DELETE

Returns

Definition at line 1940 of file class.ilObjCourse.php.

References $app, getActivationEnd(), getActivationStart(), getActivationUnlimitedStatus(), getCourseEnd(), getCourseStart(), getCourseStartTimeIndication(), ilObject\getLongDescription(), ilObject\getOfflineStatus(), ilObject\getRefId(), getSubscriptionEnd(), getSubscriptionLimitationType(), getSubscriptionStart(), ilObjectActivation\getTimingsItems(), ilObject\getTitle(), getViewMode(), IL_CAL_TRANSLATION_SYSTEM, IL_CAL_UNIX, IL_CRS_SUBSCRIPTION_LIMITED, ilCourseConstants\IL_CRS_VIEW_TIMING, and ilObjectActivation\TIMINGS_PRESETTING.

Referenced by create(), delete(), and update().

    {
        include_once('./Services/Calendar/classes/class.ilCalendarAppointmentTemplate.php');
        include_once('./Services/Calendar/classes/class.ilDateTime.php');
        
        switch ($a_mode) {
            case 'create':
            case 'update':
                if (!$this->getActivationUnlimitedStatus() and !$this->getOfflineStatus()) {
                    $app = new ilCalendarAppointmentTemplate(self::CAL_ACTIVATION_START);
                    $app->setTitle($this->getTitle());
                    $app->setSubtitle('crs_cal_activation_start');
                    $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                    $app->setDescription($this->getLongDescription());
                    $app->setStart(new ilDateTime($this->getActivationStart(), IL_CAL_UNIX));
                    $apps[] = $app;

                    $app = new ilCalendarAppointmentTemplate(self::CAL_ACTIVATION_END);
                    $app->setTitle($this->getTitle());
                    $app->setSubtitle('crs_cal_activation_end');
                    $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                    $app->setDescription($this->getLongDescription());
                    $app->setStart(new ilDateTime($this->getActivationEnd(), IL_CAL_UNIX));
                    $apps[] = $app;
                }
                if ($this->getSubscriptionLimitationType() == IL_CRS_SUBSCRIPTION_LIMITED) {
                    $app = new ilCalendarAppointmentTemplate(self::CAL_REG_START);
                    $app->setTitle($this->getTitle());
                    $app->setSubtitle('crs_cal_reg_start');
                    $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                    $app->setDescription($this->getLongDescription());
                    $app->setStart(new ilDateTime($this->getSubscriptionStart(), IL_CAL_UNIX));
                    $apps[] = $app;

                    $app = new ilCalendarAppointmentTemplate(self::CAL_REG_END);
                    $app->setTitle($this->getTitle());
                    $app->setSubtitle('crs_cal_reg_end');
                    $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                    $app->setDescription($this->getLongDescription());
                    $app->setStart(new ilDateTime($this->getSubscriptionEnd(), IL_CAL_UNIX));
                    $apps[] = $app;
                }
                if ($this->getCourseStart() && $this->getCourseEnd()) {
                    $app = new ilCalendarAppointmentTemplate(self::CAL_COURSE_START);
                    $app->setTitle($this->getTitle());
                    $app->setSubtitle('crs_cal_start');
                    $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                    $app->setDescription($this->getLongDescription());
                    $app->setStart($this->getCourseStart());
                    $app->setFullday(!$this->getCourseStartTimeIndication());
                    $apps[] = $app;

                    $app = new ilCalendarAppointmentTemplate(self::CAL_COURSE_END);
                    $app->setTitle($this->getTitle());
                    $app->setSubtitle('crs_cal_end');
                    $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                    $app->setDescription($this->getLongDescription());
                    $app->setStart($this->getCourseEnd());
                    $app->setFullday(!$this->getCourseStartTimeIndication());
                    $apps[] = $app;
                }
                if (
                    $this->getViewMode() == ilCourseConstants::IL_CRS_VIEW_TIMING
                ) {
                    $active = ilObjectActivation::getTimingsItems($this->getRefId());
                    foreach ($active as $null => $item) {
                        if ($item['timing_type'] == ilObjectActivation::TIMINGS_PRESETTING) {
                            // create calendar entry for fixed types
                            $app = new ilCalendarAppointmentTemplate(self::CAL_COURSE_TIMING_START);
                            $app->setContextInfo($item['ref_id']);
                            $app->setTitle($item['title']);
                            $app->setSubtitle('cal_crs_timing_start');
                            $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                            $app->setStart(new ilDate($item['suggestion_start'], IL_CAL_UNIX));
                            $app->setFullday(true);
                            $apps[] = $app;

                            $app = new ilCalendarAppointmentTemplate(self::CAL_COURSE_TIMING_END);
                            $app->setContextInfo($item['ref_id']);
                            $app->setTitle($item['title']);
                            $app->setSubtitle('cal_crs_timing_end');
                            $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                            $app->setStart(new ilDate($item['suggestion_end'], IL_CAL_UNIX));
                            $app->setFullday(true);
                            $apps[] = $app;
                        }
                    }
                }
                return $apps ? $apps : array();
                
            case 'delete':
                // Nothing to do: The category and all assigned appointments will be deleted.
                return array();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilObjCourse::read

(

)

Definition at line 745 of file class.ilObjCourse.php.

References __readSettings(), ilContainerSortingSettings\_lookupSortMode(), ilObject\getId(), and ilContainer\setOrderType().

    {
        parent::read();

        include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
        $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));

        $this->__readSettings();
    }

Here is the call graph for this function:

register()

ilObjCourse::register	(		$a_user_id,
			$a_role = ilCourseConstants::CRS_MEMBER,
			$a_force_registration = false
	)

See also

ilMembershipRegistrationCodes::register()

Parameters

int	user_id
int	role
bool	force registration and do not check registration constraints.

Exceptions

ilMembershipRegistrationException

Definition at line 2066 of file class.ilObjCourse.php.

References $DIC, ilContainer\$tree, ilCourseParticipants\_getInstanceByObjId(), ilObjCourseAccess\_isActivated(), ilObjCourseAccess\_isOffline(), ilObjCourseAccess\_usingRegistrationCode(), ilMembershipRegistrationException\ADDED_TO_WAITINGLIST, ilForumNotification\checkForumsExistsInsert(), enabledWaitingList(), ilObject\getId(), ilObject\getRefId(), getSubscriptionLimitationType(), getSubscriptionMaxMembers(), IL_CRS_SUBSCRIPTION_DEACTIVATED, IL_CRS_SUBSCRIPTION_LIMITED, inSubscriptionTime(), isSubscriptionMembershipLimited(), ilMembershipRegistrationException\OBJECT_IS_FULL, ilMembershipRegistrationException\OUT_OF_REGISTRATION_PERIOD, ilMembershipRegistrationException\REGISTRATION_CODE_DISABLED, ilMembershipRegistrationException\REGISTRATION_INVALID_AVAILABILITY, and ilMembershipRegistrationException\REGISTRATION_INVALID_OFFLINE.

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $tree = $DIC['tree'];
        include_once './Services/Membership/exceptions/class.ilMembershipRegistrationException.php';
        include_once "./Modules/Course/classes/class.ilCourseParticipants.php";
        $part = ilCourseParticipants::_getInstanceByObjId($this->getId());

        if ($part->isAssigned($a_user_id)) {
            return true;
        }
        
        if (!$a_force_registration) {
            // offline
            if (ilObjCourseAccess::_isOffline($this->getId())) {
                throw new ilMembershipRegistrationException(
                    "Can't register to course, course is offline.",
                    ilMembershipRegistrationException::REGISTRATION_INVALID_OFFLINE
                );
            }
            // activation
            if (!ilObjCourseAccess::_isActivated($this->getId())) {
                throw new ilMembershipRegistrationException(
                    "Can't register to course, course is not activated.",
                    ilMembershipRegistrationException::REGISTRATION_INVALID_AVAILABILITY
                );
            }
            
            if ($this->getSubscriptionLimitationType() == IL_CRS_SUBSCRIPTION_DEACTIVATED) {
                if (!ilObjCourseAccess::_usingRegistrationCode()) {
                    throw new ilMembershipRegistrationException('Cant registrate to course ' . $this->getId() .
                        ', course subscription is deactivated.', ilMembershipRegistrationException::REGISTRATION_CODE_DISABLED);
                }
            }

            // Time Limitation
            if ($this->getSubscriptionLimitationType() == IL_CRS_SUBSCRIPTION_LIMITED) {
                if (!$this->inSubscriptionTime()) {
                    throw new ilMembershipRegistrationException('Cant registrate to course ' . $this->getId() .
                        ', course is out of registration time.', ilMembershipRegistrationException::OUT_OF_REGISTRATION_PERIOD);
                }
            }

            // Max members
            if ($this->isSubscriptionMembershipLimited()) {
                $free = max(0, $this->getSubscriptionMaxMembers() - $part->getCountMembers());
                include_once('./Modules/Course/classes/class.ilCourseWaitingList.php');
                $waiting_list = new ilCourseWaitingList($this->getId());
                if ($this->enabledWaitingList() and (!$free or $waiting_list->getCountUsers())) {
                    $waiting_list->addToList($a_user_id);
                    $this->lng->loadLanguageModule("crs");
                    $info = sprintf(
                        $this->lng->txt('crs_added_to_list'),
                        $waiting_list->getPosition($a_user_id)
                    );
                    include_once('./Modules/Course/classes/class.ilCourseParticipants.php');
                    $participants = ilCourseParticipants::_getInstanceByObjId($this->getId());
                    $participants->sendNotification($participants->NOTIFY_WAITING_LIST, $a_user_id);

                    throw new ilMembershipRegistrationException($info, ilMembershipRegistrationException::ADDED_TO_WAITINGLIST);
                }

                if (!$this->enabledWaitingList() && !$free) {
                    throw new ilMembershipRegistrationException('Cant registrate to course ' . $this->getId() .
                        ', membership is limited.', ilMembershipRegistrationException::OBJECT_IS_FULL);
                }
            }
        }
        
        $part->add($a_user_id, $a_role);
        $part->sendNotification($part->NOTIFY_ACCEPT_USER, $a_user_id);
        $part->sendNotification($part->NOTIFY_ADMINS, $a_user_id);
        
        
        include_once './Modules/Forum/classes/class.ilForumNotification.php';
        ilForumNotification::checkForumsExistsInsert($this->getRefId(), $a_user_id);
        
        return true;
    }

Here is the call graph for this function:

setAboStatus()

ilObjCourse::setAboStatus

(

$a_status

)

Definition at line 641 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->abo = $a_status;
    }

Here is the caller graph for this function:

setActivationEnd()

ilObjCourse::setActivationEnd

(

$a_value

)

Definition at line 310 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->activation_end = $a_value;
    }

Here is the caller graph for this function:

setActivationStart()

ilObjCourse::setActivationStart

(

$a_value

)

Definition at line 302 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->activation_start = $a_value;
    }

Here is the caller graph for this function:

setActivationVisibility()

ilObjCourse::setActivationVisibility

(

$a_value

)

Definition at line 314 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->activation_visibility = (bool) $a_value;
    }

Here is the caller graph for this function:

setArchiveEnd()

ilObjCourse::setArchiveEnd

(

$a_value

)

Definition at line 629 of file class.ilObjCourse.php.

    {
        $this->archive_end = $a_value;
    }

setArchiveStart()

ilObjCourse::setArchiveStart

(

$a_value

)

Definition at line 621 of file class.ilObjCourse.php.

    {
        $this->archive_start = $a_value;
    }

setArchiveType()

ilObjCourse::setArchiveType

(

$a_value

)

Definition at line 637 of file class.ilObjCourse.php.

    {
        $this->archive_type = $a_value;
    }

setAutoNotification()

ilObjCourse::setAutoNotification

(

$value

)

Sets automatic notification status in $this->auto_notification, using given $status.

Parameters

mixed

boolean

Definition at line 2166 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->auto_notification = $value;
    }

Here is the caller graph for this function:

setCancellationEnd()

ilObjCourse::setCancellationEnd

(

ilDate

$a_value = null

)

Definition at line 937 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->leave_end = $a_value;
    }

Here is the caller graph for this function:

setContactConsultation()

ilObjCourse::setContactConsultation

(

$a_value

)

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

Referenced by __readSettings(), and cloneSettings().

    {
        $this->contact_consultation = $a_value;
    }

Here is the caller graph for this function:

setContactEmail()

ilObjCourse::setContactEmail

(

$a_value

)

Definition at line 277 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->contact_email = $a_value;
    }

Here is the caller graph for this function:

setContactName()

ilObjCourse::setContactName

(

$a_cn

)

Definition at line 253 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->contact_name = $a_cn;
    }

Here is the caller graph for this function:

setContactPhone()

ilObjCourse::setContactPhone

(

$a_value

)

Definition at line 269 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->contact_phone = $a_value;
    }

Here is the caller graph for this function:

setContactResponsibility()

ilObjCourse::setContactResponsibility

(

$a_value

)

Definition at line 285 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->contact_responsibility = $a_value;
    }

Here is the caller graph for this function:

setCourseEnd()

ilObjCourse::setCourseEnd ( ilDateTime  $a_value = null )

protected

Parameters

\ilDateTime | null

$a_value

Definition at line 924 of file class.ilObjCourse.php.

Referenced by setCoursePeriod().

    {
        $this->crs_end = $a_value;
    }

Here is the caller graph for this function:

setCoursePeriod()

ilObjCourse::setCoursePeriod	(	\ilDateTime	$start = null,
		\ilDateTime	$end = null
	)

Parameters

\ilDateTime | null	$start
\ilDateTime | null	$end

Exceptions

InvalidArgumentException

Definition at line 870 of file class.ilObjCourse.php.

References setCourseEnd(), setCourseStart(), and toggleCourseStartTimeIndication().

Referenced by __readSettings(), and cloneSettings().

    {
        if (
        ($start instanceof \ilDate && !$end instanceof ilDate) ||
        ($end instanceof \ilDate && !$start instanceof ilDate)
        ) {
            throw new InvalidArgumentException('Different date types not supported.');
        }

        if ($start instanceof \ilDate) {
            $this->toggleCourseStartTimeIndication(false);
        } else {
            $this->toggleCourseStartTimeIndication(true);
        }
        $this->setCourseStart($start);
        $this->setCourseEnd($end);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCourseStart()

ilObjCourse::setCourseStart ( ilDateTime  $a_value = null )

protected

Parameters

\ilDateTime | null

$a_value

Definition at line 908 of file class.ilObjCourse.php.

Referenced by setCoursePeriod().

    {
        $this->crs_start = $a_value;
    }

Here is the caller graph for this function:

setEnableCourseMap()

ilObjCourse::setEnableCourseMap

(

$a_enablemap

)

Set Enable Course Map.

Parameters

boolean

$a_enablemap

Enable Course Map

Definition at line 841 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->enablemap = $a_enablemap;
    }

Here is the caller graph for this function:

setImportantInformation()

ilObjCourse::setImportantInformation

(

$a_info

)

Definition at line 220 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->important = $a_info;
    }

Here is the caller graph for this function:

setLatitude()

ilObjCourse::setLatitude

(

$a_latitude

)

Set Latitude.

Parameters

string

$a_latitude

Latitude

Definition at line 781 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->latitude = $a_latitude;
    }

Here is the caller graph for this function:

setLocationZoom()

ilObjCourse::setLocationZoom

(

$a_locationzoom

)

Set LocationZoom.

Parameters

int

$a_locationzoom

LocationZoom

Definition at line 821 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->locationzoom = $a_locationzoom;
    }

Here is the caller graph for this function:

setLongitude()

ilObjCourse::setLongitude

(

$a_longitude

)

Set Longitude.

Parameters

string

$a_longitude

Longitude

Definition at line 801 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->longitude = $a_longitude;
    }

Here is the caller graph for this function:

setMailToMembersType()

ilObjCourse::setMailToMembersType

(

$a_type

)

Set mail to members type.

See also

ilCourseConstants

Parameters

type

$a_type

Definition at line 663 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->mail_members = $a_type;
    }

Here is the caller graph for this function:

setMessage()

ilObjCourse::setMessage

(

$a_message

)

Definition at line 681 of file class.ilObjCourse.php.

Referenced by validate().

    {
        $this->message = $a_message;
    }

Here is the caller graph for this function:

setNumberOfNextSessions()

ilObjCourse::setNumberOfNextSessions

(

$a_num

)

Set number of previous sessions.

Returns

Parameters

int

$a_num

Definition at line 445 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->session_next = $a_num;
    }

Here is the caller graph for this function:

setNumberOfPreviousSessions()

ilObjCourse::setNumberOfPreviousSessions

(

$a_num

)

Set number of previous sessions.

Returns

Parameters

int

$a_num

Definition at line 426 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->session_prev = $a_num;
    }

Here is the caller graph for this function:

setParentRolePermissions()

ilObjCourse::setParentRolePermissions

(

$a_parent_ref

)

This method is called before "initDefaultRoles".

Therefore now local course roles are created.

Grants permissions on the course object for all parent roles. Each permission is granted by computing the intersection of the template il_crs_non_member and the permission template of the parent role.

Parameters

type

$a_parent_ref

Definition at line 1679 of file class.ilObjCourse.php.

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, __getCrsNonMemberTemplateId(), ilObject\getRefId(), and ROLE_FOLDER_ID.

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
        
        $parent_roles = $rbacreview->getParentRoleIds($a_parent_ref);
        foreach ((array) $parent_roles as $parent_role) {
            $rbacadmin->initIntersectionPermissions(
                $this->getRefId(),
                $parent_role['obj_id'],
                $parent_role['parent'],
                $this->__getCrsNonMemberTemplateId(),
                ROLE_FOLDER_ID
            );
        }
    }

Here is the call graph for this function:

setRegistrationAccessCode()

ilObjCourse::setRegistrationAccessCode

(

$a_code

)

Set refistration access code.

Parameters

string

$a_code

Returns

Definition at line 192 of file class.ilObjCourse.php.

Referenced by __createDefaultSettings(), __readSettings(), and cloneSettings().

    {
        $this->reg_access_code = $a_code;
    }

Here is the caller graph for this function:

setShowMembers()

ilObjCourse::setShowMembers

(

$a_status

)

Definition at line 649 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->show_members = $a_status;
    }

Here is the caller graph for this function:

setShowMembersExport()

ilObjCourse::setShowMembersExport

(

$a_mem_export

)

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

Referenced by __readSettings(), and cloneSettings().

    {
        $this->member_export = $a_mem_export;
    }

Here is the caller graph for this function:

setStatusDetermination()

ilObjCourse::setStatusDetermination

(

$a_value

)

Set status determination mode.

Parameters

int

$a_value

Definition at line 2176 of file class.ilObjCourse.php.

References ilObjUserTracking\_enabledLearningProgress().

Referenced by __construct(), __readSettings(), and cloneSettings().

    {
        $a_value = (int) $a_value;
        
        // #13905
        if ($a_value == self::STATUS_DETERMINATION_LP) {
            include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
            if (!ilObjUserTracking::_enabledLearningProgress()) {
                $a_value = self::STATUS_DETERMINATION_MANUAL;
            }
        }
        
        $this->status_dt = $a_value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSubscriptionEnd()

ilObjCourse::setSubscriptionEnd

(

$a_value

)

Definition at line 347 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->subscription_end = $a_value;
    }

Here is the caller graph for this function:

setSubscriptionLimitationType()

ilObjCourse::setSubscriptionLimitationType

(

$a_type

)

Definition at line 327 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->subscription_limitation_type = $a_type;
    }

Here is the caller graph for this function:

setSubscriptionMaxMembers()

ilObjCourse::setSubscriptionMaxMembers

(

$a_value

)

Definition at line 474 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->subscription_max_members = $a_value;
    }

Here is the caller graph for this function:

setSubscriptionMinMembers()

ilObjCourse::setSubscriptionMinMembers

(

$a_value

)

Definition at line 947 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        if ($a_value !== null) {
            $a_value = (int) $a_value;
        }
        $this->min_members = $a_value;
    }

Here is the caller graph for this function:

setSubscriptionNotify()

ilObjCourse::setSubscriptionNotify

(

$a_value

)

Definition at line 533 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->subscription_notify = $a_value ? true : false;
    }

Here is the caller graph for this function:

setSubscriptionPassword()

ilObjCourse::setSubscriptionPassword

(

$a_value

)

Definition at line 364 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->subscription_password = $a_value;
    }

Here is the caller graph for this function:

setSubscriptionStart()

ilObjCourse::setSubscriptionStart

(

$a_value

)

Definition at line 339 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->subscription_start = $a_value;
    }

Here is the caller graph for this function:

setSubscriptionType()

ilObjCourse::setSubscriptionType

(

$a_value

)

Definition at line 356 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->subscription_type = $a_value;
    }

Here is the caller graph for this function:

setSyllabus()

ilObjCourse::setSyllabus

(

$a_syllabus

)

Definition at line 228 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->syllabus = $a_syllabus;
    }

Here is the caller graph for this function:

setTargetGroup()

ilObjCourse::setTargetGroup

(

?string

$a_tg

)

Parameters

string | null

$a_tg

Definition at line 244 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->target_group = $a_tg;
    }

Here is the caller graph for this function:

setTimingMode()

ilObjCourse::setTimingMode

(

$a_mode

)

Parameters

int

$a_mode

Definition at line 570 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->timing_mode = $a_mode;
    }

Here is the caller graph for this function:

setViewMode()

ilObjCourse::setViewMode

(

$a_mode

)

Definition at line 538 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->view_mode = $a_mode;
    }

Here is the caller graph for this function:

setWaitingListAutoFill()

ilObjCourse::setWaitingListAutoFill

(

$a_value

)

Definition at line 960 of file class.ilObjCourse.php.

Referenced by __readSettings(), and cloneSettings().

    {
        $this->auto_fill_from_waiting = (bool) $a_value;
    }

Here is the caller graph for this function:

syncMembersStatusWithLP()

ilObjCourse::syncMembersStatusWithLP

(

)

Set course status for all members by lp status.

Definition at line 2204 of file class.ilObjCourse.php.

References ilLPStatusWrapper\_updateStatus(), ilObject\getId(), and getMembersObject().

    {
        include_once "Services/Tracking/classes/class.ilLPStatusWrapper.php";
        foreach ($this->getMembersObject()->getParticipants() as $user_id) {
            // #15529 - force raise on sync
            ilLPStatusWrapper::_updateStatus($this->getId(), $user_id, null, false, true);
        }
    }

Here is the call graph for this function:

toggleCourseStartTimeIndication()

ilObjCourse::toggleCourseStartTimeIndication ( bool  $time_indication )

protected

Parameters

bool

$time_indication

Definition at line 891 of file class.ilObjCourse.php.

Referenced by __readSettings(), and setCoursePeriod().

    {
        $this->course_start_time_indication = $time_indication;
    }

Here is the caller graph for this function:

update()

ilObjCourse::update

(

)

update complete object

Definition at line 1252 of file class.ilObjCourse.php.

References $DIC, ilObject\getId(), getOrderType(), prepareAppointments(), ilObject\updateMetaData(), and updateSettings().

Referenced by cloneSettings().

    {
        global $DIC;

        $ilAppEventHandler = $DIC['ilAppEventHandler'];
        $ilLog = $DIC->logger()->crs();

        include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
        $sorting = new ilContainerSortingSettings($this->getId());
        $sorting->setSortMode($this->getOrderType());
        $sorting->update();

        $this->updateMetaData();
        $this->updateSettings();
        parent::update();

        $ilAppEventHandler->raise(
            'Modules/Course',
            'update',
            array('object' => $this,
                'obj_id' => $this->getId(),
                'appointments' => $this->prepareAppointments('update'))
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateSettings()

ilObjCourse::updateSettings

(

)

Update settings.

Definition at line 1280 of file class.ilObjCourse.php.

References $DIC, $ilDB, $query, $res, __createDefaultSettings(), ilCalendarUtil\convertDateToUtcDBTimestamp(), enabledWaitingList(), getAboStatus(), getActivationEnd(), getActivationStart(), getActivationVisibility(), getAutoNotification(), getCancellationEnd(), getContactConsultation(), getContactEmail(), getContactName(), getContactPhone(), getContactResponsibility(), getCourseEnd(), getCourseStart(), getCourseStartTimeIndication(), getEnableCourseMap(), ilObject\getId(), getImportantInformation(), ilObjectActivation\getItem(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getNumberOfNextSessions(), getNumberOfPreviousSessions(), ilObject\getOfflineStatus(), getRegistrationAccessCode(), getShowMembers(), getShowMembersExport(), getStatusDetermination(), getSubscriptionEnd(), getSubscriptionLimitationType(), getSubscriptionMaxMembers(), getSubscriptionMinMembers(), getSubscriptionNotify(), getSubscriptionPassword(), getSubscriptionStart(), getSubscriptionType(), getSyllabus(), getTargetGroup(), getTimingMode(), getViewMode(), hasWaitingListAutoFill(), IL_CAL_UNIX, isRegistrationAccessCodeEnabled(), isSessionLimitEnabled(), isSubscriptionMembershipLimited(), ilObjectActivation\setTimingType(), ilDBConstants\T_INTEGER, ilDBConstants\T_TEXT, ilDBConstants\T_TIMESTAMP, ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

Referenced by update().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        // Due to a bug 3.5.alpha maybe no settings exist. => create default settings

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

        if (!$res->numRows()) {
            $this->__createDefaultSettings();
        }


        $query = "UPDATE crs_settings SET " .
            "syllabus = " . $ilDB->quote($this->getSyllabus(), 'text') . ", " .
            "contact_name = " . $ilDB->quote($this->getContactName(), 'text') . ", " .
            "contact_responsibility = " . $ilDB->quote($this->getContactResponsibility(), 'text') . ", " .
            "contact_phone = " . $ilDB->quote($this->getContactPhone(), 'text') . ", " .
            "contact_email = " . $ilDB->quote($this->getContactEmail(), 'text') . ", " .
            "contact_consultation = " . $ilDB->quote($this->getContactConsultation(), 'text') . ", " .
            "activation_type = " . $ilDB->quote(!$this->getOfflineStatus(), 'integer') . ", " .
            "sub_limitation_type = " . $ilDB->quote($this->getSubscriptionLimitationType(), 'integer') . ", " .
            "sub_start = " . $ilDB->quote($this->getSubscriptionStart(), 'integer') . ", " .
            "sub_end = " . $ilDB->quote($this->getSubscriptionEnd(), 'integer') . ", " .
            "sub_type = " . $ilDB->quote($this->getSubscriptionType(), 'integer') . ", " .
            "sub_password = " . $ilDB->quote($this->getSubscriptionPassword(), 'text') . ", " .
            "sub_mem_limit = " . $ilDB->quote((int) $this->isSubscriptionMembershipLimited(), 'integer') . ", " .
            "sub_max_members = " . $ilDB->quote($this->getSubscriptionMaxMembers(), 'integer') . ", " .
            "sub_notify = " . $ilDB->quote($this->getSubscriptionNotify(), 'integer') . ", " .
            "view_mode = " . $ilDB->quote($this->getViewMode(), 'integer') . ", " .
            'timing_mode = ' . $ilDB->quote($this->getTimingMode(), 'integer') . ', ' .
            "abo = " . $ilDB->quote($this->getAboStatus(), 'integer') . ", " .
            "waiting_list = " . $ilDB->quote($this->enabledWaitingList(), 'integer') . ", " .
            "important = " . $ilDB->quote($this->getImportantInformation(), 'text') . ", " .
            'target_group = ' . $ilDB->quote($this->getTargetGroup(), \ilDBConstants::T_TEXT) . ', ' .
            "show_members = " . $ilDB->quote($this->getShowMembers(), 'integer') . ", " .
            "show_members_export = " . $ilDB->quote($this->getShowMembersExport(), 'integer') . ", " .
            "latitude = " . $ilDB->quote($this->getLatitude(), 'text') . ", " .
            "longitude = " . $ilDB->quote($this->getLongitude(), 'text') . ", " .
            "location_zoom = " . $ilDB->quote($this->getLocationZoom(), 'integer') . ", " .
            "enable_course_map = " . $ilDB->quote((int) $this->getEnableCourseMap(), 'integer') . ", " .
            'session_limit = ' . $ilDB->quote($this->isSessionLimitEnabled(), 'integer') . ', ' .
            'session_prev = ' . $ilDB->quote($this->getNumberOfPreviousSessions(), 'integer') . ', ' .
            'session_next = ' . $ilDB->quote($this->getNumberOfNextSessions(), 'integer') . ', ' .
            'reg_ac_enabled = ' . $ilDB->quote($this->isRegistrationAccessCodeEnabled(), 'integer') . ', ' .
            'reg_ac = ' . $ilDB->quote($this->getRegistrationAccessCode(), 'text') . ', ' .
            'auto_notification = ' . $ilDB->quote((int) $this->getAutoNotification(), 'integer') . ', ' .
            'status_dt = ' . $ilDB->quote((int) $this->getStatusDetermination()) . ', ' .
            'mail_members_type = ' . $ilDB->quote((int) $this->getMailToMembersType(), 'integer') . ', ' .
            'period_start = ' . $ilDB->quote(\ilCalendarUtil::convertDateToUtcDBTimestamp($this->getCourseStart()), \ilDBConstants::T_TIMESTAMP) . ', ' .
            'period_end = ' . $ilDB->quote(\ilCalendarUtil::convertDateToUtcDBTimestamp($this->getCourseEnd()), \ilDBConstants::T_TIMESTAMP) . ', ' .
            'period_time_indication = ' . $ilDB->quote($this->getCourseStartTimeIndication() ? 1 : 0, \ilDBConstants::T_INTEGER) . ', ' .
            'auto_wait = ' . $ilDB->quote((int) $this->hasWaitingListAutoFill(), 'integer') . ', ' .
            'leave_end = ' . $ilDB->quote(($this->getCancellationEnd() && !$this->getCancellationEnd()->isNull()) ? $this->getCancellationEnd()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
            'min_members = ' . $ilDB->quote((int) $this->getSubscriptionMinMembers(), 'integer') . '  ' .
            "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . "";
                
        $res = $ilDB->manipulate($query);
        
        // moved activation to ilObjectActivation
        if ($this->ref_id) {
            include_once "./Services/Object/classes/class.ilObjectActivation.php";
            ilObjectActivation::getItem($this->ref_id);
            
            $item = new ilObjectActivation;
            if (!$this->getActivationStart() || !$this->getActivationEnd()) {
                $item->setTimingType(ilObjectActivation::TIMINGS_DEACTIVATED);
            } else {
                $item->setTimingType(ilObjectActivation::TIMINGS_ACTIVATION);
                $item->setTimingStart($this->getActivationStart());
                $item->setTimingEnd($this->getActivationEnd());
                $item->toggleVisible($this->getActivationVisibility());
            }
            
            $item->update($this->ref_id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validate()

ilObjCourse::validate

(

)

Definition at line 1131 of file class.ilObjCourse.php.

References appendMessage(), enabledWaitingList(), getCourseEnd(), getCourseStart(), getMessage(), getStatusDetermination(), getSubscriptionEnd(), getSubscriptionLimitationType(), getSubscriptionMaxMembers(), getSubscriptionMinMembers(), getSubscriptionPassword(), getSubscriptionStart(), getSubscriptionType(), ilObject\getTitle(), IL_CAL_UNIX, IL_CRS_SUBSCRIPTION_LIMITED, IL_CRS_SUBSCRIPTION_PASSWORD, isSubscriptionMembershipLimited(), and setMessage().

    {
        $this->setMessage('');

        if (($this->getSubscriptionLimitationType() == IL_CRS_SUBSCRIPTION_LIMITED) and
           $this->getSubscriptionStart() > $this->getSubscriptionEnd()) {
            $this->appendMessage($this->lng->txt("subscription_times_not_valid"));
        }
        if ($this->getSubscriptionType() == IL_CRS_SUBSCRIPTION_PASSWORD and !$this->getSubscriptionPassword()) {
            $this->appendMessage($this->lng->txt("crs_password_required"));
        }
        if ($this->isSubscriptionMembershipLimited()) {
            if ($this->getSubscriptionMinMembers() <= 0 && $this->getSubscriptionMaxMembers() <= 0) {
                $this->appendMessage($this->lng->txt("crs_max_and_min_members_needed"));
            }
            if ($this->getSubscriptionMaxMembers() <= 0 && $this->enabledWaitingList()) {
                $this->appendMessage($this->lng->txt("crs_max_members_needed"));
            }
            if ($this->getSubscriptionMaxMembers() > 0 && $this->getSubscriptionMinMembers() > $this->getSubscriptionMaxMembers()) {
                $this->appendMessage($this->lng->txt("crs_max_and_min_members_invalid"));
            }
        }
        if (!$this->getTitle() || !$this->getStatusDetermination()) {
            $this->appendMessage($this->lng->txt('err_check_input'));
        }
        
        // :TODO: checkInput() is not used properly
        if (($this->getCourseStart() && !$this->getCourseEnd()) ||
            (!$this->getCourseStart() && $this->getCourseEnd()) ||
            ($this->getCourseStart() && $this->getCourseEnd() && $this->getCourseStart()->get(IL_CAL_UNIX) > $this->getCourseEnd()->get(IL_CAL_UNIX))) {
            $this->appendMessage($this->lng->txt("crs_course_period_not_valid"));
        }

        return $this->getMessage() ? false : true;
    }

Here is the call graph for this function:

validateInfoSettings()

ilObjCourse::validateInfoSettings

(

)

Definition at line 1167 of file class.ilObjCourse.php.

References $DIC, $email, ilContainer\$error, $ilErr, getContactEmail(), ilObjUser\getUserIdByLogin(), and ilUtil\is_email().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $error = false;
        if ($this->getContactEmail()) {
            $emails = explode(",", $this->getContactEmail());
            
            foreach ($emails as $email) {
                $email = trim($email);
                if (!(ilUtil::is_email($email) or ilObjUser::getUserIdByLogin($email))) {
                    $ilErr->appendMessage($this->lng->txt('contact_email_not_valid') . " '" . $email . "'");
                    $error = true;
                }
            }
        }
        return !$error;
    }

Here is the call graph for this function:

Field Documentation

$archives_obj

ilObjCourse::$archives_obj

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

$auto_fill_from_waiting

ilObjCourse::$auto_fill_from_waiting

protected

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

Referenced by hasWaitingListAutoFill().

$auto_notification

ilObjCourse::$auto_notification = true

private

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

Referenced by getAutoNotification().

$course_logger

ilObjCourse::$course_logger = null

protected

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

$course_start_time_indication

ilObjCourse::$course_start_time_indication = false

protected

Definition at line 78 of file class.ilObjCourse.php.

Referenced by getCourseStartTimeIndication().

$crs_end

ilObjCourse::$crs_end

protected

Definition at line 88 of file class.ilObjCourse.php.

Referenced by getCourseEnd().

$crs_start

ilObjCourse::$crs_start

protected

Definition at line 83 of file class.ilObjCourse.php.

Referenced by getCourseStart().

$enablemap

ilObjCourse::$enablemap = 0

private

Definition at line 63 of file class.ilObjCourse.php.

Referenced by getEnableCourseMap().

$latitude

ilObjCourse::$latitude = ''

private

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

Referenced by getLatitude().

$leave_end

ilObjCourse::$leave_end

protected

Definition at line 91 of file class.ilObjCourse.php.

Referenced by getCancellationEnd().

$locationzoom

ilObjCourse::$locationzoom = 0

private

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

Referenced by getLocationZoom().

$longitude

ilObjCourse::$longitude = ''

private

Definition at line 61 of file class.ilObjCourse.php.

Referenced by getLongitude().

$mail_members

ilObjCourse::$mail_members = ilCourseConstants::MAIL_ALLOWED_ALL

private

Definition at line 73 of file class.ilObjCourse.php.

Referenced by getMailToMembersType().

$member_export

ilObjCourse::$member_export = false

protected

Definition at line 98 of file class.ilObjCourse.php.

Referenced by getShowMembersExport().

$member_obj

ilObjCourse::$member_obj = null

private

Definition at line 56 of file class.ilObjCourse.php.

Referenced by getMemberObject().

$members_obj

ilObjCourse::$members_obj = null

private

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

Referenced by getMembersObject().

$min_members

ilObjCourse::$min_members

protected

Definition at line 92 of file class.ilObjCourse.php.

Referenced by getSubscriptionMinMembers().

$reg_access_code

ilObjCourse::$reg_access_code = ''

private

Definition at line 69 of file class.ilObjCourse.php.

Referenced by getRegistrationAccessCode().

$reg_access_code_enabled

ilObjCourse::$reg_access_code_enabled = false

private

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

Referenced by isRegistrationAccessCodeEnabled().

$session_limit

ilObjCourse::$session_limit = 0

private

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

Referenced by isSessionLimitEnabled().

$session_next

ilObjCourse::$session_next = -1

private

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

Referenced by getNumberOfNextSessions().

$session_prev

ilObjCourse::$session_prev = -1

private

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

Referenced by getNumberOfPreviousSessions().

$status_dt

ilObjCourse::$status_dt = null

private

Definition at line 71 of file class.ilObjCourse.php.

Referenced by getStatusDetermination().

$target_group

ilObjCourse::$target_group = ''

private

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

Referenced by getTargetGroup().

$timing_mode

ilObjCourse::$timing_mode = ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE

private

Definition at line 103 of file class.ilObjCourse.php.

Referenced by getTimingMode().

CAL_ACTIVATION_END

const ilObjCourse::CAL_ACTIVATION_END = 4

Definition at line 46 of file class.ilObjCourse.php.

CAL_ACTIVATION_START

const ilObjCourse::CAL_ACTIVATION_START = 3

Definition at line 45 of file class.ilObjCourse.php.

CAL_COURSE_END

const ilObjCourse::CAL_COURSE_END = 6

Definition at line 48 of file class.ilObjCourse.php.

CAL_COURSE_START

const ilObjCourse::CAL_COURSE_START = 5

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

CAL_COURSE_TIMING_END

const ilObjCourse::CAL_COURSE_TIMING_END = 8

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

Referenced by ilCalendarScheduleFilterTimings\addCustomEvents(), ilCalendarScheduleFilterTimings\findCalendarEntriesForItem(), and ilCalendarScheduleFilterTimings\modifyEvent().

CAL_COURSE_TIMING_START

const ilObjCourse::CAL_COURSE_TIMING_START = 7

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

Referenced by ilCalendarScheduleFilterTimings\addCustomEvents(), ilCalendarScheduleFilterTimings\findCalendarEntriesForItem(), and ilCalendarScheduleFilterTimings\modifyEvent().

CAL_REG_END

const ilObjCourse::CAL_REG_END = 2

Definition at line 44 of file class.ilObjCourse.php.

CAL_REG_START

const ilObjCourse::CAL_REG_START = 1

Definition at line 43 of file class.ilObjCourse.php.

STATUS_DETERMINATION_LP

const ilObjCourse::STATUS_DETERMINATION_LP = 1

Definition at line 53 of file class.ilObjCourse.php.

Referenced by checkLPStatusSync(), ilCourseLP\getSettingsInfo(), ilCourseAppEventListener\handleEvent(), ilObjCourseGUI\initEditForm(), ilCourseMembershipGUI\initParticipantTableGUI(), ilObjCourseGUI\readMemberData(), ilObjCourseGUI\setLPSyncObject(), ilObjCourseGUI\updateLPFromStatus(), and ilObjCourseGUI\updateObject().

STATUS_DETERMINATION_MANUAL

const ilObjCourse::STATUS_DETERMINATION_MANUAL = 2

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

Referenced by ilObjCourseGUI\initEditForm().

---

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

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