LSItemOnlineStatus Class Reference

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

Collaboration diagram for LSItemOnlineStatus:

Public Member Functions
	setOnlineStatus (int $ref_id, bool $status)
	getOnlineStatus (int $ref_id)
	hasOnlineStatus (int $ref_id)

Data Fields
const	S_LEARNMODULE_IL = "lm"
const	S_LEARNMODULE_HTML = "htlm"
const	S_SAHS = "sahs"
const	S_TEST = "tst"
const	S_SURVEY = "svy"
const	S_CONTENTPAGE = "copa"
const	S_EXERCISE = "exc"
const	S_IND_ASSESSMENT = "iass"
const	S_FILE = "file"

Protected Member Functions
	getObjectTypeFor (int $ref_id)

Static Private Attributes
static array	$obj_with_online_status

Detailed Description

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

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

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

Definition at line 21 of file LSItemOnlineStatus.php.

Member Function Documentation

getObjectTypeFor()

LSItemOnlineStatus::getObjectTypeFor ( int  $ref_id )

protected

Definition at line 63 of file LSItemOnlineStatus.php.

                                                    : string
    {
        return \ilObject::_lookupType($ref_id, true);
    }

References $ref_id.

Referenced by hasOnlineStatus().

Here is the caller graph for this function:

getOnlineStatus()

LSItemOnlineStatus::getOnlineStatus

(

int

$ref_id

)

Definition at line 49 of file LSItemOnlineStatus.php.

                                                : bool
    {
        if (!$this->hasOnlineStatus($ref_id)) {
            return true;
        }
        return !\ilObject::lookupOfflineStatus(\ilObject::_lookupObjId($ref_id));
    }

References $ref_id, ilObject\_lookupObjId(), hasOnlineStatus(), and ilObject\lookupOfflineStatus().

Here is the call graph for this function:

hasOnlineStatus()

LSItemOnlineStatus::hasOnlineStatus

(

int

$ref_id

)

Definition at line 57 of file LSItemOnlineStatus.php.

                                                : bool
    {
        $type = $this->getObjectTypeFor($ref_id);
        return in_array($type, self::$obj_with_online_status);
    }

References $type, and getObjectTypeFor().

Referenced by getOnlineStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

setOnlineStatus()

LSItemOnlineStatus::setOnlineStatus	(	int	$ref_id,
		bool	$status
	)

Definition at line 42 of file LSItemOnlineStatus.php.

                                                              : void
    {
        $obj = \ilObjectFactory::getInstanceByRefId($ref_id);
        $obj->setOfflineStatus(!$status);
        $obj->update();
    }

References $ref_id, and ilObjectFactory\getInstanceByRefId().

Here is the call graph for this function:

Field Documentation

$obj_with_online_status

array LSItemOnlineStatus::$obj_with_online_status

staticprivate

Initial value:

= array(
        self::S_LEARNMODULE_IL,
        self::S_LEARNMODULE_HTML,
        self::S_SAHS,
        self::S_TEST,
        self::S_SURVEY,
        self::S_CONTENTPAGE
    )

Definition at line 33 of file LSItemOnlineStatus.php.

S_CONTENTPAGE

const LSItemOnlineStatus::S_CONTENTPAGE = "copa"

Definition at line 28 of file LSItemOnlineStatus.php.

S_EXERCISE

const LSItemOnlineStatus::S_EXERCISE = "exc"

Definition at line 29 of file LSItemOnlineStatus.php.

S_FILE

const LSItemOnlineStatus::S_FILE = "file"

Definition at line 31 of file LSItemOnlineStatus.php.

S_IND_ASSESSMENT

const LSItemOnlineStatus::S_IND_ASSESSMENT = "iass"

Definition at line 30 of file LSItemOnlineStatus.php.

S_LEARNMODULE_HTML

const LSItemOnlineStatus::S_LEARNMODULE_HTML = "htlm"

Definition at line 24 of file LSItemOnlineStatus.php.

S_LEARNMODULE_IL

const LSItemOnlineStatus::S_LEARNMODULE_IL = "lm"

Definition at line 23 of file LSItemOnlineStatus.php.

S_SAHS

const LSItemOnlineStatus::S_SAHS = "sahs"

Definition at line 25 of file LSItemOnlineStatus.php.

S_SURVEY

const LSItemOnlineStatus::S_SURVEY = "svy"

Definition at line 27 of file LSItemOnlineStatus.php.

S_TEST

const LSItemOnlineStatus::S_TEST = "tst"

Definition at line 26 of file LSItemOnlineStatus.php.

---

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

• Modules/LearningSequence/classes/LSItems/LSItemOnlineStatus.php