ilObjCourse Class Reference

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

Inheritance diagram for ilObjCourse:

Collaboration diagram for ilObjCourse:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	getShowMembersExport ()
	setShowMembersExport (bool $a_mem_export)
	getRegistrationAccessCode ()
	setRegistrationAccessCode (string $a_code)
	isRegistrationAccessCodeEnabled ()
	enableRegistrationAccessCode (bool $a_status)
	getImportantInformation ()
	setImportantInformation (string $a_info)
	getSyllabus ()
	setSyllabus (string $a_syllabus)
	getTargetGroup ()
	setTargetGroup (?string $a_tg)
	getContactName ()
	setContactName (string $a_cn)
	getContactConsultation ()
	setContactConsultation (string $a_value)
	getContactPhone ()
	setContactPhone (string $a_value)
	getContactEmail ()
	setContactEmail (string $a_value)
	getContactResponsibility ()
	setContactResponsibility (string $a_value)
	getActivationUnlimitedStatus ()
	getActivationStart ()
	setActivationStart (int $a_value)
	getActivationEnd ()
	setActivationEnd (int $a_value)
	setActivationVisibility (bool $a_value)
	getActivationVisibility ()
	getSubscriptionLimitationType ()
	setSubscriptionLimitationType (int $a_type)
	getSubscriptionUnlimitedStatus ()
	getSubscriptionStart ()
	setSubscriptionStart (int $a_value)
	getSubscriptionEnd ()
	setSubscriptionEnd (int $a_value)
	getSubscriptionType ()
	setSubscriptionType (int $a_value)
	getSubscriptionPassword ()
	setSubscriptionPassword (string $a_value)
	enabledObjectiveView ()
	enabledWaitingList ()
	enableWaitingList (bool $a_status)
	inSubscriptionTime ()
	enableSessionLimit (int $a_status)
	isSessionLimitEnabled ()
	enableSubscriptionMembershipLimitation (bool $a_status)
	setNumberOfPreviousSessions (int $a_num)
	getNumberOfPreviousSessions ()
	setNumberOfNextSessions (int $a_num)
	getNumberOfNextSessions ()
	isSubscriptionMembershipLimited ()
	getSubscriptionMaxMembers ()
	setSubscriptionMaxMembers (int $a_value)
	getSubItems (bool $a_admin_panel_enabled=false, bool $a_include_side_block=false, int $a_get_single=0, \ilContainerUserFilter $container_user_filter=null)
	getSubscriptionNotify ()
	setViewMode (int $a_mode)
	getViewMode ()
	setTimingMode (int $a_mode)
	getTimingMode ()
	setAboStatus (bool $a_status)
	getAboStatus ()
	setShowMembers (bool $a_status)
	getShowMembers ()
	setMailToMembersType (int $a_type)
	getMailToMembersType ()
	getMessage ()
	setMessage (string $a_message)
	appendMessage (string $a_message)
	isActivated ()
	read ()
	create ($a_upload=false)
	setLatitude (string $a_latitude)
	getLatitude ()
	setLongitude (string $a_longitude)
	getLongitude ()
	setLocationZoom (int $a_locationzoom)
	getLocationZoom ()
	setEnableCourseMap (bool $a_enablemap)
	getEnableMap ()
	getEnableCourseMap ()
	setCoursePeriod (?ilDateTime $start=null, ?ilDateTime $end=null)
	getCourseStartTimeIndication ()
	getCourseStart ()
	getCourseEnd ()
	setCancellationEnd (?ilDate $a_value=null)
	getCancellationEnd ()
	setSubscriptionMinMembers (int $a_value)
	getSubscriptionMinMembers ()
	setWaitingListAutoFill (bool $a_value)
	hasWaitingListAutoFill ()
	cloneObject (int $a_target_id, int $a_copy_id=0, bool $a_omit_tree=false)
	Clone course (no member data) More...
	cloneDependencies (int $a_target_id, int $a_copy_id)
	@inheritDoc More...
	cloneAutoGeneratedRoles (ilObject $new_obj)
	Clone automatic genrated roles (permissions and template permissions) More...
	validate ()
	validateInfoSettings ()
	hasContactData ()
	delete ()
	delete course and all related data More...
	update ()
	@inheritDoc More...
	updateSettings ()
	cloneSettings (ilObject $new_obj)
	__createDefaultSettings ()
	__readSettings ()
	initWaitingList ()
	getMemberObject ()
	getMembersObject ()
	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. More...
	setParentRolePermissions (int $a_parent_ref)
	This method is called before "initDefaultRoles". More...
	__getCrsNonMemberTemplateId ()
	getLocalCourseRoles ($a_translate=false)
	get ALL local roles of course, also those created and defined afterwards only fetch data once from database. More...
	getDefaultCourseRoles (string $a_crs_id="")
	get default course roles, returns the defaultlike create roles il_crs_tutor, il_crs_admin and il_crs_member Returns the obj_ids of course specific roles in an associative array. More...
	__getLocalRoles ()
	__deleteSettings ()
	getDefaultMemberRole ()
	getDefaultTutorRole ()
	getDefaultAdminRole ()
	addAdditionalSubItemInformation (array &$object)
	Add additional information to sub item, e.g. More...
	register (int $a_user_id, int $a_role=ilCourseConstants::CRS_MEMBER, bool $a_force_registration=false)
	getAutoNotification ()
	Returns automatic notification status from $this->auto_notification. More...
	setAutoNotification (bool $value)
	Sets automatic notification status in $this->auto_notification, using given $status. More...
	setStatusDetermination (int $a_value)
	Set status determination mode. More...
	getStatusDetermination ()
	Get status determination mode. More...
	syncMembersStatusWithLP ()
	checkLPStatusSync (int $a_member_id)
	sync course status from lp as lp data is not deleted on course exit new members may already have lp completed More...
	getOrderType ()
	handleAutoFill ()
	Handle course auto fill. More...
Public Member Functions inherited from ilContainer
	getTileSizes ()
	getObjectTranslation ()
	setObjectTranslation (?ilObjectTranslation $obj_trans)
	createContainerDirectory ()
	getContainerDirectory ()
	setHiddenFilesFound (bool $a_hiddenfilesfound)
	getHiddenFilesFound ()
	getStyleSheetId ()
	setStyleSheetId (int $a_style_id)
	setNewsTimeline (bool $a_val)
	getNewsTimeline ()
	setNewsTimelineAutoEntries (bool $a_val)
	getNewsTimelineAutoEntries ()
	setNewsTimelineLandingPage (bool $a_val)
	getNewsTimelineLandingPage ()
	isNewsTimelineEffective ()
	isNewsTimelineLandingPageEffective ()
	setNewsBlockActivated (bool $a_val)
	getNewsBlockActivated ()
	setUseNews (bool $a_val)
	getUseNews ()
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies (container sorting) More...
	cloneAllObject (string $session_id, string $client_id, string $new_type, int $ref_id, int $clone_source, array $options, bool $soap_call=false, int $a_submode=1)
	delete ()
	delete category and all related data More...
	getViewMode ()
	getOrderType ()
	setOrderType (int $a_value)
	isClassificationFilterActive ()
	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...
	getSubItems (bool $a_admin_panel_enabled=false, bool $a_include_side_block=false, int $a_get_single=0, ilContainerUserFilter $container_user_filter=null)
	gotItems ()
	addAdditionalSubItemInformation (array &$object)
	Add additional information to sub item, e.g. More...
	getGroupedObjTypes ()
	enablePageEditing ()
	create ()
	note: title, description and type should be set when this function is called More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	update ()
	read ()
	readContainerSettings ()
	removeTranslations ()
	deleteTranslation (string $a_lang)
	addTranslation (string $a_title, string $a_desc, string $a_lang, string $a_lang_default)
Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $desc)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	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. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...
Public Member Functions inherited from ilMembershipRegistrationCodes
	register (int $a_user_id)
	Register an user. More...

Static Public Member Functions
static	lookupShowMembersEnabled (int $a_obj_id)
static	_isSubscriptionNotificationEnabled (int $a_course_id)
static	lookupTimingMode (int $a_obj_id)
static	_lookupViewMode (int $a_id)
static	_lookupAboStatus (int $a_id)
static	_isActivated (int $a_obj_id)
	Is activated. More...
static	_registrationEnabled (int $a_obj_id)
	Registration enabled? Method is in Access class, since it is needed by Access/ListGUI. More...
static	lookupCourseNonMemberTemplatesId ()
static	_deleteUser (int $a_usr_id)
static	lookupObjectsByCode (string $a_code)
static	mayLeave (int $a_course_id, int $a_user_id=0, &$a_date=null)
static	findCoursesWithNotEnoughMembers ()
Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory (int $a_id)
static	_lookupContainerSetting (int $a_id, string $a_keyword, string $a_default_value=null)
static	_hasContainerSetting (int $a_id, string $a_keyword)
static	_writeContainerSetting (int $a_id, string $a_keyword, string $a_value)
static	_getContainerSettings (int $a_id)
static	_deleteContainerSettings (int $a_id, string $a_keyword="", bool $a_keyword_like=false)
static	_exportContainerSettings (ilXmlWriter $a_xml, int $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 (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)
static	lookupObjectsByCode (string $a_code)
	Lookup all objects with reg_access_code enabled and. 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
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
const	TILE_NORMAL = 0
const	TILE_SMALL = 1
const	TILE_LARGE = 2
const	TILE_EXTRA_LARGE = 3
const	TILE_FULL = 4
array	$items = []
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Protected Member Functions
	toggleCourseStartTimeIndication (bool $time_indication)
	setCourseStart (?ilDateTime $a_value=null)
	setCourseEnd (?ilDateTime $a_value=null)
	initCourseMemberObject ()
	initCourseMembersObject ()
	doMDUpdateListener (string $a_element)
	prepareAppointments (string $a_mode='create')
	Prepare calendar appointments. More...
Protected Member Functions inherited from ilContainer
	getInitialSubitems ()
	applyContainerUserFilter (array $objects, ilContainerUserFilter $container_user_filter=null)
	Apply container user filter on objects. More...
	filterObjIdsByCopyright (array $obj_ids, string $copyright_id)
	filterObjIdsByDefaultCopyright (array $obj_ids, string $default_identifier)
	legacyOnlineFilter (array $obj_ids, array $objects, int $val)
	Legacy online filter. More...
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Private Attributes
string	$contact_consultation = ''
string	$contact_phone = ''
string	$contact_email = ''
string	$contact_name = ''
string	$contact_responsibility = ''
int	$subscription_limitation_type = 0
int	$subscription_start = 0
int	$subscription_end = 0
int	$subscription_type = 0
string	$subscription_password = ''
int	$view_mode = 0
bool	$waiting_list = false
bool	$subscription_membership_limitation = false
int	$subscription_max_members = 0
bool	$abo = true
bool	$show_members = true
string	$message = ''
bool	$course_start_time_indication = true
ilCourseWaitingList	$waiting_list_obj = null
string	$important = ''
string	$syllabus = ''
ilLogger	$course_logger
string	$latitude = ''
string	$longitude = ''
int	$locationzoom = 0
bool	$enablemap = false
int	$session_limit = 0
int	$session_prev = -1
int	$session_next = -1
string	$reg_access_code = ''
bool	$reg_access_code_enabled = false
int	$status_dt = 0
int	$mail_members = ilCourseConstants::MAIL_ALLOWED_ALL
bool	$crs_start_time_indication = false
ilDateTime	$crs_start = null
ilDateTime	$crs_end = null
ilDate	$leave_end = null
int	$min_members = 0
bool	$auto_fill_from_waiting = false
bool	$member_export = false
int	$timing_mode = ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE
bool	$auto_notification = true
string	$target_group = null
int	$activation_start = 0
int	$activation_end = 0
bool	$activation_visibility = false
ilCourseParticipant	$member_obj = null
ilCourseParticipants	$members_obj = null

Additional Inherited Members
Static Public Attributes inherited from ilContainer
static bool	$data_preloaded = false
Protected Attributes inherited from ilContainer
ILIAS Style Content DomainService	$content_style_domain
ilNewsService	$news
ilAccessHandler	$access
ilRbacSystem	$rbacsystem
ilObjUser	$user
ilObjectDefinition	$obj_definition
int	$order_type = 0
bool	$hiddenfilesfound = false
bool	$news_timeline = false
bool	$news_timeline_auto_entries = false
ilSetting	$setting
ilObjectTranslation	$obj_trans = null
int	$style_id = 0
bool	$news_timeline_landing_page = false
bool	$news_block_activated = false
bool	$use_news = false
ilRecommendedContentManager	$recommended_content_manager
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
int	$id
bool	$referenced
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
bool	$offline = false
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Detailed Description

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

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

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

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilObjCourse::__construct	(	int	$id = 0,
		bool	$reference = true
	)

Parameters

int	$id	reference_id or object_id
bool	$reference	bool treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

    {
        global $DIC;
 
        $this->setStatusDetermination(self::STATUS_DETERMINATION_LP);
 
        $this->type = "crs";
        $this->course_logger = $DIC->logger()->crs();
        parent::__construct($a_id, $a_call_by_reference);
    }

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

Here is the call graph for this function:

Member Function Documentation

__createDefaultSettings()

ilObjCourse::__createDefaultSettings

(

)

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

                                             : void
    {
        $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( " .
            $this->db->quote($this->getId(), 'integer') . ", " .
            $this->db->quote($this->getSyllabus(), 'text') . ", " .
            $this->db->quote($this->getContactName(), 'text') . ", " .
            $this->db->quote($this->getContactResponsibility(), 'text') . ", " .
            $this->db->quote($this->getContactPhone(), 'text') . ", " .
            $this->db->quote($this->getContactEmail(), 'text') . ", " .
            $this->db->quote($this->getContactConsultation(), 'text') . ", " .
            $this->db->quote(ilCourseConstants::IL_CRS_SUBSCRIPTION_DEACTIVATED, 'integer') . ", " .
            $this->db->quote($this->getSubscriptionStart(), 'integer') . ", " .
            $this->db->quote($this->getSubscriptionEnd(), 'integer') . ", " .
            $this->db->quote(ilCourseConstants::IL_CRS_SUBSCRIPTION_DIRECT, 'integer') . ", " .
            $this->db->quote($this->getSubscriptionPassword(), 'text') . ", " .
            "0, " .
            $this->db->quote($this->getSubscriptionMaxMembers(), 'integer') . ", " .
            "1, " .
            "0, " .
            $this->db->quote(ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE, 'integer') . ', ' .
            $this->db->quote($this->getAboStatus(), 'integer') . ", " .
            $this->db->quote($this->getLatitude(), 'text') . ", " .
            $this->db->quote($this->getLongitude(), 'text') . ", " .
            $this->db->quote($this->getLocationZoom(), 'integer') . ", " .
            $this->db->quote($this->getEnableCourseMap(), 'integer') . ", " .
            #"objective_view = '0', ".
            "1, " .
            "1," .
            '0,' .
            $this->db->quote($this->isSessionLimitEnabled(), 'integer') . ', ' .
            $this->db->quote($this->getNumberOfPreviousSessions(), 'integer') . ', ' .
            $this->db->quote($this->getNumberOfPreviousSessions(), 'integer') . ', ' .
            $this->db->quote($this->isRegistrationAccessCodeEnabled(), 'integer') . ', ' .
            $this->db->quote($this->getRegistrationAccessCode(), 'text') . ', ' .
            $this->db->quote((int) $this->getAutoNotification(), 'integer') . ', ' .
            $this->db->quote($this->getStatusDetermination(), 'integer') . ', ' .
            $this->db->quote($this->getMailToMembersType(), 'integer') . ' ' .
            ")";
 
        $res = $this->db->manipulate($query);
        $this->__readSettings();
 
        $sorting = new ilContainerSortingSettings($this->getId());
        $sorting->setSortMode(ilContainer::SORT_MANUAL);
        $sorting->update();
    }

References $query, $res, ilMembershipRegistrationCodeUtils\generateCode(), ILIAS\Survey\Mode\getId(), ilCourseConstants\IL_CRS_SUBSCRIPTION_DEACTIVATED, ilCourseConstants\IL_CRS_SUBSCRIPTION_DIRECT, ilCourseConstants\IL_CRS_VIEW_TIMING_ABSOLUTE, and ilContainer\SORT_MANUAL.

Here is the call graph for this function:

__deleteSettings()

ilObjCourse::__deleteSettings

(

)

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

                                      : void
    {
        $query = "DELETE FROM crs_settings " .
            "WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . " ";
        $this->db->manipulate($query);
    }

References $query, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

__getCrsNonMemberTemplateId()

ilObjCourse::__getCrsNonMemberTemplateId

(

)

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

                                                 : int
    {
        $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 (int) $row["obj_id"];
    }

References $res, and ilDBConstants\FETCHMODE_ASSOC.

__getLocalRoles()

ilObjCourse::__getLocalRoles

(

)

Returns

int[]

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

                                     : array
    {
        return $this->rbac_review->getRolesOfRoleFolder($this->getRefId(), false);
    }

__readSettings()

ilObjCourse::__readSettings

(

)

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

                                    : void
    {
        $query = "SELECT * FROM crs_settings WHERE obj_id = " . $this->db->quote($this->getId(), 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setSyllabus((string) $row->syllabus);
            $this->setTargetGroup($row->target_group);
            $this->setContactName((string) $row->contact_name);
            $this->setContactResponsibility((string) $row->contact_responsibility);
            $this->setContactPhone((string) $row->contact_phone);
            $this->setContactEmail((string) $row->contact_email);
            $this->setContactConsultation((string) $row->contact_consultation);
            $this->setOfflineStatus(!(bool) $row->activation_type); // see below
            $this->setSubscriptionLimitationType((int) $row->sub_limitation_type);
            $this->setSubscriptionStart((int) $row->sub_start);
            $this->setSubscriptionEnd((int) $row->sub_end);
            $this->setSubscriptionType((int) $row->sub_type);
            $this->setSubscriptionPassword((string) $row->sub_password);
            $this->enableSubscriptionMembershipLimitation((bool) $row->sub_mem_limit);
            $this->setSubscriptionMaxMembers((int) $row->sub_max_members);
            $this->setViewMode((int) $row->view_mode);
            $this->setTimingMode((int) $row->timing_mode);
            $this->setAboStatus((bool) $row->abo);
            $this->enableWaitingList((bool) $row->waiting_list);
            $this->setImportantInformation((string) $row->important);
            $this->setShowMembers((bool) $row->show_members);
 
            if (\ilPrivacySettings::getInstance()->participantsListInCoursesEnabled()) {
                $this->setShowMembersExport((bool) $row->show_members_export);
            } else {
                $this->setShowMembersExport(false);
            }
            $this->setLatitude((string) $row->latitude);
            $this->setLongitude((string) $row->longitude);
            $this->setLocationZoom((int) $row->location_zoom);
            $this->setEnableCourseMap((bool) $row->enable_course_map);
            $this->enableSessionLimit((int) $row->session_limit);
            $this->setNumberOfPreviousSessions((int) $row->session_prev);
            $this->setNumberOfNextSessions((int) $row->session_next);
            $this->enableRegistrationAccessCode((bool) $row->reg_ac_enabled);
            $this->setRegistrationAccessCode((string) $row->reg_ac);
            $this->setAutoNotification((bool) $row->auto_notification);
            $this->setStatusDetermination((int) $row->status_dt);
            $this->setMailToMembersType((int) $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((bool) $row->auto_wait);
            $this->setSubscriptionMinMembers((int) $row->min_members);
        }
 
        // moved activation to ilObjectActivation
        if ($this->ref_id ?? false) {
            $activation = ilObjectActivation::getItem($this->ref_id);
            switch ($activation["timing_type"]) {
                case ilObjectActivation::TIMINGS_ACTIVATION:
                    $this->setActivationStart((int) $activation["timing_start"]);
                    $this->setActivationEnd((int) $activation["timing_end"]);
                    $this->setActivationVisibility((bool) $activation["visible"]);
                    break;
            }
        }
    }

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Survey\Mode\getId(), ilPrivacySettings\getInstance(), ilObjectActivation\getItem(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, ilObjectActivation\TIMINGS_ACTIVATION, and ilTimeZone\UTC.

Here is the call graph for this function:

_deleteUser()

static ilObjCourse::_deleteUser ( int  $a_usr_id )

static

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

                                                     : void
    {
        ilCourseLMHistory::_deleteUser($a_usr_id);
        ilCourseParticipants::_deleteUser($a_usr_id);
        ilLOUserResults::deleteResultsForUser($a_usr_id);
    }

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

Referenced by ilObjUser\delete().

Here is the call graph for this function:

Here is the caller graph for this function:

_isActivated()

static ilObjCourse::_isActivated ( int  $a_obj_id )

static

Is activated.

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

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

                                                      : bool
    {
        return ilObjCourseAccess::_isActivated($a_obj_id);
    }

References ilObjCourseAccess\_isActivated().

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

Here is the call graph for this function:

Here is the caller graph for this function:

_isSubscriptionNotificationEnabled()

static ilObjCourse::_isSubscriptionNotificationEnabled ( int  $a_course_id )

static

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

                                                                               : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "SELECT * FROM crs_settings " .
            "WHERE obj_id = " . $ilDB->quote($a_course_id, 'integer') . " " .
            "AND sub_notify = 1";
        $res = $ilDB->query($query);
        return (bool) $res->numRows();
    }

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

_lookupAboStatus()

static ilObjCourse::_lookupAboStatus ( int  $a_id )

static

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

                                                      : bool
    {
        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;
    }

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

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

Here is the caller graph for this function:

_lookupViewMode()

static ilObjCourse::_lookupViewMode ( int  $a_id )

static

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

                                                     : int
    {
        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;
    }

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

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

Here is the caller graph for this function:

_registrationEnabled()

static ilObjCourse::_registrationEnabled ( int  $a_obj_id )

static

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

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

                                                              : bool
    {
        return ilObjCourseAccess::_registrationEnabled($a_obj_id);
    }

References ilObjCourseAccess\_registrationEnabled().

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

Here is the call graph for this function:

Here is the caller graph for this function:

addAdditionalSubItemInformation()

ilObjCourse::addAdditionalSubItemInformation

(

array &

$object

)

Add additional information to sub item, e.g.

used in courses for timings information etc.

Reimplemented from ilContainer.

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

                                                                   : void
    {
        ilObjectActivation::addAdditionalSubItemInformation($object);
    }

References ilObjectActivation\addAdditionalSubItemInformation().

Here is the call graph for this function:

appendMessage()

ilObjCourse::appendMessage

(

string

$a_message

)

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

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

checkLPStatusSync()

ilObjCourse::checkLPStatusSync

(

int

$a_member_id

)

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

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

                                                       : void
    {
        // #11113
        if (ilObjUserTracking::_enabledLearningProgress() &&
            $this->getStatusDetermination() == ilObjCourse::STATUS_DETERMINATION_LP) {
            // #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);
        }
    }

References ilObjUserTracking\_enabledLearningProgress(), ilLPStatus\_lookupStatus(), ILIAS\Survey\Mode\getId(), ilLPStatus\LP_STATUS_COMPLETED_NUM, and STATUS_DETERMINATION_LP.

Here is the call graph for this function:

cloneAutoGeneratedRoles()

ilObjCourse::cloneAutoGeneratedRoles

(

ilObject

$new_obj

)

Clone automatic genrated roles (permissions and template permissions)

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

                                                              : void
    {
        $admin = $this->getDefaultAdminRole();
        $new_admin = $new_obj->getDefaultAdminRole();
 
        if (!$admin || !$new_admin || !$this->getRefId() || !$new_obj->getRefId()) {
            $this->course_logger->debug('Error cloning auto generated role: il_crs_admin');
        }
        $this->rbac_admin->copyRolePermissions($admin, $this->getRefId(), $new_obj->getRefId(), $new_admin, true);
        $this->course_logger->debug('Finished copying of role crs_admin.');
 
        $tutor = $this->getDefaultTutorRole();
        $new_tutor = $new_obj->getDefaultTutorRole();
        if (!$tutor || !$new_tutor) {
            $this->course_logger->info('Error cloning auto generated role: il_crs_tutor');
        }
        $this->rbac_admin->copyRolePermissions($tutor, $this->getRefId(), $new_obj->getRefId(), $new_tutor, true);
        $this->course_logger->info('Finished copying of role crs_tutor.');
 
        $member = $this->getDefaultMemberRole();
        $new_member = $new_obj->getDefaultMemberRole();
        if (!$member || !$new_member) {
            $this->course_logger->debug('Error cloning auto generated role: il_crs_member');
        }
        $this->rbac_admin->copyRolePermissions($member, $this->getRefId(), $new_obj->getRefId(), $new_member, true);
        $this->course_logger->debug('Finished copying of role crs_member.');
    }

References ilObject\getRefId().

Here is the call graph for this function:

cloneDependencies()

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

@inheritDoc

Reimplemented from ilContainer.

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

                                                                       : bool
    {
        parent::cloneDependencies($a_target_id, $a_copy_id);
 
        // Clone course start objects
        $start = new ilContainerStartObjects($this->getRefId(), $this->getId());
        $start->cloneDependencies($a_target_id, $a_copy_id);
 
        // Clone course item settings
        ilObjectActivation::cloneDependencies($this->getRefId(), $a_target_id, $a_copy_id);
 
        // clone objective settings
        ilLOSettings::cloneSettings($a_copy_id, $this->getId(), ilObject::_lookupObjId($a_target_id));
 
        // Clone course learning objectives
        $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) {
            $this->course_logger->info('Handling grouping id: ' . $grouping_id);
            $grouping = new \ilObjCourseGrouping($grouping_id);
            $grouping->cloneGrouping($a_target_id, $a_copy_id);
        }
        return true;
    }

References ilObjCourseGrouping\_getGroupings(), ilObject\_lookupObjId(), ilObjectActivation\cloneDependencies(), ilLOSettings\cloneSettings(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

cloneObject()

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

Clone course (no member data)

@access public

Parameters

int	target ref_id
int	copy id

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

                                                                                                : ?ilObject
    {
        global $DIC;
 
        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
 
        $this->cloneAutoGeneratedRoles($new_obj);
        $this->cloneMetaData($new_obj);
 
        $new_obj->getMemberObject()->add($this->user->getId(), ilParticipants::IL_CRS_ADMIN);
        $new_obj->getMemberObject()->updateContact($this->user->getId(), 1);
 
        $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
        if ($cwo->isRootNode($this->getRefId())) {
            $this->setOfflineStatus(true);
        }
 
        $this->cloneSettings($new_obj);
        ilCourseDefinedFieldDefinition::_clone($this->getId(), $new_obj->getId());
        ilCourseFile::_cloneFiles($this->getId(), $new_obj->getId());
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);
        $pathFactory = new ilCertificatePathFactory();
        $templateRepository = new ilCertificateTemplateDatabaseRepository($this->db);
 
        $cloneAction = new ilCertificateCloneAction(
            $this->db,
            $pathFactory,
            $templateRepository,
            $DIC->filesystem()->web(),
            null,
            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;
    }

References $DIC, ilCourseDefinedFieldDefinition\_clone(), ilCourseFile\_cloneFiles(), ilCopyWizardOptions\_getInstance(), ILIAS\Survey\Mode\getId(), ilBadge\getInstancesByParentId(), ilParticipants\IL_CRS_ADMIN, and ILIAS\Repository\user().

Here is the call graph for this function:

cloneSettings()

ilObjCourse::cloneSettings

(

ilObject

$new_obj

)

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

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

References ilMembershipRegistrationCodeUtils\generateCode(), ilObject\setOfflineStatus(), and ilObject\update().

Here is the call graph for this function:

create()

ilObjCourse::create

(

$a_upload = false

)

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

                                             : int
    {
        global $DIC;
 
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
 
        $id = parent::create($a_upload);
 
        if (!$a_upload) {
            $this->createMetaData();
        }
        $this->__createDefaultSettings();
        $this->app_event_handler->raise(
            'Modules/Course',
            'create',
            array('object' => $this,
                  'obj_id' => $this->getId(),
                  'appointments' => $this->prepareAppointments('create')
            )
        );
 
        return $id;
    }

References $DIC, $id, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

delete()

ilObjCourse::delete

(

)

delete course and all related data

@access public

Returns

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

Reimplemented from ilContainer.

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

                            : bool
    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
 
        // delete meta data
        $this->deleteMetaData();
 
        // put here course specific stuff
 
        $this->__deleteSettings();
 
        ilCourseParticipants::_deleteAllEntries($this->getId());
 
        ilCourseObjective::_deleteAll($this->getId());
 
        ilObjCourseGrouping::_deleteAll($this->getId());
 
        ilCourseFile::_deleteByCourse($this->getId());
 
        ilCourseDefinedFieldDefinition::_deleteByContainer($this->getId());
 
        $this->app_event_handler->raise(
            'Modules/Course',
            'delete',
            array('object' => $this,
                  'obj_id' => $this->getId(),
                  'appointments' => $this->prepareAppointments('delete')
            )
        );
        return true;
    }

References ilObjCourseGrouping\_deleteAll(), ilCourseObjective\_deleteAll(), ilParticipants\_deleteAllEntries(), ilCourseDefinedFieldDefinition\_deleteByContainer(), ilCourseFile\_deleteByCourse(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

doMDUpdateListener()

ilObjCourse::doMDUpdateListener ( string  $a_element )

protected

Reimplemented from ilObject.

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

                                                            : void
    {
        switch ($a_element) {
            case 'General':
                // Update ecs content
                $ecs = new ilECSCourseSettings($this);
                $ecs->handleContentUpdate();
                break;
        }
    }

enabledObjectiveView()

ilObjCourse::enabledObjectiveView

(

)

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

                                          : bool
    {
        return $this->view_mode == ilCourseConstants::IL_CRS_VIEW_OBJECTIVE;
    }

References ilCourseConstants\IL_CRS_VIEW_OBJECTIVE.

enabledWaitingList()

ilObjCourse::enabledWaitingList

(

)

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

                                        : bool
    {
        return $this->waiting_list;
    }

References $waiting_list.

enableRegistrationAccessCode()

ilObjCourse::enableRegistrationAccessCode

(

bool

$a_status

)

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

                                                                : void
    {
        $this->reg_access_code_enabled = $a_status;
    }

enableSessionLimit()

ilObjCourse::enableSessionLimit

(

int

$a_status

)

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

                                                     : void
    {
        $this->session_limit = $a_status;
    }

enableSubscriptionMembershipLimitation()

ilObjCourse::enableSubscriptionMembershipLimitation

(

bool

$a_status

)

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

                                                                          : void
    {
        $this->subscription_membership_limitation = $a_status;
    }

enableWaitingList()

ilObjCourse::enableWaitingList

(

bool

$a_status

)

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

                                                     : void
    {
        $this->waiting_list = $a_status;
    }

findCoursesWithNotEnoughMembers()

static ilObjCourse::findCoursesWithNotEnoughMembers ( )

static

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

                                                            : array
    {
        $ilDB = $GLOBALS['DIC']->database();
        $tree = $GLOBALS['DIC']->repositoryTree();
 
        $res = array();
 
        $before = new ilDateTime(time(), IL_CAL_UNIX);
        $now = $before->get(IL_CAL_UNIX);
        $now_dt = $before->get(IL_CAL_DATETIME, '', ilTimeZone::UTC);
 
        $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_dt, ilDBConstants::T_TEXT) . ")");
        while ($row = $ilDB->fetchAssoc($set)) {
            $refs = ilObject::_getAllReferences((int) $row['obj_id']);
            $ref = end($refs);
 
            if ($tree->isDeleted($ref)) {
                continue;
            }
 
            $part = new ilCourseParticipants((int) $row["obj_id"]);
            $reci = $part->getNotificationRecipients();
            if ($reci !== []) {
                $missing = (int) $row["min_members"] - $part->getCountMembers();
                if ($missing > 0) {
                    $res[(int) $row["obj_id"]] = array($missing, $reci);
                }
            }
        }
 
        return $res;
    }

References $GLOBALS, $ilDB, $res, ilObject\_getAllReferences(), IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS\Repository\int(), ilDBConstants\T_TEXT, and ilTimeZone\UTC.

Referenced by ilMembershipCronMinMembers\getCourses().

Here is the call graph for this function:

Here is the caller graph for this function:

getAboStatus()

ilObjCourse::getAboStatus

(

)

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

                                  : bool
    {
        return $this->abo;
    }

getActivationEnd()

ilObjCourse::getActivationEnd

(

)

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

                                      : int
    {
        return $this->activation_end;
    }

References $activation_end.

Referenced by getActivationUnlimitedStatus().

Here is the caller graph for this function:

getActivationStart()

ilObjCourse::getActivationStart

(

)

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

                                        : int
    {
        return $this->activation_start;
    }

References $activation_start.

Referenced by getActivationUnlimitedStatus().

Here is the caller graph for this function:

getActivationUnlimitedStatus()

ilObjCourse::getActivationUnlimitedStatus

(

)

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

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

References getActivationEnd(), and getActivationStart().

Here is the call graph for this function:

getActivationVisibility()

ilObjCourse::getActivationVisibility

(

)

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

                                             : bool
    {
        return $this->activation_visibility;
    }

References $activation_visibility.

getAutoNotification()

ilObjCourse::getAutoNotification

(

)

Returns automatic notification status from $this->auto_notification.

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

                                         : bool
    {
        return $this->auto_notification;
    }

getCancellationEnd()

ilObjCourse::getCancellationEnd

(

)

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

                                        : ?ilDate
    {
        return $this->leave_end;
    }

getContactConsultation()

ilObjCourse::getContactConsultation

(

)

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

                                            : string
    {
        return $this->contact_consultation;
    }

References $contact_consultation.

getContactEmail()

ilObjCourse::getContactEmail

(

)

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

                                     : string
    {
        return $this->contact_email;
    }

References $contact_email.

getContactName()

ilObjCourse::getContactName

(

)

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

                                    : string
    {
        return $this->contact_name;
    }

References $contact_name.

getContactPhone()

ilObjCourse::getContactPhone

(

)

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

                                     : string
    {
        return $this->contact_phone;
    }

References $contact_phone.

getContactResponsibility()

ilObjCourse::getContactResponsibility

(

)

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

                                              : string
    {
        return $this->contact_responsibility;
    }

References $contact_responsibility.

getCourseEnd()

ilObjCourse::getCourseEnd

(

)

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

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

getCourseStart()

ilObjCourse::getCourseStart

(

)

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

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

getCourseStartTimeIndication()

ilObjCourse::getCourseStartTimeIndication

(

)

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

                                                  : bool
    {
        return $this->course_start_time_indication;
    }

getDefaultAdminRole()

ilObjCourse::getDefaultAdminRole

(

)

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

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

References ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

getDefaultCourseRoles()

ilObjCourse::getDefaultCourseRoles

(

string

$a_crs_id = ""

)

get default course roles, returns the defaultlike create roles il_crs_tutor, il_crs_admin and il_crs_member 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 1375 of file class.ilObjCourse.php.

                                                                : array
    {
        if (strlen($a_crs_id) > 0) {
            $crs_id = $a_crs_id;
        } else {
            $crs_id = $this->getRefId();
        }
 
        $role_arr = $this->rbac_review->getRolesOfRoleFolder($crs_id);
 
        $arr_crsDefaultRoles = [];
        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;
    }

getDefaultMemberRole()

ilObjCourse::getDefaultMemberRole

(

)

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

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

References ilObject\_lookupTitle().

Here is the call graph for this function:

getDefaultTutorRole()

ilObjCourse::getDefaultTutorRole

(

)

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

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

References ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

getEnableCourseMap()

ilObjCourse::getEnableCourseMap

(

)

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

                                        : bool
    {
        return $this->enablemap;
    }

getEnableMap()

ilObjCourse::getEnableMap

(

)

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

                                  : bool
    {
        return $this->getEnableCourseMap();
    }

getImportantInformation()

ilObjCourse::getImportantInformation

(

)

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

                                             : string
    {
        return $this->important;
    }

References $important.

getLatitude()

ilObjCourse::getLatitude

(

)

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

                                 : string
    {
        return $this->latitude;
    }

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 @access public

Returns

array [title|id] of roles...

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

                                                             : array
    {
        if (empty($this->local_roles)) {
            $this->local_roles = array();
            $role_arr = $this->rbac_review->getRolesOfRoleFolder($this->getRefId());
 
            foreach ($role_arr as $role_id) {
                if ($this->rbac_review->isAssignable($role_id, $this->getRefId()) == true) {
                    $role_Obj = ilObjectFactory::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;
    }

References ilObjRole\_getTranslation(), and ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

getLocationZoom()

ilObjCourse::getLocationZoom

(

)

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

                                     : int
    {
        return $this->locationzoom;
    }

getLongitude()

ilObjCourse::getLongitude

(

)

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

                                  : string
    {
        return $this->longitude;
    }

getMailToMembersType()

ilObjCourse::getMailToMembersType

(

)

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

                                          : int
    {
        return $this->mail_members;
    }

getMemberObject()

ilObjCourse::getMemberObject

(

)

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

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

getMembersObject()

ilObjCourse::getMembersObject

(

)

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

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

getMessage()

ilObjCourse::getMessage

(

)

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

                                : string
    {
        return $this->message;
    }

References $message.

getNumberOfNextSessions()

ilObjCourse::getNumberOfNextSessions

(

)

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

                                             : int
    {
        return $this->session_next;
    }

References $session_next.

getNumberOfPreviousSessions()

ilObjCourse::getNumberOfPreviousSessions

(

)

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

                                                 : int
    {
        return $this->session_prev;
    }

References $session_prev.

getOrderType()

ilObjCourse::getOrderType

(

)

Reimplemented from ilContainer.

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

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

References ilContainer\SORT_MANUAL.

getRegistrationAccessCode()

ilObjCourse::getRegistrationAccessCode

(

)

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

                                               : string
    {
        return $this->reg_access_code;
    }

References $reg_access_code.

getShowMembers()

ilObjCourse::getShowMembers

(

)

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

                                    : bool
    {
        return $this->show_members;
    }

getShowMembersExport()

ilObjCourse::getShowMembersExport

(

)

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

                                          : bool
    {
        return $this->member_export;
    }

References $member_export.

getStatusDetermination()

ilObjCourse::getStatusDetermination

(

)

Get status determination mode.

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

                                            : int
    {
        return $this->status_dt;
    }

getSubItems()

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

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

     : array {
        // Caching
        if (isset($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,
            $a_admin_panel_enabled,
            $a_include_side_block
        );
        return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getSubscriptionEnd()

ilObjCourse::getSubscriptionEnd

(

)

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

                                        : int
    {
        return $this->subscription_end;
    }

References $subscription_end.

Referenced by inSubscriptionTime().

Here is the caller graph for this function:

getSubscriptionLimitationType()

ilObjCourse::getSubscriptionLimitationType

(

)

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

                                                   : int
    {
        return $this->subscription_limitation_type;
    }

References $subscription_limitation_type.

getSubscriptionMaxMembers()

ilObjCourse::getSubscriptionMaxMembers

(

)

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

                                               : int
    {
        return $this->subscription_max_members;
    }

References $subscription_max_members.

getSubscriptionMinMembers()

ilObjCourse::getSubscriptionMinMembers

(

)

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

                                               : int
    {
        return $this->min_members;
    }

getSubscriptionNotify()

ilObjCourse::getSubscriptionNotify

(

)

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

                                           : bool
    {
        return true;
    }

getSubscriptionPassword()

ilObjCourse::getSubscriptionPassword

(

)

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

                                             : string
    {
        return $this->subscription_password;
    }

References $subscription_password.

getSubscriptionStart()

ilObjCourse::getSubscriptionStart

(

)

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

                                          : int
    {
        return $this->subscription_start;
    }

References $subscription_start.

Referenced by inSubscriptionTime().

Here is the caller graph for this function:

getSubscriptionType()

ilObjCourse::getSubscriptionType

(

)

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

                                         : int
    {
        return $this->subscription_type ?: ilCourseConstants::IL_CRS_SUBSCRIPTION_DIRECT;
    }

References ilCourseConstants\IL_CRS_SUBSCRIPTION_DIRECT.

getSubscriptionUnlimitedStatus()

ilObjCourse::getSubscriptionUnlimitedStatus

(

)

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

                                                    : bool
    {
        return $this->subscription_limitation_type == ilCourseConstants::IL_CRS_SUBSCRIPTION_UNLIMITED;
    }

References ilCourseConstants\IL_CRS_SUBSCRIPTION_UNLIMITED.

Referenced by inSubscriptionTime().

Here is the caller graph for this function:

getSyllabus()

ilObjCourse::getSyllabus

(

)

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

                                 : string
    {
        return $this->syllabus;
    }

References $syllabus.

getTargetGroup()

ilObjCourse::getTargetGroup

(

)

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

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

References $target_group.

getTimingMode()

ilObjCourse::getTimingMode

(

)

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

                                   : int
    {
        return $this->timing_mode;
    }

getViewMode()

ilObjCourse::getViewMode

(

)

Reimplemented from ilContainer.

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

                                 : int
    {
        return $this->view_mode;
    }

handleAutoFill()

ilObjCourse::handleAutoFill

(

)

Handle course auto fill.

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

                                    : void
    {
        if (
            !$this->enabledWaitingList() || !$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()
        $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, ilParticipants::IL_CRS_MEMBER);
            $this->getMembersObject()->sendNotification(ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER, $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;
            }
        }
    }

References ILIAS\Survey\Mode\getId(), ilObjectFactory\getInstanceByObjId(), ilParticipants\IL_CRS_MEMBER, ilParticipants\lookupNumberOfMembers(), and ilCourseMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Here is the call graph for this function:

hasContactData()

ilObjCourse::hasContactData

(

)

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

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

hasWaitingListAutoFill()

ilObjCourse::hasWaitingListAutoFill

(

)

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

                                            : bool
    {
        return $this->auto_fill_from_waiting;
    }

initCourseMemberObject()

ilObjCourse::initCourseMemberObject ( )

protected

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

                                               : void
    {
        $this->member_obj = ilCourseParticipant::_getInstanceByObjId($this->getId(), $this->user->getId());
    }

References ilCourseParticipant\_getInstanceByObjId(), ILIAS\Survey\Mode\getId(), and ILIAS\Repository\user().

Here is the call graph for this function:

initCourseMembersObject()

ilObjCourse::initCourseMembersObject ( )

protected

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

                                                : void
    {
        $this->members_obj = ilCourseParticipants::_getInstanceByObjId($this->getId());
    }

References ilCourseParticipants\_getInstanceByObjId(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

initDefaultRoles()

ilObjCourse::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 set up default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example).

Reimplemented from ilObject.

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

                                      : void
    {
        ilObjRole::createDefaultRole(
            'il_crs_admin_' . $this->getRefId(),
            "Admin of crs obj_no." . $this->getId(),
            'il_crs_admin',
            $this->getRefId()
        );
        ilObjRole::createDefaultRole(
            'il_crs_tutor_' . $this->getRefId(),
            "Tutor of crs obj_no." . $this->getId(),
            'il_crs_tutor',
            $this->getRefId()
        );
        ilObjRole::createDefaultRole(
            'il_crs_member_' . $this->getRefId(),
            "Member of crs obj_no." . $this->getId(),
            'il_crs_member',
            $this->getRefId()
        );
    }

References ilObjRole\createDefaultRole(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

initWaitingList()

ilObjCourse::initWaitingList

(

)

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

                                     : void
    {
        if (!$this->waiting_list_obj instanceof ilCourseWaitingList) {
            $this->waiting_list_obj = new ilCourseWaitingList($this->getId());
        }
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

inSubscriptionTime()

ilObjCourse::inSubscriptionTime

(

)

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

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

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

Here is the call graph for this function:

isActivated()

ilObjCourse::isActivated

(

)

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

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

isRegistrationAccessCodeEnabled()

ilObjCourse::isRegistrationAccessCodeEnabled

(

)

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

                                                     : bool
    {
        return $this->reg_access_code_enabled;
    }

References $reg_access_code_enabled.

isSessionLimitEnabled()

ilObjCourse::isSessionLimitEnabled

(

)

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

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

References $session_limit.

isSubscriptionMembershipLimited()

ilObjCourse::isSubscriptionMembershipLimited

(

)

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

                                                     : bool
    {
        return $this->subscription_membership_limitation;
    }

References $subscription_membership_limitation.

lookupCourseNonMemberTemplatesId()

static ilObjCourse::lookupCourseNonMemberTemplatesId ( )

static

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

                                                             : int
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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 (int) $row['obj_id'];
    }

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

Referenced by ilRbacAdmin\adjustMovedObjectPermissions().

Here is the caller graph for this function:

lookupObjectsByCode()

static ilObjCourse::lookupObjectsByCode ( string  $a_code )

static

See also

interface.ilMembershipRegistrationCodes

Returns

int[]

Implements ilMembershipRegistrationCodes.

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

                                                              : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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[] = (int) $row->obj_id;
        }
        return $obj_ids;
    }

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilMembershipRegistrationCodeUtils\lookupObjectsByCode().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupShowMembersEnabled()

static ilObjCourse::lookupShowMembersEnabled ( int  $a_obj_id )

static

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

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

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

Referenced by ILIAS\Awareness\User\ProviderCurrentCourse\getInitialUserSet(), and ilParticipants\hasParticipantListAccess().

Here is the caller graph for this function:

lookupTimingMode()

static ilObjCourse::lookupTimingMode ( int  $a_obj_id )

static

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

                                                          : int
    {
        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;
    }

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().

Here is the caller graph for this function:

mayLeave()

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

static

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

                                                                                          : bool
    {
        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;
    }

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

Referenced by ilObjCourseAccess\_checkAccess().

Here is the caller graph for this function:

prepareAppointments()

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

protected

Prepare calendar appointments.

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

                                                                     : array
    {
        switch ($a_mode) {
            case 'create':
            case 'update':
                $apps = [];
                if (!$this->getActivationUnlimitedStatus() && !$this->getOfflineStatus()) {
                    $app = new ilCalendarAppointmentTemplate(self::CAL_ACTIVATION_START);
                    $app->setTitle($this->getTitle());
                    $app->setSubtitle('crs_cal_activation_start');
                    $app->setTranslationType(ilCalendarEntry::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(ilCalendarEntry::TRANSLATION_SYSTEM);
                    $app->setDescription($this->getLongDescription());
                    $app->setStart(new ilDateTime($this->getActivationEnd(), IL_CAL_UNIX));
                    $apps[] = $app;
                }
                if ($this->getSubscriptionLimitationType() == ilCourseConstants::IL_CRS_SUBSCRIPTION_LIMITED) {
                    $app = new ilCalendarAppointmentTemplate(self::CAL_REG_START);
                    $app->setTitle($this->getTitle());
                    $app->setSubtitle('crs_cal_reg_start');
                    $app->setTranslationType(ilCalendarEntry::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(ilCalendarEntry::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(ilCalendarEntry::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(ilCalendarEntry::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(ilCalendarEntry::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(ilCalendarEntry::TRANSLATION_SYSTEM);
                            $app->setStart(new ilDate($item['suggestion_end'], IL_CAL_UNIX));
                            $app->setFullday(true);
                            $apps[] = $app;
                        }
                    }
                }
                return $apps;
 
            case 'delete':
                // Nothing to do: The category and all assigned appointments will be deleted.
                return array();
        }
        return [];
    }

References $app, ilObjectActivation\getTimingsItems(), IL_CAL_UNIX, ilCourseConstants\IL_CRS_SUBSCRIPTION_LIMITED, ilCourseConstants\IL_CRS_VIEW_TIMING, ilObjectActivation\TIMINGS_PRESETTING, and ilCalendarEntry\TRANSLATION_SYSTEM.

Here is the call graph for this function:

read()

ilObjCourse::read

(

)

Reimplemented from ilContainer.

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

                          : void
    {
        parent::read();
        $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
        $this->__readSettings();
    }

References ilContainerSortingSettings\_lookupSortMode(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

register()

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

Exceptions

ilMembershipRegistrationException

See also

ilMembershipRegistrationCodes::register()

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

     : void {
        if ($this->getMembersObject()->isAssigned($a_user_id)) {
            return;
        }
 
        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() == ilCourseConstants::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() == ilCourseConstants::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() - $this->getMembersObject()->getCountMembers());
                $waiting_list = new ilCourseWaitingList($this->getId());
                if ($this->enabledWaitingList() && (!$free || $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)
                    );
                    $participants = ilCourseParticipants::_getInstanceByObjId($this->getId());
                    $participants->sendNotification(
                        ilCourseMembershipMailNotification::TYPE_WAITING_LIST_MEMBER,
                        $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);
                }
            }
        }
 
        $this->getMembersObject()->add($a_user_id, $a_role);
        $this->getMembersObject()->sendNotification(ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER, $a_user_id);
        $this->getMembersObject()->sendNotification(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_ADMINS, $a_user_id);
        ilForumNotification::checkForumsExistsInsert($this->getRefId(), $a_user_id);
    }

References ilCourseParticipants\_getInstanceByObjId(), ilObjCourseAccess\_isActivated(), ilObjCourseAccess\_isOffline(), ilObjCourseAccess\_usingRegistrationCode(), ilMembershipRegistrationException\ADDED_TO_WAITINGLIST, ilForumNotification\checkForumsExistsInsert(), ILIAS\Survey\Mode\getId(), ilCourseConstants\IL_CRS_SUBSCRIPTION_DEACTIVATED, ilCourseConstants\IL_CRS_SUBSCRIPTION_LIMITED, ILIAS\Repository\lng(), ilMembershipRegistrationException\OBJECT_IS_FULL, ilMembershipRegistrationException\OUT_OF_REGISTRATION_PERIOD, ilMembershipRegistrationException\REGISTRATION_CODE_DISABLED, ilMembershipRegistrationException\REGISTRATION_INVALID_AVAILABILITY, ilMembershipRegistrationException\REGISTRATION_INVALID_OFFLINE, ilCourseMembershipMailNotification\TYPE_ADMISSION_MEMBER, ilCourseMembershipMailNotification\TYPE_NOTIFICATION_ADMINS, and ilCourseMembershipMailNotification\TYPE_WAITING_LIST_MEMBER.

Here is the call graph for this function:

setAboStatus()

ilObjCourse::setAboStatus

(

bool

$a_status

)

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

                                                : void
    {
        $this->abo = $a_status;
    }

setActivationEnd()

ilObjCourse::setActivationEnd

(

int

$a_value

)

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

                                                  : void
    {
        $this->activation_end = $a_value;
    }

setActivationStart()

ilObjCourse::setActivationStart

(

int

$a_value

)

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

                                                    : void
    {
        $this->activation_start = $a_value;
    }

setActivationVisibility()

ilObjCourse::setActivationVisibility

(

bool

$a_value

)

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

                                                          : void
    {
        $this->activation_visibility = $a_value;
    }

setAutoNotification()

ilObjCourse::setAutoNotification

(

bool

$value

)

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

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

                                                    : void
    {
        $this->auto_notification = $value;
    }

setCancellationEnd()

ilObjCourse::setCancellationEnd

(

?ilDate

$a_value = null

)

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

                                                               : void
    {
        $this->leave_end = $a_value;
    }

setContactConsultation()

ilObjCourse::setContactConsultation

(

string

$a_value

)

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

                                                           : void
    {
        $this->contact_consultation = $a_value;
    }

setContactEmail()

ilObjCourse::setContactEmail

(

string

$a_value

)

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

                                                    : void
    {
        $this->contact_email = $a_value;
    }

setContactName()

ilObjCourse::setContactName

(

string

$a_cn

)

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

                                                : void
    {
        $this->contact_name = $a_cn;
    }

setContactPhone()

ilObjCourse::setContactPhone

(

string

$a_value

)

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

                                                    : void
    {
        $this->contact_phone = $a_value;
    }

setContactResponsibility()

ilObjCourse::setContactResponsibility

(

string

$a_value

)

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

                                                             : void
    {
        $this->contact_responsibility = $a_value;
    }

setCourseEnd()

ilObjCourse::setCourseEnd ( ?ilDateTime  $a_value = null )

protected

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

                                                                : void
    {
        $this->crs_end = $a_value;
    }

setCoursePeriod()

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

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

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

setCourseStart()

ilObjCourse::setCourseStart ( ?ilDateTime  $a_value = null )

protected

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

                                                                  : void
    {
        $this->crs_start = $a_value;
    }

setEnableCourseMap()

ilObjCourse::setEnableCourseMap

(

bool

$a_enablemap

)

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

                                                         : void
    {
        $this->enablemap = $a_enablemap;
    }

setImportantInformation()

ilObjCourse::setImportantInformation

(

string

$a_info

)

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

                                                           : void
    {
        $this->important = $a_info;
    }

setLatitude()

ilObjCourse::setLatitude

(

string

$a_latitude

)

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

                                                   : void
    {
        $this->latitude = $a_latitude;
    }

setLocationZoom()

ilObjCourse::setLocationZoom

(

int

$a_locationzoom

)

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

                                                        : void
    {
        $this->locationzoom = $a_locationzoom;
    }

setLongitude()

ilObjCourse::setLongitude

(

string

$a_longitude

)

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

                                                     : void
    {
        $this->longitude = $a_longitude;
    }

setMailToMembersType()

ilObjCourse::setMailToMembersType

(

int

$a_type

)

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

                                                     : void
    {
        $this->mail_members = $a_type;
    }

setMessage()

ilObjCourse::setMessage

(

string

$a_message

)

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

                                                 : void
    {
        $this->message = $a_message;
    }

setNumberOfNextSessions()

ilObjCourse::setNumberOfNextSessions

(

int

$a_num

)

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

                                                       : void
    {
        $this->session_next = $a_num;
    }

setNumberOfPreviousSessions()

ilObjCourse::setNumberOfPreviousSessions

(

int

$a_num

)

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

                                                           : void
    {
        $this->session_prev = $a_num;
    }

setParentRolePermissions()

ilObjCourse::setParentRolePermissions

(

int

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

Reimplemented from ilObject.

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

                                                               : bool
    {
        $parent_roles = $this->rbac_review->getParentRoleIds($a_parent_ref);
        foreach ($parent_roles as $parent_role) {
            $this->rbac_admin->initIntersectionPermissions(
                $this->getRefId(),
                $parent_role['obj_id'],
                $parent_role['parent'],
                $this->__getCrsNonMemberTemplateId(),
                ROLE_FOLDER_ID
            );
        }
        return true;
    }

References ROLE_FOLDER_ID.

setRegistrationAccessCode()

ilObjCourse::setRegistrationAccessCode

(

string

$a_code

)

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

                                                             : void
    {
        $this->reg_access_code = $a_code;
    }

setShowMembers()

ilObjCourse::setShowMembers

(

bool

$a_status

)

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

                                                  : void
    {
        $this->show_members = $a_status;
    }

setShowMembersExport()

ilObjCourse::setShowMembersExport

(

bool

$a_mem_export

)

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

                                                            : void
    {
        $this->member_export = $a_mem_export;
    }

setStatusDetermination()

ilObjCourse::setStatusDetermination

(

int

$a_value

)

Set status determination mode.

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

                                                        : void
    {
        $a_value = $a_value;
 
        // #13905
        if ($a_value == self::STATUS_DETERMINATION_LP) {
            if (!ilObjUserTracking::_enabledLearningProgress()) {
                $a_value = self::STATUS_DETERMINATION_MANUAL;
            }
        }
 
        $this->status_dt = $a_value;
    }

References ilObjUserTracking\_enabledLearningProgress().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

setSubscriptionEnd()

ilObjCourse::setSubscriptionEnd

(

int

$a_value

)

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

                                                    : void
    {
        $this->subscription_end = $a_value;
    }

setSubscriptionLimitationType()

ilObjCourse::setSubscriptionLimitationType

(

int

$a_type

)

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

                                                              : void
    {
        $this->subscription_limitation_type = $a_type;
    }

setSubscriptionMaxMembers()

ilObjCourse::setSubscriptionMaxMembers

(

int

$a_value

)

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

                                                           : void
    {
        $this->subscription_max_members = $a_value;
    }

setSubscriptionMinMembers()

ilObjCourse::setSubscriptionMinMembers

(

int

$a_value

)

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

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

setSubscriptionPassword()

ilObjCourse::setSubscriptionPassword

(

string

$a_value

)

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

                                                            : void
    {
        $this->subscription_password = $a_value;
    }

setSubscriptionStart()

ilObjCourse::setSubscriptionStart

(

int

$a_value

)

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

                                                      : void
    {
        $this->subscription_start = $a_value;
    }

setSubscriptionType()

ilObjCourse::setSubscriptionType

(

int

$a_value

)

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

                                                     : void
    {
        $this->subscription_type = $a_value;
    }

setSyllabus()

ilObjCourse::setSyllabus

(

string

$a_syllabus

)

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

                                                   : void
    {
        $this->syllabus = $a_syllabus;
    }

setTargetGroup()

ilObjCourse::setTargetGroup

(

?string

$a_tg

)

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

                                                 : void
    {
        $this->target_group = $a_tg;
    }

setTimingMode()

ilObjCourse::setTimingMode

(

int

$a_mode

)

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

                                              : void
    {
        $this->timing_mode = $a_mode;
    }

setViewMode()

ilObjCourse::setViewMode

(

int

$a_mode

)

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

                                            : void
    {
        $this->view_mode = $a_mode;
    }

setWaitingListAutoFill()

ilObjCourse::setWaitingListAutoFill

(

bool

$a_value

)

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

                                                         : void
    {
        $this->auto_fill_from_waiting = $a_value;
    }

syncMembersStatusWithLP()

ilObjCourse::syncMembersStatusWithLP

(

)

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

                                             : void
    {
        foreach ($this->getMembersObject()->getParticipants() as $user_id) {
            // #15529 - force raise on sync
            ilLPStatusWrapper::_updateStatus($this->getId(), $user_id, null, false, true);
        }
    }

References ilLPStatusWrapper\_updateStatus(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

toggleCourseStartTimeIndication()

ilObjCourse::toggleCourseStartTimeIndication ( bool  $time_indication )

protected

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

                                                                             : void
    {
        $this->course_start_time_indication = $time_indication;
    }

update()

ilObjCourse::update

(

)

@inheritDoc

Reimplemented from ilContainer.

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

                            : bool
    {
        $sorting = new ilContainerSortingSettings($this->getId());
        $sorting->setSortMode($this->getOrderType());
        $sorting->update();
 
        $this->updateMetaData();
        $this->updateSettings();
        parent::update();
 
        $this->app_event_handler->raise(
            'Modules/Course',
            'update',
            array('object' => $this,
                  'obj_id' => $this->getId(),
                  'appointments' => $this->prepareAppointments('update')
            )
        );
        return true;
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

updateSettings()

ilObjCourse::updateSettings

(

)

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

                                    : void
    {
        $query = "SELECT * FROM crs_settings WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . " ";
        $res = $this->db->query($query);
 
        if (!$res->numRows()) {
            $this->__createDefaultSettings();
        }
 
        $query = "UPDATE crs_settings SET " .
            "syllabus = " . $this->db->quote($this->getSyllabus(), 'text') . ", " .
            "contact_name = " . $this->db->quote($this->getContactName(), 'text') . ", " .
            "contact_responsibility = " . $this->db->quote($this->getContactResponsibility(), 'text') . ", " .
            "contact_phone = " . $this->db->quote($this->getContactPhone(), 'text') . ", " .
            "contact_email = " . $this->db->quote($this->getContactEmail(), 'text') . ", " .
            "contact_consultation = " . $this->db->quote($this->getContactConsultation(), 'text') . ", " .
            "activation_type = " . $this->db->quote(!$this->getOfflineStatus(), 'integer') . ", " .
            "sub_limitation_type = " . $this->db->quote($this->getSubscriptionLimitationType(), 'integer') . ", " .
            "sub_start = " . $this->db->quote($this->getSubscriptionStart(), 'integer') . ", " .
            "sub_end = " . $this->db->quote($this->getSubscriptionEnd(), 'integer') . ", " .
            "sub_type = " . $this->db->quote($this->getSubscriptionType(), 'integer') . ", " .
            "sub_password = " . $this->db->quote($this->getSubscriptionPassword(), 'text') . ", " .
            "sub_mem_limit = " . $this->db->quote((int) $this->isSubscriptionMembershipLimited(), 'integer') . ", " .
            "sub_max_members = " . $this->db->quote($this->getSubscriptionMaxMembers(), 'integer') . ", " .
            "sub_notify = " . $this->db->quote($this->getSubscriptionNotify(), 'integer') . ", " .
            "view_mode = " . $this->db->quote($this->getViewMode(), 'integer') . ", " .
            'timing_mode = ' . $this->db->quote($this->getTimingMode(), 'integer') . ', ' .
            "abo = " . $this->db->quote($this->getAboStatus(), 'integer') . ", " .
            "waiting_list = " . $this->db->quote($this->enabledWaitingList(), 'integer') . ", " .
            "important = " . $this->db->quote($this->getImportantInformation(), 'text') . ", " .
            'target_group = ' . $this->db->quote($this->getTargetGroup(), \ilDBConstants::T_TEXT) . ', ' .
            "show_members = " . $this->db->quote($this->getShowMembers(), 'integer') . ", " .
            "show_members_export = " . $this->db->quote($this->getShowMembersExport(), 'integer') . ", " .
            "latitude = " . $this->db->quote($this->getLatitude(), 'text') . ", " .
            "longitude = " . $this->db->quote($this->getLongitude(), 'text') . ", " .
            "location_zoom = " . $this->db->quote($this->getLocationZoom(), 'integer') . ", " .
            "enable_course_map = " . $this->db->quote((int) $this->getEnableCourseMap(), 'integer') . ", " .
            'session_limit = ' . $this->db->quote($this->isSessionLimitEnabled(), 'integer') . ', ' .
            'session_prev = ' . $this->db->quote($this->getNumberOfPreviousSessions(), 'integer') . ', ' .
            'session_next = ' . $this->db->quote($this->getNumberOfNextSessions(), 'integer') . ', ' .
            'reg_ac_enabled = ' . $this->db->quote($this->isRegistrationAccessCodeEnabled(), 'integer') . ', ' .
            'reg_ac = ' . $this->db->quote($this->getRegistrationAccessCode(), 'text') . ', ' .
            'auto_notification = ' . $this->db->quote((int) $this->getAutoNotification(), 'integer') . ', ' .
            'status_dt = ' . $this->db->quote($this->getStatusDetermination(), ilDBConstants::T_INTEGER) . ', ' .
            'mail_members_type = ' . $this->db->quote($this->getMailToMembersType(), 'integer') . ', ' .
            'period_start = ' . $this->db->quote(
                \ilCalendarUtil::convertDateToUtcDBTimestamp($this->getCourseStart()),
                \ilDBConstants::T_TIMESTAMP
            ) . ', ' .
            'period_end = ' . $this->db->quote(
                \ilCalendarUtil::convertDateToUtcDBTimestamp($this->getCourseEnd()),
                \ilDBConstants::T_TIMESTAMP
            ) . ', ' .
            'period_time_indication = ' . $this->db->quote(
                $this->getCourseStartTimeIndication() ? 1 : 0,
                \ilDBConstants::T_INTEGER
            ) . ', ' .
            'auto_wait = ' . $this->db->quote((int) $this->hasWaitingListAutoFill(), 'integer') . ', ' .
            'leave_end = ' . $this->db->quote(
                ($this->getCancellationEnd() && !$this->getCancellationEnd()->isNull()) ? $this->getCancellationEnd()->get(IL_CAL_UNIX) : null,
                'integer'
            ) . ', ' .
            'min_members = ' . $this->db->quote($this->getSubscriptionMinMembers(), 'integer') . '  ' .
            "WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . "";
 
        $res = $this->db->manipulate($query);
 
        // moved activation to ilObjectActivation
        if ($this->ref_id ?? false) {
            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);
        }
    }

References $query, $res, ilCalendarUtil\convertDateToUtcDBTimestamp(), ILIAS\Survey\Mode\getId(), ilObjectActivation\getItem(), IL_CAL_UNIX, ilDBConstants\T_INTEGER, ilDBConstants\T_TEXT, ilDBConstants\T_TIMESTAMP, ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

Here is the call graph for this function:

validate()

ilObjCourse::validate

(

)

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

                              : bool
    {
        $this->setMessage('');
 
        if (($this->getSubscriptionLimitationType() == ilCourseConstants::IL_CRS_SUBSCRIPTION_LIMITED) and
            $this->getSubscriptionStart() > $this->getSubscriptionEnd()) {
            $this->appendMessage($this->lng->txt("subscription_times_not_valid"));
        }
        if ($this->getSubscriptionType() == ilCourseConstants::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'));
        }
        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 strlen($this->getMessage()) > 0;
    }

References IL_CAL_UNIX, ilCourseConstants\IL_CRS_SUBSCRIPTION_LIMITED, ilCourseConstants\IL_CRS_SUBSCRIPTION_PASSWORD, and ILIAS\Repository\lng().

Here is the call graph for this function:

validateInfoSettings()

ilObjCourse::validateInfoSettings

(

)

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

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

References $email, error(), ilObjUser\getUserIdByLogin(), ilUtil\is_email(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

$abo

bool ilObjCourse::$abo = true

private

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

$activation_end

int ilObjCourse::$activation_end = 0

private

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

Referenced by getActivationEnd().

$activation_start

int ilObjCourse::$activation_start = 0

private

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

Referenced by getActivationStart().

$activation_visibility

bool ilObjCourse::$activation_visibility = false

private

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

Referenced by getActivationVisibility().

$auto_fill_from_waiting

bool ilObjCourse::$auto_fill_from_waiting = false

private

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

$auto_notification

bool ilObjCourse::$auto_notification = true

private

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

$contact_consultation

string ilObjCourse::$contact_consultation = ''

private

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

Referenced by getContactConsultation().

$contact_email

string ilObjCourse::$contact_email = ''

private

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

Referenced by getContactEmail().

$contact_name

string ilObjCourse::$contact_name = ''

private

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

Referenced by getContactName().

$contact_phone

string ilObjCourse::$contact_phone = ''

private

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

Referenced by getContactPhone().

$contact_responsibility

string ilObjCourse::$contact_responsibility = ''

private

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

Referenced by getContactResponsibility().

$course_logger

ilLogger ilObjCourse::$course_logger

private

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

$course_start_time_indication

bool ilObjCourse::$course_start_time_indication = true

private

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

$crs_end

ilDateTime ilObjCourse::$crs_end = null

private

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

$crs_start

ilDateTime ilObjCourse::$crs_start = null

private

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

$crs_start_time_indication

bool ilObjCourse::$crs_start_time_indication = false

private

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

$enablemap

bool ilObjCourse::$enablemap = false

private

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

$important

string ilObjCourse::$important = ''

private

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

Referenced by getImportantInformation().

$latitude

string ilObjCourse::$latitude = ''

private

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

$leave_end

ilDate ilObjCourse::$leave_end = null

private

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

$locationzoom

int ilObjCourse::$locationzoom = 0

private

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

$longitude

string ilObjCourse::$longitude = ''

private

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

$mail_members

int ilObjCourse::$mail_members = ilCourseConstants::MAIL_ALLOWED_ALL

private

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

$member_export

bool ilObjCourse::$member_export = false

private

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

Referenced by getShowMembersExport().

$member_obj

ilCourseParticipant ilObjCourse::$member_obj = null

private

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

$members_obj

ilCourseParticipants ilObjCourse::$members_obj = null

private

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

$message

string ilObjCourse::$message = ''

private

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

$min_members

int ilObjCourse::$min_members = 0

private

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

$reg_access_code

string ilObjCourse::$reg_access_code = ''

private

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

Referenced by getRegistrationAccessCode().

$reg_access_code_enabled

bool ilObjCourse::$reg_access_code_enabled = false

private

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

Referenced by isRegistrationAccessCodeEnabled().

$session_limit

int ilObjCourse::$session_limit = 0

private

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

Referenced by isSessionLimitEnabled().

$session_next

int ilObjCourse::$session_next = -1

private

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

Referenced by getNumberOfNextSessions().

$session_prev

int ilObjCourse::$session_prev = -1

private

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

Referenced by getNumberOfPreviousSessions().

$show_members

bool ilObjCourse::$show_members = true

private

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

$status_dt

int ilObjCourse::$status_dt = 0

private

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

$subscription_end

int ilObjCourse::$subscription_end = 0

private

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

Referenced by getSubscriptionEnd().

$subscription_limitation_type

int ilObjCourse::$subscription_limitation_type = 0

private

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

Referenced by getSubscriptionLimitationType().

$subscription_max_members

int ilObjCourse::$subscription_max_members = 0

private

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

Referenced by getSubscriptionMaxMembers().

$subscription_membership_limitation

bool ilObjCourse::$subscription_membership_limitation = false

private

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

Referenced by isSubscriptionMembershipLimited().

$subscription_password

string ilObjCourse::$subscription_password = ''

private

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

Referenced by getSubscriptionPassword().

$subscription_start

int ilObjCourse::$subscription_start = 0

private

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

Referenced by getSubscriptionStart().

$subscription_type

int ilObjCourse::$subscription_type = 0

private

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

$syllabus

string ilObjCourse::$syllabus = ''

private

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

Referenced by getSyllabus().

$target_group

string ilObjCourse::$target_group = null

private

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

Referenced by getTargetGroup().

$timing_mode

int ilObjCourse::$timing_mode = ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE

private

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

$view_mode

int ilObjCourse::$view_mode = 0

private

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

$waiting_list

bool ilObjCourse::$waiting_list = false

private

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

Referenced by enabledWaitingList().

$waiting_list_obj

ilCourseWaitingList ilObjCourse::$waiting_list_obj = null

private

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

CAL_ACTIVATION_END

const ilObjCourse::CAL_ACTIVATION_END = 4

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

CAL_ACTIVATION_START

const ilObjCourse::CAL_ACTIVATION_START = 3

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

CAL_COURSE_END

const ilObjCourse::CAL_COURSE_END = 6

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

CAL_COURSE_START

const ilObjCourse::CAL_COURSE_START = 5

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

CAL_COURSE_TIMING_END

const ilObjCourse::CAL_COURSE_TIMING_END = 8

Definition at line 33 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 32 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 27 of file class.ilObjCourse.php.

CAL_REG_START

const ilObjCourse::CAL_REG_START = 1

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

STATUS_DETERMINATION_LP

const ilObjCourse::STATUS_DETERMINATION_LP = 1

Definition at line 35 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 36 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