ilObjectActivation Class Reference

Class ilObjectActivation. More...

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...
	setSuggestionEnd ($a_end)
	Set suggestion end. More...
	getSuggestionEnd ()
	Get suggestion end. More...
	setEarliestStart ($a_start)
	Set earliest start. More...
	getEarliestStart ()
	Get earliest start. More...
	setLatestEnd ($a_end)
	Set latest end. More...
	getLatestEnd ()
	Get latest end. 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...
	update ($a_ref_id, $a_parent_id=null)
	Update db entry. More...

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	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
	$earliest_start
	$latest_end
	$visible
	$changeable

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 46 of file class.ilObjectActivation.php.

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

References $DIC, and error().

Here is the call graph for this function:

Member Function Documentation

addAdditionalSubItemInformation()

static ilObjectActivation::addAdditionalSubItemInformation ( array &  $a_item )

static

Parse item data for list entries.

Parameters

array

&$a_item

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

    {
        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) {
            include_once 'Modules/Course/classes/Timings/class.ilTimingPlaned.php';
            $user_data = ilTimingPlaned::_getPlanedTimings($ilUser->getId(), $a_item['ref_id']);
            if ($user_data['planed_start']) {
                $a_item['start'] = $user_data['planed_start'];
                $a_item['end'] = $user_data['planed_end'];
                $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';
            }
        } 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'];
        }
    }

References $DIC, $ilUser, $info, ilTimingPlaned\_getPlanedTimings(), ilSessionAppointment\_lookupAppointment(), ilObject\_lookupObjId(), ilObject\_lookupType(), and getItem().

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  $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 415 of file class.ilObjectActivation.php.

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

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

Referenced by ilSearchResultTableGUI\fillRow(), 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 (   $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 567 of file class.ilObjectActivation.php.

    {
        global $DIC;
 
        $ilLog = $DIC["ilLog"];
        
        $ilLog->write(__METHOD__ . ': Begin course items...');
                
        $items = self::getItems($a_ref_id);
        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->setEarliestStart($item['earliest_start']);
            $new_item->setLatestEnd($item['latest_end']);
            $new_item->toggleVisible($item['visible']);
            $new_item->update($new_item_id, $new_parent);
            
            $ilLog->write(__METHOD__ . ': Added new entry for item nr. ' . $item['obj_id']);
        }
        $ilLog->write(__METHOD__ . ': Finished course items.');
    }

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

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

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 468 of file class.ilObjectActivation.php.

    {
        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;
                $a_item['earliest_start']       = $now;
                $a_item['latest_end']       = mktime(23, 55, 00, $now_parts["mon"], $now_parts["mday"], $now_parts["year"]);
                $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,earliest_start,latest_end,visible,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['earliest_start'], 'integer') . ", " .
                    $ilDB->quote($a_item['latest_end'], 'integer') . ", " .
                    $ilDB->quote($a_item["visible"], '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;
    }

References $DIC, and $ilDB.

Referenced by getItem().

Here is the caller 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 539 of file class.ilObjectActivation.php.

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

References $DIC, $ilDB, and $query.

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

Here is the caller graph for this function:

enabledChangeable()

ilObjectActivation::enabledChangeable

(

)

Get changeable status.

Returns

bool

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

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

References $changeable.

Referenced by update().

Here is the caller graph for this function:

enabledVisible()

ilObjectActivation::enabledVisible

(

)

Get visible status.

Returns

bool

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

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

References $visible.

Referenced by update().

Here is the caller graph for this function:

getEarliestStart()

ilObjectActivation::getEarliestStart

(

)

Get earliest start.

Returns

timestamp

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

    {
        return $this->earliest_start;
    }

References $earliest_start.

Referenced by update().

Here is the caller graph for this function:

getItem()

static ilObjectActivation::getItem (   $a_ref_id )

static

Get item data.

Parameters

int

$a_ref_id

Returns

array

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

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

References $DIC, $ilDB, $row, and createDefaultEntry().

Referenced by ilObjectXMLWriter\__appendTimeTargets(), ilObjCourse\__readSettings(), ilTimingCache\_getTimings(), ilObjCourseAccess\_isActivated(), ilObjPollAccess\_isActivated(), addAdditionalSubItemInformation(), ilObjSurvey\checkReminder(), ilAccess\doActivationCheck(), ilObjPoll\doRead(), ilObjPortfolioTemplate\doRead(), ilObjectActivationGUI\getValues(), ilObjChatroomAccess\isActivated(), ilObjSurvey\loadFromDb(), ilObjTest\loadFromDb(), ilObjChatroom\read(), ilTimingCache\readObjectInformation(), ilObjTest\saveToDb(), ilObjSurvey\saveToDb(), ilObjPortfolioTemplate\updateActivation(), ilSoapObjectAdministration\updateReferences(), ilObjCourse\updateSettings(), ilCourseContentGUI\updateTimings(), 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 (   $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 762 of file class.ilObjectActivation.php.

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

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

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

Here is the call graph for this function:

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 721 of file class.ilObjectActivation.php.

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

References processListItems().

Referenced by ilAppointmentSessionFileHandler\getFiles(), ilObjSessionGUI\infoScreen(), 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 (   $a_item_group_ref_id )

static

Get materials of item group.

Parameters

int

$a_item_group_id

(object id)

Returns

array

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

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

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 (   $a_objective_id )

static

Get objective items.

Parameters

int

$a_objective_id

Returns

array

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

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

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

Referenced by ilContainerObjectiveGUI\renderObjective().

Here is the call graph for this function:

Here is the caller graph for this function:

getLatestEnd()

ilObjectActivation::getLatestEnd

(

)

Get latest end.

Returns

timestamp

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

    {
        return $this->latest_end;
    }

References $latest_end.

Referenced by update().

Here is the caller graph for this function:

getSuggestionEnd()

ilObjectActivation::getSuggestionEnd

(

)

Get suggestion end.

Returns

timestamp

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

    {
        return $this->suggestion_end;
    }

References $suggestion_end.

Referenced by update(), and validateActivation().

Here is the caller graph for this function:

getSuggestionStart()

ilObjectActivation::getSuggestionStart

(

)

Get suggestion start.

Returns

timestamp

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

    {
        return $this->suggestion_start;
    }

References $suggestion_start.

Referenced by update(), and validateActivation().

Here is the caller graph for this function:

getTimingEnd()

ilObjectActivation::getTimingEnd

(

)

Get timing end.

Returns

timestamp

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

    {
        return $this->timing_end;
    }

References $timing_end.

Referenced by update(), and validateActivation().

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 800 of file class.ilObjectActivation.php.

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

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

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

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 829 of file class.ilObjectActivation.php.

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

References $DIC, and ilEventItems\_getItemsOfContainer().

Referenced by ilCourseContentGUI\__editAdvancedUserTimings(), ilCourseContentGUI\__editUserTimings(), and ilCourseContentGUI\__renderItem().

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 92 of file class.ilObjectActivation.php.

    {
        return $this->timing_start;
    }

References $timing_start.

Referenced by update(), and validateActivation().

Here is the caller graph for this function:

getTimingType()

ilObjectActivation::getTimingType

(

)

get timing type

See also

class constants

Returns

int

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

    {
        return $this->timing_type;
    }

References $timing_type.

Referenced by update(), and validateActivation().

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 657 of file class.ilObjectActivation.php.

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

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

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

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 631 of file class.ilObjectActivation.php.

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

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

Referenced by ilCourseMembershipGUI\initParticipantTableGUI().

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 304 of file class.ilObjectActivation.php.

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

References $DIC, $ilDB, and $row.

Referenced by ilNewsItem\getAggregatedNewsData(), getItems(), ilObjectListGUIPreloader\preload(), and processListItems().

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 684 of file class.ilObjectActivation.php.

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

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:

setEarliestStart()

ilObjectActivation::setEarliestStart

(

$a_start

)

Set earliest start.

Parameters

timestamp

$a_start

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

    {
        $this->earliest_start = $a_start;
    }

setLatestEnd()

ilObjectActivation::setLatestEnd

(

$a_end

)

Set latest end.

Parameters

timestamp

$a_end

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

    {
        $this->latest_end = $a_end;
    }

setSuggestionEnd()

ilObjectActivation::setSuggestionEnd

(

$a_end

)

Set suggestion end.

Parameters

timestamp

$a_end

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

    {
        $this->suggestion_end = $a_end;
    }

setSuggestionStart()

ilObjectActivation::setSuggestionStart

(

$a_start

)

Set suggestion start.

Parameters

timestamp

$a_start

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

    {
        $this->suggestion_start = $a_start;
    }

setTimingEnd()

ilObjectActivation::setTimingEnd

(

$a_end

)

Set timing end.

Parameters

timestamp

$a_end

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

    {
        $this->timing_end = $a_end;
    }

setTimingStart()

ilObjectActivation::setTimingStart

(

$a_start

)

Set timing start.

Parameters

timestamp

$a_start

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

    {
        $this->timing_start = $a_start;
    }

setTimingType()

ilObjectActivation::setTimingType

(

$a_type

)

Set timing type.

See also

class constants

Parameters

int

$a_type

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

    {
        $this->timing_type = $a_type;
    }

References $a_type.

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

Here is the caller graph for this function:

toggleChangeable()

ilObjectActivation::toggleChangeable

(

$a_status

)

Set changeable status.

Parameters

bool

$a_status

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

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

toggleVisible()

ilObjectActivation::toggleVisible

(

$a_status

)

Set visible status.

Parameters

bool

$a_status

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

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

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 271 of file class.ilObjectActivation.php.

    {
        $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') . ", " .
            "earliest_start = " . $ilDB->quote((int) $this->getEarliestStart(), 'integer') . ", " .
            "latest_end = " . $ilDB->quote((int) $this->getLatestEnd(), '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;
    }

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

Here is the call graph for this function:

validateActivation()

ilObjectActivation::validateActivation

(

)

Validate current properties.

Returns

boolean

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

    {
        $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_latest_end_not_valid'));
            }
        }
    
        if ($ilErr->getMessage()) {
            return false;
        }
        return true;
    }

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

Here is the call graph for this function:

Field Documentation

$changeable

ilObjectActivation::$changeable

protected

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

Referenced by enabledChangeable().

$db

ilObjectActivation::$db

protected

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

Referenced by update().

$earliest_start

ilObjectActivation::$earliest_start

protected

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

Referenced by getEarliestStart().

$error

ilObjectActivation::$error

protected

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

Referenced by validateActivation().

$latest_end

ilObjectActivation::$latest_end

protected

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

Referenced by getLatestEnd().

$lng

ilObjectActivation::$lng

protected

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

Referenced by addListGUIActivationProperty(), and validateActivation().

$preloaded_data

ilObjectActivation::$preloaded_data = array()

staticprotected

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

$suggestion_end

ilObjectActivation::$suggestion_end

protected

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

Referenced by getSuggestionEnd().

$suggestion_start

ilObjectActivation::$suggestion_start

protected

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

Referenced by getSuggestionStart().

$timing_end

ilObjectActivation::$timing_end

protected

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

Referenced by getTimingEnd().

$timing_start

ilObjectActivation::$timing_start

protected

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

Referenced by getTimingStart().

$timing_type

ilObjectActivation::$timing_type

protected

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

Referenced by getTimingType().

$visible

ilObjectActivation::$visible

protected

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

Referenced by enabledVisible().

TIMINGS_ACTIVATION

const ilObjectActivation::TIMINGS_ACTIVATION = 0

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

Referenced by ilObjectXMLWriter\__appendTimeTargets(), ilObjCourse\__readSettings(), ilObjCourseAccess\_isActivated(), ilObjPollAccess\_isActivated(), addListGUIActivationProperty(), ilSoapObjectAdministration\addReferences(), ilObjSurvey\checkReminder(), ilAccess\doActivationCheck(), ilObjPoll\doRead(), ilObjPortfolioTemplate\doRead(), ilObjectActivationGUI\initFormEdit(), ilObjChatroomAccess\isActivated(), ilObjSurvey\loadFromDb(), ilObjTest\loadFromDb(), ilObjChatroom\read(), ilObjTest\saveToDb(), ilObjSurvey\saveToDb(), ilObjPortfolioTemplate\updateActivation(), ilObjPollGUI\updateCustom(), ilSoapObjectAdministration\updateReferences(), and ilObjCourse\updateSettings().

TIMINGS_DEACTIVATED

const ilObjectActivation::TIMINGS_DEACTIVATED = 1

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

Referenced by ilObjectXMLWriter\__appendTimeTargets(), ilObjChatroom\__construct(), ilObjPoll\__construct(), ilSoapObjectAdministration\addReferences(), ilObjectActivationGUI\getValues(), ilObjectActivationGUI\initFormEdit(), ilObjTest\saveToDb(), ilObjSurvey\saveToDb(), ilObjPortfolioTemplate\updateActivation(), ilObjPollGUI\updateCustom(), ilSoapObjectAdministration\updateReferences(), ilObjCourse\updateSettings(), and ilCourseContentGUI\updateTimings().

TIMINGS_FIXED

const ilObjectActivation::TIMINGS_FIXED = 3

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

TIMINGS_PRESETTING

const ilObjectActivation::TIMINGS_PRESETTING = 2

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

Referenced by ilObjectXMLWriter\__appendTimeTargets(), ilCourseContentGUI\__loadFromPost(), ilCourseContentGUI\__renderItem(), ilCourseContentGUI\__renderUserItem(), ilTimingCache\_showWarning(), addListGUIActivationProperty(), ilSoapObjectAdministration\addReferences(), ilCourseContentGUI\editTimings(), ilObjectActivationGUI\initFormEdit(), ilTimingCache\readObjectInformation(), ilCourseContentGUI\showUserTimings(), ilSoapObjectAdministration\updateReferences(), and ilCourseContentGUI\updateTimings().

---

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

• Services/Object/classes/class.ilObjectActivation.php