LSItemOnlineStatus Class Reference

Collaboration diagram for LSItemOnlineStatus:

Public Member Functions
	setOnlineStatus (int $ref_id, bool $status)
	getOnlineStatus (int $ref_id)
	hasChangeableOnlineStatus (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)
	getObject (int $ref_id)

Static Private Attributes
static array	$objs_with_check_for_online_status

Detailed Description

Definition at line 21 of file LSItemOnlineStatus.php.

Member Function Documentation

getObject()

LSItemOnlineStatus::getObject ( int  $ref_id )

protected

Definition at line 73 of file LSItemOnlineStatus.php.

                                             : \ilObject
    {
        return \ilObjectFactory::getInstanceByRefId($ref_id);
    }

References $ref_id.

Referenced by hasChangeableOnlineStatus(), and setOnlineStatus().

Here is the caller graph for this function:

getObjectTypeFor()

LSItemOnlineStatus::getObjectTypeFor ( int  $ref_id )

protected

Definition at line 68 of file LSItemOnlineStatus.php.

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

References $ref_id.

Referenced by hasChangeableOnlineStatus().

Here is the caller graph for this function:

getOnlineStatus()

LSItemOnlineStatus::getOnlineStatus

(

int

$ref_id

)

Definition at line 46 of file LSItemOnlineStatus.php.

                                                : bool
    {
        return !\ilObject::lookupOfflineStatus(\ilObject::_lookupObjId($ref_id));
    }

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

Here is the call graph for this function:

hasChangeableOnlineStatus()

LSItemOnlineStatus::hasChangeableOnlineStatus

(

int

$ref_id

)

Definition at line 51 of file LSItemOnlineStatus.php.

                                                          : bool
    {
        $obj_type = $this->getObjectTypeFor($ref_id);
        if(! in_array($obj_type, self::$objs_with_check_for_online_status)) {
            return true;
        }
 
        $obj = $this->getObject($ref_id);
        if($obj_type === self::S_SURVEY) {
            return $obj->hasQuestions();
        }
        if($obj_type === self::S_TEST) {
            return count($obj->getQuestions()) > 0;
        }
        return false;
    }

References getObject(), and getObjectTypeFor().

Here is the call graph for this function:

setOnlineStatus()

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

Definition at line 38 of file LSItemOnlineStatus.php.

                                                              : void
    {
        $obj = $this->getObject($ref_id);
        $props = $obj->getObjectProperties()->getPropertyIsOnline();
        $props = $status ? $props->withOnline() : $props->withOffline();
        $obj->getObjectProperties()->storePropertyIsOnline($props);
    }

References getObject().

Here is the call graph for this function:

Field Documentation

$objs_with_check_for_online_status

array LSItemOnlineStatus::$objs_with_check_for_online_status

staticprivate

Initial value:

= [
        self::S_TEST,
        self::S_SURVEY,
    ]

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:

• components/ILIAS/LearningSequence/classes/LSItems/LSItemOnlineStatus.php