Collaboration diagram for ilObjectActivation:

Public Member Functions
	__construct ()

	setTimingType (int $type)

	getTimingType ()

	setTimingStart (?int $start)

	getTimingStart ()

	setTimingEnd (?int $end)

	getTimingEnd ()

	setSuggestionStart (?int $start)

	setSuggestionStartRelative (?int $start)

	setSuggestionEndRelative (int $end)

	setSuggestionEnd (?int $end)

	toggleVisible (bool $status)

	enabledVisible ()

	toggleChangeable (bool $status)

	enabledChangeable ()

	update (int $ref_id, ?int $parent_id=null)

	read (int $ref_id, int $parent_id=0)

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

static	getItem (int $ref_id)

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

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

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

static	cloneDependencies (int $ref_id, int $target_id, int $copy_id)

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

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

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

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

static	getItemsByObjective (int $objective_id)
	Get objective items. More...

static	getItems (int $parent_id, bool $with_list_data=true)
	Get sub item data. More...

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

static	getTimingsItems (int $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 (int $ref_id)
	Create db entry with default values. More...

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

Protected Attributes
ilErrorHandling	$error

ilLanguage	$lng

ilDBInterface	$db

int	$timing_type = 0

int	$timing_start = null

int	$timing_end = null

int	$suggestion_start = null

int	$suggestion_end = null

bool	$visible = false

int	$changeable = 0

int	$suggestion_start_rel = null

int	$suggestion_end_rel = null

Static Protected Attributes
static array	$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 27 of file class.ilObjectActivation.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectActivation::__construct ( )

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

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

References $DIC, error(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ addAdditionalSubItemInformation()

static ilObjectActivation::addAdditionalSubItemInformation ( array & $item )

static

Parse item data for list entries.

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

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

References $DIC, $ilUser, ilSessionAppointment\_lookupAppointment(), ilObject\_lookupObjId(), ilObject\_lookupType(), getItem(), IL_CAL_UNIX, and TIMINGS_PRESETTING.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addListGUIActivationProperty()

static ilObjectActivation::addListGUIActivationProperty	(	ilObjectListGUI	$list_gui,
		array &	$item
	)

static

Get timing details for list gui.

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

                                                                                                : void
    {
        self::addAdditionalSubItemInformation($item);
        if (isset($item['timing_type'])) {
            if (!isset($item['masked_start'])) {
                $start = $item['start'] ?? 0;
                $end = $item['end'] ?? 0;
            } else {
                $start = $item['masked_start'];
                $end = $item['masked_end'];
            }
            $activation = '';
            switch ($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');
 
                $list_gui->addCustomProperty(
                    $lng->txt($item['activation_info']),
                    $activation,
                    false,
                    true
                );
            }
        }
    }

References $DIC, $lng, addAdditionalSubItemInformation(), ilObjectListGUI\addCustomProperty(), ilDatePresentation\formatPeriod(), IL_CAL_UNIX, ilLanguage\loadLanguageModule(), TIMINGS_ACTIVATION, TIMINGS_PRESETTING, and ilLanguage\txt().

Referenced by ilSearchResultTableGUI\fillRow(), ilPDSelectedItemsBlockGUI\getCardForData(), ilPDSelectedItemsBlockGUI\getListItemForData(), ilPDSelectedItemsBlockGUI\getListItemGroups(), ilObjSessionGUI\modifyItemGUI(), and ilContainerContentGUI\renderItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneDependencies()

static ilObjectActivation::cloneDependencies	(	int	$ref_id,
		int	$target_id,
		int	$copy_id
	)

static

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

                                                                                       : void
    {
        global $DIC;
 
        $ilLog = $DIC["ilLog"];
 
        $ilLog->write(__METHOD__ . ': Begin course items...' . $ref_id);
 
        $items = self::getItems($ref_id, false);
        if (!$items) {
            $ilLog->write(__METHOD__ . ': No course items found.');
            return;
        }
 
        // new course item object
        if (!is_object(ilObjectFactory::getInstanceByRefId($target_id, false))) {
            $ilLog->write(__METHOD__ . ': Cannot create target object.');
            return;
        }
 
        $cp_options = ilCopyWizardOptions::_getInstance($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((int) $item['timing_type']);
            $new_item->setTimingStart((int) $item['timing_start']);
            $new_item->setTimingEnd((int) $item['timing_end']);
            $new_item->setSuggestionStart((int) $item['suggestion_start']);
            $new_item->setSuggestionEnd((int) $item['suggestion_end']);
            $new_item->toggleChangeable((bool) $item['changeable']);
            $new_item->toggleVisible((bool) $item['visible']);
            $new_item->update($new_item_id, $new_parent);
            $new_item->setSuggestionStartRelative((int) ($item['suggestion_start_rel'] ?? 0));
            $new_item->setSuggestionEndRelative((int) ($item['suggestion_end_rel'] ?? 0));
            $new_item->createDefaultEntry($new_item_id);
            $new_item->update($new_item_id);
        }
    }

References $DIC, $ref_id, $target_id, ilCopyWizardOptions\_getInstance(), ilObjectFactory\getInstanceByRefId(), and getItems().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDefaultEntry()

static ilObjectActivation::createDefaultEntry ( int $ref_id )

staticprotected

Create db entry with default values.

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

                                                             : array
    {
        global $DIC;
 
        $db = $DIC->database();
        $tree = $DIC->repositoryTree();
 
        $parent_id = $tree->getParentId($ref_id);
        if (!$parent_id) {
            return [];
        }
 
        $ilAtomQuery = $db->buildAtomQuery();
        $ilAtomQuery->addTableLock("crs_items");
 
        $ilAtomQuery->addQueryCallable(function (ilDBInterface $db) use ($ref_id, $parent_id, &$item): void {
            $sql =
                "SELECT parent_id, obj_id, timing_type, timing_start, timing_end, suggestion_start," . PHP_EOL
                . "suggestion_end, changeable, visible, position, suggestion_start_rel, suggestion_end_rel" . PHP_EOL
                . "FROM crs_items" . PHP_EOL
                . "WHERE obj_id = " . $db->quote($ref_id, "integer") . PHP_EOL
            ;
            $set = $db->query($sql);
            if (!$db->numRows($set)) {
                $now = time();
 
                $item = array();
                $item["timing_type"] = self::TIMINGS_DEACTIVATED;
                $item["timing_start"] = $now;
                $item["timing_end"] = $now;
                $item["suggestion_start"] = $now;
                $item["suggestion_end"] = $now;
                $item['visible'] = 0;
                $item['changeable'] = 0;
 
                $values = [
                    "parent_id" => ["integer", $parent_id],
                    "obj_id" => ["integer", $ref_id],
                    "timing_type" => ["integer", $item["timing_type"]],
                    "timing_start" => ["integer", $item["timing_start"]],
                    "timing_end" => ["integer", $item["timing_end"]],
                    "suggestion_start" => ["integer", $item["suggestion_start"]],
                    "suggestion_end" => ["integer", $item["suggestion_end"]],
                    "changeable" => ["integer", $item["changeable"]],
                    "visible" => ["integer", $item["visible"]],
                    "suggestion_start_rel" => ["integer", $item["suggestion_start_rel"] ?? 0],
                    "suggestion_end_rel" => ["integer", $item["suggestion_end_rel"] ?? 0],
                    "position" => ["integer", 0]
                ];
                $db->insert("crs_items", $values);
            }
        });
 
        $ilAtomQuery->run();
 
        // #9982 - to make getItem()-cache work
        $item["obj_id"] = $ref_id;
        $item["parent_id"] = $parent_id;
 
        return $item;
    }

References $db, $DIC, $ref_id, ilDBInterface\buildAtomQuery(), ilDBInterface\numRows(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by getItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAllEntries()

static ilObjectActivation::deleteAllEntries ( int $ref_id )

static

Delete all db entries for ref id.

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

                                                        : bool
    {
        global $DIC;
 
        $db = $DIC->database();
 
        if (!$ref_id) {
            return false;
        }
 
        $sql =
            "DELETE FROM crs_items " . PHP_EOL
            . "WHERE obj_id = " . $db->quote($ref_id, 'integer') . PHP_EOL
        ;
        $db->manipulate($sql);
 
        $sql =
            "DELETE FROM crs_items " . PHP_EOL
            . "WHERE parent_id = " . $db->quote($ref_id, 'integer') . PHP_EOL
        ;
        $db->manipulate($sql);
 
        return true;
    }

References $db, $DIC, $ref_id, ilDBInterface\manipulate(), and ilDBInterface\quote().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledChangeable()

ilObjectActivation::enabledChangeable ( )

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

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

References $changeable.

Referenced by update().

Here is the caller graph for this function:

◆ enabledVisible()

ilObjectActivation::enabledVisible ( )

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

                                    : bool
    {
        return $this->visible;
    }

References $visible.

Referenced by update().

Here is the caller graph for this function:

◆ getItem()

static ilObjectActivation::getItem ( int $ref_id )

static

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

                                               : array
    {
        global $DIC;
        $db = $DIC->database();
 
        if (isset(self::$preloaded_data[$ref_id])) {
            return self::$preloaded_data[$ref_id];
        }
 
        $sql =
            "SELECT parent_id, obj_id, timing_type, timing_start, timing_end, suggestion_start," . PHP_EOL
            . "suggestion_end, changeable, visible, position, suggestion_start_rel, suggestion_end_rel" . PHP_EOL
            . "FROM crs_items" . PHP_EOL
            . "WHERE obj_id = " . $db->quote($ref_id, "integer") . PHP_EOL
        ;
        $set = $db->query($sql);
        $row = $db->fetchAssoc($set);
 
        if (!isset($row["obj_id"])) {
            $row = self::createDefaultEntry($ref_id);
        } else {
            self::$preloaded_data[$row["obj_id"]] = $row;
        }
        return $row;
    }

References $db, $DIC, $ref_id, createDefaultEntry(), ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilObjCourse\__readSettings(), ilTimingCache\_getTimings(), ilObjCourseAccess\_isActivated(), ilObjPollAccess\_isActivated(), addAdditionalSubItemInformation(), ilObjectXMLWriter\appendTimeTargets(), ilObjSurvey\checkReminder(), ilObjPoll\doRead(), ilObjPortfolioTemplate\doRead(), ilTimingsUser\handleNewMembership(), ilObjChatroomAccess\isActivated(), ilObjSurvey\loadFromDb(), ilObjTest\loadFromDb(), ilObjCmiXapi\loadRepositoryActivationSettings(), ilObjLTIConsumer\loadRepositoryActivationSettings(), ilCalendarScheduleFilterTimings\modifyEvent(), ilObjChatroom\read(), ilTimingCache\readObjectInformation(), ilObjCmiXapi\saveRepositoryActivationSettings(), ilObjLTIConsumer\saveRepositoryActivationSettings(), ilObjSurvey\saveToDb(), ilObjTest\saveToDb(), ilObjPortfolioTemplate\updateActivation(), ilSoapObjectAdministration\updateReferences(), ilObjCourse\updateSettings(), ilTimingPlaned\validate(), and ilContainerXmlWriter\writeCourseItemInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItems()

static ilObjectActivation::getItems	(	int	$parent_id,
		bool	$with_list_data = `true`
	)

static

Get sub item data.

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

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

References $DIC, addAdditionalSubItemInformation(), ILIAS\Repository\int(), and preloadData().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemsByEvent()

static ilObjectActivation::getItemsByEvent ( int $event_id )

static

Get session material / event items.

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

                                                         : array
    {
        $event_items = new ilEventItems($event_id);
        return self::processListItems($event_items->getItems());
    }

References processListItems().

Referenced by ilAppointmentPresentationSessionGUI\collectPropertiesAndActions(), ilAppointmentSessionFileHandler\getFiles(), ilContainerGUI\redrawListItemObject(), and ilContainerContentGUI\renderItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemsByItemGroup()

static ilObjectActivation::getItemsByItemGroup ( int $item_group_ref_id )

static

Get materials of item group.

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

                                                                      : array
    {
        $ig_items = new ilItemGroupItems($item_group_ref_id);
        $items = $ig_items->getValidItems();
        return self::processListItems($items);
    }

References processListItems().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemsByObjective()

static ilObjectActivation::getItemsByObjective ( int $objective_id )

static

Get objective items.

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

                                                                 : array
    {
        $item_ids = ilCourseObjectiveMaterials::_getAssignedMaterials($objective_id);
        return self::processListItems($item_ids);
    }

References ilCourseObjectiveMaterials\_getAssignedMaterials(), and processListItems().

Here is the call graph for this function:

◆ getTimingEnd()

ilObjectActivation::getTimingEnd ( )

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

                                  : ?int
    {
        return $this->timing_end;
    }

References $timing_end.

Referenced by update().

Here is the caller graph for this function:

◆ getTimingsAdministrationItems()

static ilObjectActivation::getTimingsAdministrationItems ( int $parent_id )

static

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

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

                                                                        : array
    {
        $items = self::getItems($parent_id, false);
        $active = $availability = $inactive = [];
        foreach ($items as $item) {
            if ($item['timing_type'] == self::TIMINGS_DEACTIVATED) {
                $inactive[] = $item;
            } elseif ($item['timing_type'] == self::TIMINGS_ACTIVATION) {
                $availability[] = $item;
            } else {
                $active[] = $item;
            }
        }
        $active = ilArrayUtil::sortArray($active, 'suggestion_start');
        $availability = ilArrayUtil::sortArray($availability, 'timing_start');
        $inactive = ilArrayUtil::sortArray($inactive, 'title');
 
        $items = array_merge($active, $availability, $inactive);
        return $items;
    }

References getItems(), and ilArrayUtil\sortArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTimingsItems()

static ilObjectActivation::getTimingsItems ( int $container_ref_id )

static

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

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

                                                                 : array
    {
        global $DIC;
 
        $objDefinition = $DIC["objDefinition"];
 
        $filtered = array();
 
        $event_items = ilEventItems::_getItemsOfContainer($container_ref_id);
        foreach (self::getTimingsAdministrationItems($container_ref_id) as $item) {
            if (!in_array($item['ref_id'], $event_items) &&
                !$objDefinition->isSideBlock($item['type'])) {
                $filtered[] = $item;
            }
        }
 
        return $filtered;
    }

References $DIC, and ilEventItems\_getItemsOfContainer().

Referenced by ilCalendarScheduleFilterTimings\addCustomEvents(), and ilObjCourse\prepareAppointments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTimingStart()

ilObjectActivation::getTimingStart ( )

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

                                    : ?int
    {
        return $this->timing_start;
    }

References $timing_start.

Referenced by update().

Here is the caller graph for this function:

◆ getTimingType()

ilObjectActivation::getTimingType ( )

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

                                   : int
    {
        return $this->timing_type;
    }

References $timing_type.

Referenced by update().

Here is the caller graph for this function:

◆ hasChangeableTimings()

static ilObjectActivation::hasChangeableTimings ( int $ref_id )

static

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

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

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

References $db, $DIC, $ref_id, $res, ilDBInterface\in(), ilDBInterface\query(), and ilDBInterface\quote().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasTimings()

static ilObjectActivation::hasTimings ( int $ref_id )

static

Check if there is any active timing (in subtree)

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

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

References $db, $DIC, $ref_id, $res, ilDBInterface\in(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilCourseMembershipGUI\initParticipantTableGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preloadData()

static ilObjectActivation::preloadData ( array $ref_ids )

static

Preload data to internal cache.

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

                                                      : void
    {
        global $DIC;
        $db = $DIC->database();
 
        $sql =
            "SELECT parent_id, obj_id, timing_type, timing_start, timing_end, suggestion_start," . PHP_EOL
            . "suggestion_end, changeable, visible, position, suggestion_start_rel, suggestion_end_rel" . PHP_EOL
            . "FROM crs_items" . PHP_EOL
            . "WHERE " . $db->in("obj_id", $ref_ids, false, "integer") . PHP_EOL
        ;
        $set = $db->query($sql);
        while ($row = $db->fetchAssoc($set)) {
            self::$preloaded_data[$row["obj_id"]] = $row;
        }
    }

References $db, $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\in(), and ilDBInterface\query().

Referenced by getItems(), ilTimingsUser\init(), ilObjectListGUIPreloader\preload(), and processListItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processListItems()

static ilObjectActivation::processListItems ( array $ref_ids )

staticprotected

Validate ref ids and add list data.

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

                                                              : array
    {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
 
        $res = array();
 
        foreach (array_map('intval', $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 (!isset($node["ref_id"]) || (int) $node["ref_id"] !== $item_ref_id) {
                continue;
            }
            $res[$item_ref_id] = $node;
        }
 
        if (count($res)) {
            self::preloadData(array_keys($res));
            foreach ($res as $idx => $item) {
                self::addAdditionalSubItemInformation($item);
                $res[$idx] = $item;
            }
        }
 
        return array_values($res);
    }

References $DIC, $res, addAdditionalSubItemInformation(), and preloadData().

Referenced by getItemsByEvent(), getItemsByItemGroup(), and getItemsByObjective().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObjectActivation::read	(	int	$ref_id,
		int	$parent_id = `0`
	)

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

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

References $db, $DIC, $ref_id, $res, ilDBConstants\FETCHMODE_OBJECT, ilDBInterface\query(), ilDBInterface\quote(), setSuggestionEnd(), setSuggestionEndRelative(), setSuggestionStart(), setSuggestionStartRelative(), setTimingEnd(), setTimingStart(), setTimingType(), toggleChangeable(), and toggleVisible().

Referenced by ilObjectActivationGUI\update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSuggestionEnd()

ilObjectActivation::setSuggestionEnd ( ?int $end )

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

                                               : void
    {
        if ($end === 0) {
            $end = null;
        }
        $this->suggestion_end = $end;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setSuggestionEndRelative()

ilObjectActivation::setSuggestionEndRelative ( int $end )

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

                                                      : void
    {
        if ($end === 0) {
            $end = null;
        }
        $this->suggestion_end_rel = $end;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setSuggestionStart()

ilObjectActivation::setSuggestionStart ( ?int $start )

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

                                                   : void
    {
        if ($start === 0) {
            $start = null;
        }
        $this->suggestion_start = $start;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setSuggestionStartRelative()

ilObjectActivation::setSuggestionStartRelative ( ?int $start )

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

                                                           : void
    {
        if ($start === 0) {
            $start = null;
        }
        $this->suggestion_start_rel = $start;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTimingEnd()

ilObjectActivation::setTimingEnd ( ?int $end )

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

                                           : void
    {
        $this->timing_end = $end;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTimingStart()

ilObjectActivation::setTimingStart ( ?int $start )

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

                                               : void
    {
        $this->timing_start = $start;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTimingType()

ilObjectActivation::setTimingType ( int $type )

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

                                            : void
    {
        $this->timing_type = $type;
    }

References $type.

Referenced by read().

Here is the caller graph for this function:

◆ toggleChangeable()

ilObjectActivation::toggleChangeable ( bool $status )

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

                                                  : void
    {
        $this->changeable = (int) $status;
    }

References ILIAS\Repository\int().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toggleVisible()

ilObjectActivation::toggleVisible ( bool $status )

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

                                               : void
    {
        $this->visible = $status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilObjectActivation::update	(	int	$ref_id,
		?int	$parent_id = `null`
	)

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

                                                               : bool
    {
        $values = [
            "timing_type" => ["integer", $this->getTimingType()],
            "timing_start" => ["integer", $this->getTimingStart() ?? 0],
            "timing_end" => ["integer", $this->getTimingEnd() ?? 0],
            "suggestion_start" => ["integer", $this->suggestion_start ?? 0],
            "suggestion_end" => ["integer", $this->suggestion_end ?? 0],
            "changeable" => ["integer", (int) $this->enabledChangeable()],
            "suggestion_start_rel" => ["integer", $this->suggestion_start_rel ?? 0],
            "suggestion_end_rel" => ["integer", $this->suggestion_end_rel ?? 0],
            "visible" => ["integer", $this->enabledVisible()]
        ];
 
        if (!is_null($parent_id)) {
            $values["parent_id"] = ["integer", $parent_id];
        }
 
        $where = [
            "obj_id" => ["integer", $ref_id]
        ];
 
        $this->db->update("crs_items", $values, $where);
 
        unset(self::$preloaded_data[$ref_id]);
 
        return true;
    }