Inheritance diagram for ilObjectActivation:

Collaboration diagram for ilObjectActivation:

Public Member Functions
	__construct ()

	setTimingType ($a_type)
	Set timing type. More...

	getTimingType ()
	get timing type More...

	setTimingStart ($a_start)
	Set timing start. More...

	getTimingStart ()
	Get timing start. More...

	setTimingEnd ($a_end)
	Set timing end. More...

	getTimingEnd ()
	Get timing end. More...

	setSuggestionStart ($a_start)
	Set suggestion start. More...

	getSuggestionStart ()
	Get suggestion start. More...

	getSuggestionStartRelative ()

	setSuggestionStartRelative ($a_start)

	getSuggestionEndRelative ()

	setSuggestionEndRelative ($a_end)

	getEaliestStartRelative ()

	setEarliestStartRelative ($a_start)

	setSuggestionEnd ($a_end)
	Set suggestion end. More...

	getSuggestionEnd ()
	Get suggestion end. More...

	setEarliestStart ($a_start)
	Set earliest start. More...

	getEarliestStart ()
	Get earliest start. More...

	toggleVisible ($a_status)
	Set visible status. More...

	enabledVisible ()
	Get visible status. More...

	toggleChangeable ($a_status)
	Set changeable status. More...

	enabledChangeable ()
	Get changeable status. More...

	validateActivation ()
	Validate current properties. More...

	validateRelativePlaning ()

	update ($a_ref_id, $a_parent_id=null)
	Update db entry. More...

	read ($a_ref_id, $a_parent_id=0)

Static Public Member Functions
static	preloadData (array $a_ref_ids)
	Preload data to internal cache. More...

static	getItem ($a_ref_id)
	Get item data. More...

static	addAdditionalSubItemInformation (array &$a_item)
	Parse item data for list entries. More...

static	addListGUIActivationProperty (ilObjectListGUI $a_list_gui, array &$a_item)
	Get timing details for list gui. More...

static	deleteAllEntries ($a_ref_id)
	Delete all db entries for ref id. More...

static	cloneDependencies ($a_ref_id, $a_target_id, $a_copy_id)
	Clone dependencies. More...

static	hasTimings ($a_ref_id)
	Check if there is any active timing (in subtree) More...

static	hasChangeableTimings ($a_ref_id)
	Check if there is any active changeable timing (in subtree) More...

static	getItemsByEvent ($a_event_id)
	Get session material / event items. More...

static	getItemsByItemGroup ($a_item_group_ref_id)
	Get materials of item group. More...

static	getItemsByObjective ($a_objective_id)
	Get objective items. More...

static	getItems ($a_parent_id, $a_with_list_data=true)
	Get sub item data. More...

static	getTimingsAdministrationItems ($a_parent_id)
	Get (sub) item data for timings administration view (active/inactive) More...

static	getTimingsItems ($a_container_ref_id)
	Get (sub) item data for timings view (no session material, no side blocks) More...

Data Fields
const	ERR_SUG_START_END = 1

const	TIMINGS_ACTIVATION = 0

const	TIMINGS_DEACTIVATED = 1

const	TIMINGS_PRESETTING = 2

const	TIMINGS_FIXED = 3

Static Protected Member Functions
static	createDefaultEntry ($a_ref_id)
	Create db entry with default values. More...

static	processListItems (array $a_ref_ids)
	Validate ref ids and add list data. More...

Protected Attributes
	$error

	$lng

	$db

	$timing_type

	$timing_start

	$timing_end

	$suggestion_start

	$suggestion_end

	$visible

	$changeable

	$suggestion_start_rel

	$suggestion_end_rel

Static Protected Attributes
static	$preloaded_data = array()

Detailed Description

Class ilObjectActivation.

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

Version

Id: class.ilCourseItems.php 30321 2011-08-22 12:05:03Z jluetzen

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectActivation::__construct ( )

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

References $DIC.

     {
         global $DIC;
 
         $this->error = $DIC["ilErr"];
         $this->lng = $DIC->language();
         $this->db = $DIC->database();
     }

Member Function Documentation

◆ addAdditionalSubItemInformation()

static ilObjectActivation::addAdditionalSubItemInformation ( array & $a_item )

static

Parse item data for list entries.

Parameters

array &$a_item

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

References $DIC, $ilUser, $info, ilSessionAppointment\_lookupAppointment(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilTimingUser\getStart(), and IL_CAL_UNIX.

Referenced by ilObjCategory\addAdditionalSubItemInformation(), ilObjRootFolder\addAdditionalSubItemInformation(), ilObjFolder\addAdditionalSubItemInformation(), ilObjGroup\addAdditionalSubItemInformation(), and ilObjCourse\addAdditionalSubItemInformation().

     {
         global $DIC;
 
         $ilUser = $DIC->user();
         
         $item = self::getItem($a_item['ref_id']);
         
         $a_item['obj_id'] = ($a_item['obj_id'] > 0)
             ? $a_item['obj_id']
             : ilObject::_lookupObjId($a_item['ref_id']);
         $a_item['type'] = ($a_item['type'] != '')
             ? $a_item['type']
             : ilObject::_lookupType($a_item['obj_id']);
         
         $a_item['timing_type'] = $item['timing_type'];
         
         if ($item['changeable'] &&
             $item['timing_type'] == self::TIMINGS_PRESETTING) {
             // cognos-blu-patch: begin
             include_once './Modules/Course/classes/Timings/class.ilTimingUser.php';
             $user_data = new ilTimingUser($a_item['ref_id'], $ilUser->getId());
             if ($user_data->isScheduled()) {
                 $a_item['start'] = $user_data->getStart()->get(IL_CAL_UNIX);
                 $a_item['end'] = $user_data->getEnd()->get(IL_CAL_UNIX);
                 $a_item['activation_info'] = 'crs_timings_planed_info';
             } else {
                 $a_item['start'] = $item['suggestion_start'];
                 $a_item['end'] = $item['suggestion_end'];
                 $a_item['activation_info'] = 'crs_timings_suggested_info';
             }
             // cognos-blu-patch: end
         } elseif ($item['timing_type'] == self::TIMINGS_PRESETTING) {
             $a_item['start'] = $item['suggestion_start'];
             $a_item['end'] = $item['suggestion_end'];
             $a_item['activation_info'] = 'crs_timings_suggested_info';
         } elseif ($item['timing_type'] == self::TIMINGS_ACTIVATION) {
             $a_item['start'] = $item['timing_start'];
             $a_item['end'] = $item['timing_end'];
             $a_item['activation_info'] = 'obj_activation_list_gui';
         } else {
             $a_item['start'] = 'abc';
         }
         
         // #7359 - session sorting should always base on appointment date
         if ($a_item['type'] == 'sess') {
             include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
             $info = ilSessionAppointment::_lookupAppointment($a_item['obj_id']);
 
             // #11987
             $a_item['masked_start'] = $a_item['start'];
             $a_item['masked_end'] = $a_item['end'];
             $a_item['start'] = $info['start'];
             $a_item['end'] = $info['end'];
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addListGUIActivationProperty()

static ilObjectActivation::addListGUIActivationProperty	(	ilObjectListGUI	$a_list_gui,
		array &	$a_item
	)

static

Get timing details for list gui.

Parameters

ilObjectListGUI	$a_list_gui
array	&$a_item

Returns: array caption, value

Definition at line 447 of file class.ilObjectActivation.php.

References $DIC, $end, $lng, $start, ilObjectListGUI\addCustomProperty(), ilDatePresentation\formatPeriod(), IL_CAL_UNIX, TIMINGS_ACTIVATION, and TIMINGS_PRESETTING.

Referenced by ilSearchResultTableGUI\fillRow(), ilObjSessionGUI\modifyItemGUI(), ilContainerContentGUI\renderItem(), and ilPDSelectedItemsBlockGUI\setFooterLinks().

     {
         global $DIC;
 
         $lng = $DIC->language();
         
         self::addAdditionalSubItemInformation($a_item);
         if (isset($a_item['timing_type'])) {
             if (!isset($a_item['masked_start'])) {
                 $start = $a_item['start'];
                 $end = $a_item['end'];
             } else {
                 $start = $a_item['masked_start'];
                 $end = $a_item['masked_end'];
             }
             $activation = '';
             switch ($a_item['timing_type']) {
                 case ilObjectActivation::TIMINGS_ACTIVATION:
                     $activation = ilDatePresentation::formatPeriod(
                         new ilDateTime($start, IL_CAL_UNIX),
                         new ilDateTime($end, IL_CAL_UNIX)
                     );
                     break;
                         
                 case ilObjectActivation::TIMINGS_PRESETTING:
                     $activation = ilDatePresentation::formatPeriod(
                         new ilDate($start, IL_CAL_UNIX),
                         new ilDate($end, IL_CAL_UNIX)
                     );
                     break;
             }
             if ($activation != "") {
                 global $DIC;
 
                 $lng = $DIC->language();
                 $lng->loadLanguageModule('crs');
                 
                 $a_list_gui->addCustomProperty(
                     $lng->txt($a_item['activation_info']),
                     $activation,
                     false,
                     true
                 );
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneDependencies()

static ilObjectActivation::cloneDependencies	(	$a_ref_id,
		$a_target_id,
		$a_copy_id
	)

static

Clone dependencies.

Parameters

int	$a_ref_id
int	$a_target_id
int	$a_copy_id

Definition at line 595 of file class.ilObjectActivation.php.

References $DIC, $ilLog, ilCopyWizardOptions\_getInstance(), and ilObjectFactory\getInstanceByRefId().

Referenced by ilObjFolder\cloneDependencies(), ilObjGroup\cloneDependencies(), and ilObjCourse\cloneDependencies().

     {
         global $DIC;
 
         $ilLog = $DIC["ilLog"];
         
         $ilLog->write(__METHOD__ . ': Begin course items...' . $a_ref_id);
                 
         $items = self::getItems($a_ref_id, false);
         if (!$items) {
             $ilLog->write(__METHOD__ . ': No course items found.');
             return true;
         }
         
         // new course item object
         if (!is_object($new_container = ilObjectFactory::getInstanceByRefId($a_target_id, false))) {
             $ilLog->write(__METHOD__ . ': Cannot create target object.');
             return false;
         }
         
         include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
         $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
         $mappings = $cp_options->getMappings();
              
         foreach ($items as $item) {
             if (!isset($mappings[$item['parent_id']]) or !$mappings[$item['parent_id']]) {
                 $ilLog->write(__METHOD__ . ': No mapping for parent nr. ' . $item['parent_id']);
                 continue;
             }
             if (!isset($mappings[$item['obj_id']]) or !$mappings[$item['obj_id']]) {
                 $ilLog->write(__METHOD__ . ': No mapping for item nr. ' . $item['obj_id']);
                 continue;
             }
             $new_item_id = $mappings[$item['obj_id']];
             $new_parent = $mappings[$item['parent_id']];
             
             $new_item = new self();
             $new_item->setTimingType($item['timing_type']);
             $new_item->setTimingStart($item['timing_start']);
             $new_item->setTimingEnd($item['timing_end']);
             $new_item->setSuggestionStart($item['suggestion_start']);
             $new_item->setSuggestionEnd($item['suggestion_end']);
             $new_item->toggleChangeable($item['changeable']);
             $new_item->toggleVisible($item['visible']);
             $new_item->update($new_item_id, $new_parent);
             $new_item->setSuggestionStartRelative($item['suggestion_start_rel']);
             $new_item->setSuggestionEndRelative($item['suggestion_end_rel']);
             $new_item->createDefaultEntry($new_item_id);
             $new_item->update($new_item_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDefaultEntry()

static ilObjectActivation::createDefaultEntry ( $a_ref_id )

staticprotected

Create db entry with default values.

Parameters

int $a_ref_id

Returns: array

Definition at line 500 of file class.ilObjectActivation.php.

References $DIC, $ilDB, $query, $tree, ilDBInterface\manipulate(), ilDBInterface\numRows(), ilDBInterface\query(), and ilDBInterface\quote().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $tree = $DIC->repositoryTree();
         
         $parent_id = $tree->getParentId($a_ref_id);
         if (!$parent_id) {
             return;
         }
         
 
         $ilAtomQuery = $ilDB->buildAtomQuery();
         $ilAtomQuery->addTableLock("crs_items");
 
         $ilAtomQuery->addQueryCallable(function (ilDBInterface $ilDB) use ($a_ref_id, $parent_id, &$a_item) {
             $sql = "SELECT * FROM crs_items" .
                 " WHERE obj_id = " . $ilDB->quote($a_ref_id, "integer");
             $set = $ilDB->query($sql);
             if (!$ilDB->numRows($set)) {
                 $now = time();
                 $now_parts = getdate($now);
 
                 $a_item = array();
                 $a_item["timing_type"] = self::TIMINGS_DEACTIVATED;
                 $a_item["timing_start"] = $now;
                 $a_item["timing_end"] = $now;
                 $a_item["suggestion_start"] = $now;
                 $a_item["suggestion_end"] = $now;
                 $a_item['visible'] = 0;
                 $a_item['changeable'] = 0;
                 
                 $query = "INSERT INTO crs_items (parent_id,obj_id,timing_type,timing_start,timing_end," .
                     "suggestion_start,suggestion_end, " .
                     "changeable,visible,suggestion_start_rel, suggestion_end_rel, position) " .
                     "VALUES( " .
                     $ilDB->quote($parent_id, 'integer') . "," .
                     $ilDB->quote($a_ref_id, 'integer') . "," .
                     $ilDB->quote($a_item["timing_type"], 'integer') . "," .
                     $ilDB->quote($a_item["timing_start"], 'integer') . "," .
                     $ilDB->quote($a_item["timing_end"], 'integer') . "," .
                     $ilDB->quote($a_item["suggestion_start"], 'integer') . "," .
                     $ilDB->quote($a_item["suggestion_end"], 'integer') . "," .
                     $ilDB->quote($a_item["changeable"], 'integer') . "," .
                     $ilDB->quote($a_item["visible"], 'integer') . ", " .
                     $ilDB->quote($a_item["suggestion_start_rel"], 'integer') . "," .
                     $ilDB->quote($a_item['suggestion_end_rel'], 'integer') . ", " .
                     $ilDB->quote(0, 'integer') . ")";
                 $ilDB->manipulate($query);
             }
         });
         
         $ilAtomQuery->run();
 
         // #9982 - to make getItem()-cache work
         $a_item["obj_id"] = $a_ref_id;
         $a_item["parent_id"] = $parent_id;
     
         return $a_item;
     }

Here is the call graph for this function:

◆ deleteAllEntries()

static ilObjectActivation::deleteAllEntries ( $a_ref_id )

static

Delete all db entries for ref id.

Parameters

int $a_ref_id

Definition at line 567 of file class.ilObjectActivation.php.

References $DIC, $ilDB, and $query.

Referenced by ilObject\countReferences(), ilObjChatroom\delete(), and ilObjPoll\doDelete().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         if (!$a_ref_id) {
             return;
         }
         
         $query = "DELETE FROM crs_items " .
             "WHERE obj_id = " . $ilDB->quote($a_ref_id, 'integer');
         $ilDB->manipulate($query);
         
         $query = "DELETE FROM crs_items " .
             "WHERE parent_id = " . $ilDB->quote($a_ref_id, 'integer');
         $ilDB->manipulate($query);
 
         return true;
     }

Here is the caller graph for this function:

◆ enabledChangeable()

ilObjectActivation::enabledChangeable ( )

Get changeable status.

Returns: bool

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

References $changeable.

Referenced by update().

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

Here is the caller graph for this function:

◆ enabledVisible()

ilObjectActivation::enabledVisible ( )

Get visible status.

Returns: bool

Definition at line 227 of file class.ilObjectActivation.php.

References $visible.

Referenced by update().

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

Here is the caller graph for this function:

◆ getEaliestStartRelative()

ilObjectActivation::getEaliestStartRelative ( )

Definition at line 161 of file class.ilObjectActivation.php.

     {
         return $this->earliest_start_rel;
     }

◆ getEarliestStart()

ilObjectActivation::getEarliestStart ( )

Get earliest start.

Returns: int

Definition at line 206 of file class.ilObjectActivation.php.

     {
         return $this->earliest_start;
     }

◆ getItem()

static ilObjectActivation::getItem ( $a_ref_id )

static

Get item data.

Parameters

int $a_ref_id

Returns: array

Definition at line 354 of file class.ilObjectActivation.php.

References $DIC, $ilDB, and $row.

Referenced by ilObjectXMLWriter\__appendTimeTargets(), ilObjCourse\__readSettings(), ilTimingCache\_getTimings(), ilObjPollAccess\_isActivated(), ilObjCourseAccess\_isActivated(), ilObjSurvey\checkReminder(), ilAccess\doPathCheck(), ilObjPortfolioTemplate\doRead(), ilObjPoll\doRead(), ilTimingsUser\handleNewMembership(), ilObjChatroomAccess\isActivated(), ilObjSurvey\loadFromDb(), ilObjTest\loadFromDb(), ilCalendarScheduleFilterTimings\modifyEvent(), ilObjChatroom\read(), ilTimingCache\readObjectInformation(), ilObjSurvey\saveToDb(), ilObjTest\saveToDb(), ilObjPortfolioTemplate\updateActivation(), ilSoapObjectAdministration\updateReferences(), ilObjCourse\updateSettings(), ilCourseContentGUI\updateTimings(), ilTimingPlaned\validate(), and ilContainerXmlWriter\writeCourseItemInformation().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         if (isset(self::$preloaded_data[$a_ref_id])) {
             return self::$preloaded_data[$a_ref_id];
         }
         
         $sql = "SELECT * FROM crs_items" .
             " WHERE obj_id = " . $ilDB->quote($a_ref_id, "integer");
         $set = $ilDB->query($sql);
         $row = $ilDB->fetchAssoc($set);
     
         if (!isset($row["obj_id"])) {
             $row = self::createDefaultEntry($a_ref_id);
         }
         if ($row["obj_id"]) {
             self::$preloaded_data[$row["obj_id"]] = $row;
         }
         return $row;
     }

Here is the caller graph for this function:

◆ getItems()

static ilObjectActivation::getItems	(	$a_parent_id,
		$a_with_list_data = `true`
	)

static

Get sub item data.

Parameters

int	$a_parent_id
bool	$a_with_list_data

Returns: array

Definition at line 789 of file class.ilObjectActivation.php.

References $DIC, and $tree.

Referenced by ilCourseStart\getPossibleStarters(), ilContainerStartObjects\getPossibleStarters(), ilCourseContentGUI\managePersonalTimings(), and ilCourseContentGUI\setColumnSettings().

     {
         global $DIC;
 
         $tree = $DIC->repositoryTree();
         
         $items = array();
         
         $ref_ids = array();
         foreach ($tree->getChilds($a_parent_id) as $item) {
             if ($item['type'] != 'rolf') {
                 $items[] = $item;
                 $ref_ids[] = $item['ref_id'];
             }
         }
         
         if ($ref_ids) {
             self::preloadData($ref_ids);
             
             foreach ($items as $idx => $item) {
                 if (!$a_with_list_data) {
                     $items[$idx] = array_merge($item, self::getItem($item['ref_id']));
                 } else {
                     self::addAdditionalSubItemInformation($item);
                     $items[$idx] = $item;
                 }
             }
         }
         return $items;
     }

Here is the caller graph for this function:

◆ getItemsByEvent()

static ilObjectActivation::getItemsByEvent ( $a_event_id )

static

Get session material / event items.

Parameters

int $a_event_id (object id)

Returns: array

Definition at line 748 of file class.ilObjectActivation.php.

Referenced by ilAppointmentSessionFileHandler\getFiles(), ilObjSessionGUI\infoScreen(), ilContainerGUI\redrawListItemObject(), and ilContainerContentGUI\renderItem().

     {
         include_once 'Modules/Session/classes/class.ilEventItems.php';
         $event_items = new ilEventItems($a_event_id);
         return self::processListItems($event_items->getItems());
     }

Here is the caller graph for this function:

◆ getItemsByItemGroup()

static ilObjectActivation::getItemsByItemGroup ( $a_item_group_ref_id )

static

Get materials of item group.

Parameters

int $a_item_group_id (object id)

Returns: array

Definition at line 761 of file class.ilObjectActivation.php.

Referenced by ilContainerContentGUI\renderItemGroup(), and ilRepositoryExplorerGUI\sortChilds().

     {
         include_once 'Modules/ItemGroup/classes/class.ilItemGroupItems.php';
         $ig_items = new ilItemGroupItems($a_item_group_ref_id);
         $items = $ig_items->getValidItems();
         return self::processListItems($items);
     }

Here is the caller graph for this function:

◆ getItemsByObjective()

static ilObjectActivation::getItemsByObjective ( $a_objective_id )

static

Get objective items.

Parameters

int $a_objective_id

Returns: array

Definition at line 775 of file class.ilObjectActivation.php.

References ilCourseObjectiveMaterials\_getAssignedMaterials().

Referenced by ilContainerObjectiveGUI\renderObjective().

     {
         include_once('./Modules/Course/classes/class.ilCourseObjectiveMaterials.php');
         $item_ids = ilCourseObjectiveMaterials::_getAssignedMaterials($a_objective_id);
         return self::processListItems($item_ids);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSuggestionEnd()

ilObjectActivation::getSuggestionEnd ( )

Get suggestion end.

Returns: int

Definition at line 186 of file class.ilObjectActivation.php.

References $suggestion_end.

Referenced by update(), and validateActivation().

     {
         return $this->suggestion_end;
     }

Here is the caller graph for this function:

◆ getSuggestionEndRelative()

ilObjectActivation::getSuggestionEndRelative ( )

Definition at line 151 of file class.ilObjectActivation.php.

References $suggestion_end_rel.

Referenced by update(), and validateRelativePlaning().

     {
         return $this->suggestion_end_rel;
     }

Here is the caller graph for this function:

◆ getSuggestionStart()

ilObjectActivation::getSuggestionStart ( )

Get suggestion start.

Returns: timestamp

Definition at line 136 of file class.ilObjectActivation.php.

References $suggestion_start.

Referenced by update(), and validateActivation().

     {
         return $this->suggestion_start;
     }

Here is the caller graph for this function:

◆ getSuggestionStartRelative()

ilObjectActivation::getSuggestionStartRelative ( )

Definition at line 141 of file class.ilObjectActivation.php.

References $suggestion_start_rel.

Referenced by update(), and validateRelativePlaning().

     {
         return $this->suggestion_start_rel;
     }

Here is the caller graph for this function:

◆ getTimingEnd()

ilObjectActivation::getTimingEnd ( )

Get timing end.

Returns: timestamp

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

References $timing_end.

Referenced by update(), and validateActivation().

     {
         return $this->timing_end;
     }

Here is the caller graph for this function:

◆ getTimingsAdministrationItems()

static ilObjectActivation::getTimingsAdministrationItems ( $a_parent_id )

static

Get (sub) item data for timings administration view (active/inactive)

Parameters

int $a_parent_id

Returns: array

Definition at line 826 of file class.ilObjectActivation.php.

References ilUtil\sortArray().

Referenced by ilCourseContentGUI\__renderUserItem(), ilCourseContentGUI\editTimings(), ilCourseContentGUI\manageTimings(), and ilCourseContentGUI\showUserTimings().

     {
         $items = self::getItems($a_parent_id, false);
         
         if ($items) {
             $active = $inactive = array();
             foreach ($items as $item) {
                 // active should be first in order
                 if ($item['timing_type'] == self::TIMINGS_DEACTIVATED) {
                     $inactive[] = $item;
                 } else {
                     $active[] = $item;
                 }
             }
             
             $active = ilUtil::sortArray($active, 'start', 'asc');
             $inactive = ilUtil::sortArray($inactive, 'title', 'asc');
             $items = array_merge($active, $inactive);
         }
         
         return $items;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTimingsItems()

static ilObjectActivation::getTimingsItems ( $a_container_ref_id )

static

Get (sub) item data for timings view (no session material, no side blocks)

Parameters

int $a_container_ref_id

Returns: array

Definition at line 855 of file class.ilObjectActivation.php.

References $DIC, and ilEventItems\_getItemsOfContainer().

Referenced by ilCourseContentGUI\__editAdvancedUserTimings(), ilCourseContentGUI\__editUserTimings(), ilCourseContentGUI\__renderItem(), ilCalendarScheduleFilterTimings\addCustomEvents(), and ilObjCourse\prepareAppointments().

     {
         global $DIC;
 
         $objDefinition = $DIC["objDefinition"];
         
         $filtered = array();
         
         include_once 'Modules/Session/classes/class.ilEventItems.php';
         $event_items = ilEventItems::_getItemsOfContainer($a_container_ref_id);
         foreach (self::getTimingsAdministrationItems($a_container_ref_id) as $item) {
             if (!in_array($item['ref_id'], $event_items) &&
                 !$objDefinition->isSideBlock($item['type'])) {
                 $filtered[] = $item;
             }
         }
         
         return $filtered;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTimingStart()

ilObjectActivation::getTimingStart ( )

Get timing start.

Returns: timestamp

Definition at line 96 of file class.ilObjectActivation.php.

References $timing_start.

Referenced by update(), and validateActivation().

     {
         return $this->timing_start;
     }

Here is the caller graph for this function:

◆ getTimingType()

ilObjectActivation::getTimingType ( )

get timing type

See also: class constants

Returns: int

Definition at line 76 of file class.ilObjectActivation.php.

References $timing_type.

Referenced by update(), and validateActivation().

     {
         return $this->timing_type;
     }

Here is the caller graph for this function:

◆ hasChangeableTimings()

static ilObjectActivation::hasChangeableTimings ( $a_ref_id )

static

Check if there is any active changeable timing (in subtree)

Parameters

int ref_id

Returns: bool

Definition at line 684 of file class.ilObjectActivation.php.

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

Referenced by ilCourseContentGUI\__renderUserItem(), ilCourseContentGUI\editUserTimings(), and ilCourseContentGUI\showUserTimings().

     {
         global $DIC;
 
         $tree = $DIC->repositoryTree();
         $ilDB = $DIC->database();
 
         $subtree = $tree->getSubTree($tree->getNodeData($a_ref_id));
         $ref_ids = array();
         foreach ($subtree as $node) {
             $ref_ids[] = $node['ref_id'];
         }
 
         $query = "SELECT * FROM crs_items " .
             "WHERE timing_type = " . $ilDB->quote(self::TIMINGS_PRESETTING, 'integer') . " " .
             "AND changeable = " . $ilDB->quote(1, 'integer') . " " .
             "AND " . $ilDB->in('obj_id', $ref_ids, false, 'integer');
         $res = $ilDB->query($query);
         return $res->numRows() ? true : false;
     }

Here is the caller graph for this function:

◆ hasTimings()

static ilObjectActivation::hasTimings ( $a_ref_id )

static

Check if there is any active timing (in subtree)

Parameters

int ref_id

Returns: bool

Definition at line 658 of file class.ilObjectActivation.php.

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

Referenced by ilCourseMembershipGUI\initParticipantTableGUI().

     {
         global $DIC;
 
         $tree = $DIC->repositoryTree();
         $ilDB = $DIC->database();
 
         $subtree = $tree->getSubTree($tree->getNodeData($a_ref_id));
         $ref_ids = array();
         foreach ($subtree as $node) {
             $ref_ids[] = $node['ref_id'];
         }
 
         $query = "SELECT * FROM crs_items " .
             "WHERE timing_type = " . $ilDB->quote(self::TIMINGS_PRESETTING, 'integer') . " " .
             "AND " . $ilDB->in('obj_id', $ref_ids, false, 'integer');
         $res = $ilDB->query($query);
         return $res->numRows() ? true :false;
     }

Here is the caller graph for this function:

◆ preloadData()

static ilObjectActivation::preloadData ( array $a_ref_ids )

static

Preload data to internal cache.

Parameters

array $a_ref_ids

Definition at line 334 of file class.ilObjectActivation.php.

References $DIC, $ilDB, and $row.

Referenced by ilNewsItem\getAggregatedNewsData(), ilTimingsUser\init(), and ilObjectListGUIPreloader\preload().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $sql = "SELECT * FROM crs_items" .
             " WHERE " . $ilDB->in("obj_id", $a_ref_ids, "", "integer");
         $set = $ilDB->query($sql);
         while ($row = $ilDB->fetchAssoc($set)) {
             self::$preloaded_data[$row["obj_id"]] = $row;
         }
     }

Here is the caller graph for this function:

◆ processListItems()

static ilObjectActivation::processListItems ( array $a_ref_ids )

staticprotected

Validate ref ids and add list data.

Parameters

array $a_ref_ids

Returns: array

Definition at line 711 of file class.ilObjectActivation.php.

References $DIC, $res, and $tree.

     {
         global $DIC;
 
         $tree = $DIC->repositoryTree();
         
         $res = array();
         
         foreach ($a_ref_ids as $item_ref_id) {
             if ($tree->isDeleted($item_ref_id)) {
                 continue;
             }
             // #7571: when node is removed from system, e.g. inactive trashcan, an empty array is returned
             $node = $tree->getNodeData($item_ref_id);
             if ($node["ref_id"] != $item_ref_id) {
                 continue;
             }
             $res[$item_ref_id] = $node;
         }
                     
         if (sizeof($res)) {
             self::preloadData(array_keys($res));
             foreach ($res as $idx => $item) {
                 self::addAdditionalSubItemInformation($item);
                 $res[$idx] = $item;
             }
         }
         
         return array_values($res);
     }

◆ read()

ilObjectActivation::read	(	$a_ref_id,
		$a_parent_id = `0`
	)

Parameters

	$a_ref_id
int	$a_parent_id

Exceptions

ilDatabaseException

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

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, setSuggestionEnd(), setSuggestionEndRelative(), setSuggestionStart(), setSuggestionStartRelative(), setTimingEnd(), setTimingStart(), setTimingType(), toggleChangeable(), and toggleVisible().

     {
         global $DIC;
         $ilDB = $DIC->database();
         
         $query = 'SELECT * FROM crs_items ' .
                 'WHERE obj_id = ' . $ilDB->quote($a_ref_id, 'integer') . ' ';
         
         if ($a_parent_id) {
             $query .= ('AND parent_id = ' . $ilDB->quote($a_parent_id, 'integer') . ' ');
         }
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setSuggestionStart($row->suggestion_start);
             $this->setSuggestionEnd($row->suggestion_end);
             $this->setSuggestionStartRelative($row->suggestion_start_rel);
             $this->setSuggestionEndRelative($row->suggestion_end_rel);
             $this->toggleVisible($row->visible);
             $this->toggleChangeable($row->changeable);
             $this->setTimingType($row->timing_type);
             $this->setTimingStart($row->timing_start);
             $this->setTimingEnd($row->timing_end);
         }
     }

Here is the call graph for this function:

◆ setEarliestStart()

ilObjectActivation::setEarliestStart ( $a_start )

Set earliest start.

Parameters

int $a_start

Definition at line 196 of file class.ilObjectActivation.php.

     {
         $this->earliest_start = $a_start;
     }

◆ setEarliestStartRelative()

ilObjectActivation::setEarliestStartRelative ( $a_start )

Definition at line 166 of file class.ilObjectActivation.php.

     {
         $this->earliest_start_rel = $a_start;
     }

◆ setSuggestionEnd()

ilObjectActivation::setSuggestionEnd ( $a_end )

Set suggestion end.

Parameters

int $a_end

Definition at line 176 of file class.ilObjectActivation.php.

Referenced by read().

     {
         $this->suggestion_end = $a_end;
     }

Here is the caller graph for this function:

◆ setSuggestionEndRelative()

ilObjectActivation::setSuggestionEndRelative ( $a_end )

Definition at line 156 of file class.ilObjectActivation.php.

Referenced by read().

     {
         $this->suggestion_end_rel = $a_end;
     }

Here is the caller graph for this function:

◆ setSuggestionStart()

ilObjectActivation::setSuggestionStart ( $a_start )

Set suggestion start.

Parameters

timestamp $a_start

Definition at line 126 of file class.ilObjectActivation.php.

Referenced by read().

     {
         $this->suggestion_start = $a_start;
     }

Here is the caller graph for this function:

◆ setSuggestionStartRelative()

ilObjectActivation::setSuggestionStartRelative ( $a_start )

Definition at line 146 of file class.ilObjectActivation.php.

Referenced by read().

     {
         $this->suggestion_start_rel = $a_start;
     }

Here is the caller graph for this function:

◆ setTimingEnd()

ilObjectActivation::setTimingEnd ( $a_end )

Set timing end.

Parameters

timestamp $a_end

Definition at line 106 of file class.ilObjectActivation.php.

Referenced by read().

     {
         $this->timing_end = $a_end;
     }

Here is the caller graph for this function:

◆ setTimingStart()

ilObjectActivation::setTimingStart ( $a_start )

Set timing start.

Parameters

timestamp $a_start

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

Referenced by read().

     {
         $this->timing_start = $a_start;
     }

Here is the caller graph for this function:

◆ setTimingType()

ilObjectActivation::setTimingType ( $a_type )

Set timing type.

See also: class constants

Parameters

int $a_type

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

References $a_type.

Referenced by read(), ilObjSurvey\saveToDb(), ilObjTest\saveToDb(), ilObjPortfolioTemplate\updateActivation(), and ilObjCourse\updateSettings().

     {
         $this->timing_type = $a_type;
     }

Here is the caller graph for this function:

◆ toggleChangeable()

ilObjectActivation::toggleChangeable ( $a_status )

Set changeable status.

Parameters

bool $a_status

Definition at line 237 of file class.ilObjectActivation.php.

Referenced by read().

     {
         $this->changeable = (int) $a_status;
     }

Here is the caller graph for this function:

◆ toggleVisible()

ilObjectActivation::toggleVisible ( $a_status )

Set visible status.

Parameters

bool $a_status

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

Referenced by read().

     {
         $this->visible = (int) $a_status;
     }

Here is the caller graph for this function:

◆ update()

ilObjectActivation::update	(	$a_ref_id,
		$a_parent_id = `null`
	)

Update db entry.

Parameters

int	$a_ref_id
int	$a_parent_id

Definition at line 301 of file class.ilObjectActivation.php.

References $db, $ilDB, $query, enabledChangeable(), enabledVisible(), getSuggestionEnd(), getSuggestionEndRelative(), getSuggestionStart(), getSuggestionStartRelative(), getTimingEnd(), getTimingStart(), and getTimingType().

     {
         $ilDB = $this->db;
         
         // #10110
         $query = "UPDATE crs_items SET " .
             "timing_type = " . $ilDB->quote($this->getTimingType(), 'integer') . ", " .
             "timing_start = " . $ilDB->quote((int) $this->getTimingStart(), 'integer') . ", " .
             "timing_end = " . $ilDB->quote((int) $this->getTimingEnd(), 'integer') . ", " .
             "suggestion_start = " . $ilDB->quote((int) $this->getSuggestionStart(), 'integer') . ", " .
             "suggestion_end = " . $ilDB->quote((int) $this->getSuggestionEnd(), 'integer') . ", " .
             "changeable = " . $ilDB->quote($this->enabledChangeable(), 'integer') . ", " .
             'suggestion_start_rel = ' . $ilDB->quote($this->getSuggestionStartRelative(), 'integer') . ', ' .
             'suggestion_end_rel = ' . $ilDB->quote($this->getSuggestionEndRelative(), 'integer') . ', ';
 
         if ($a_parent_id) {
             $query .= "parent_id = " . $ilDB->quote($a_parent_id, 'integer') . ", ";
         }
         
         $query .= "visible = " . $ilDB->quote($this->enabledVisible(), 'integer') . " " .
             "WHERE obj_id = " . $ilDB->quote($a_ref_id, 'integer');
         $ilDB->manipulate($query);
         
         unset(self::$preloaded_data[$a_ref_id]);
     
         return true;
     }

Here is the call graph for this function:

◆ validateActivation()

ilObjectActivation::validateActivation ( )

Validate current properties.

Returns: boolean

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

References $error, $ilErr, $lng, getSuggestionEnd(), getSuggestionStart(), getTimingEnd(), getTimingStart(), and getTimingType().

     {
         $ilErr = $this->error;
         $lng = $this->lng;
         
         $ilErr->setMessage('');
 
         if ($this->getTimingType() == self::TIMINGS_ACTIVATION) {
             if ($this->getTimingStart() > $this->getTimingEnd()) {
                 $ilErr->appendMessage($lng->txt("crs_activation_start_invalid"));
             }
         } elseif ($this->getTimingType() == self::TIMINGS_PRESETTING) {
             if ($this->getSuggestionStart() > $this->getSuggestionEnd()) {
                 $ilErr->appendMessage($lng->txt('crs_timing_err_sug_start_end'));
             }
         }
     
         if ($ilErr->getMessage()) {
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ validateRelativePlaning()

ilObjectActivation::validateRelativePlaning ( )

Returns: array

Definition at line 283 of file class.ilObjectActivation.php.

References $errors, getSuggestionEndRelative(), and getSuggestionStartRelative().

     {
         $errors = array();
         
         if ($this->getSuggestionStartRelative() >= $this->getSuggestionEndRelative()) {
             $errors[] = self::ERR_SUG_START_END;
         } elseif ($this->getSuggestionStartRelative() < 0) {
             $errors[] = self::ERR_SUG_START_END;
         }
         return $errors;
     }