ilECSTimePlace Class Reference

Representation of ECS EContent Time Place. More...

Collaboration diagram for ilECSTimePlace:

Public Member Functions
	__construct ()
	__toString ()
	loadFromJson ($a_json)
	load from json More...
	setBegin ($a_begin)
	set begin More...
	getBegin ()
	get begin More...
	getUTBegin ()
	get begin as unix time More...
	setEnd (string $a_end)
	set end More...
	getEnd ()
	get end More...
	getUTEnd ()
	get end as unix time More...
	setRoom (string $a_room)
	set room More...
	getRoom ()
	get room More...
	setCycle ($a_cycle)
	set cycle More...
	getCycle ()
	get cycle More...

Private Attributes
ilLogger	$logger
string	$room = ''
string	$begin = ''
string	$end = ''
string	$cycle = ''

Detailed Description

Representation of ECS EContent Time Place.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilECSTimePlace::__construct

(

)

Definition at line 38 of file class.ilECSTimePlace.php.

References $DIC, and ILIAS\Repository\logger().

    {
        global $DIC;
        $this->logger = $DIC->logger()->wsrv();
    }

Here is the call graph for this function:

Member Function Documentation

__toString()

ilECSTimePlace::__toString

(

)

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

    {
        return "ECS Time and Place";
    }

getBegin()

ilECSTimePlace::getBegin

(

)

get begin

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

References $begin.

                              : string
    {
        return $this->begin;
    }

getCycle()

ilECSTimePlace::getCycle

(

)

get cycle

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

References $cycle.

                              : string
    {
        return $this->cycle;
    }

getEnd()

ilECSTimePlace::getEnd

(

)

get end

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

References $end.

                            : string
    {
        return $this->end;
    }

getRoom()

ilECSTimePlace::getRoom

(

)

get room

Definition at line 150 of file class.ilECSTimePlace.php.

References $room.

                             : string
    {
        return $this->room;
    }

getUTBegin()

ilECSTimePlace::getUTBegin

(

)

get begin as unix time

Definition at line 104 of file class.ilECSTimePlace.php.

References IL_CAL_DATE, IL_CAL_UNIX, and ilTimeZone\UTC.

Referenced by loadFromJson().

    {
        return (new ilDateTime($this->begin, IL_CAL_DATE, ilTimeZone::UTC))->get(IL_CAL_UNIX);
    }

Here is the caller graph for this function:

getUTEnd()

ilECSTimePlace::getUTEnd

(

)

get end as unix time

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

References IL_CAL_DATE, IL_CAL_UNIX, and ilTimeZone\UTC.

Referenced by loadFromJson().

    {
        return (new ilDateTime($this->end, IL_CAL_DATE, ilTimeZone::UTC))->get(IL_CAL_UNIX);
    }

Here is the caller graph for this function:

loadFromJson()

ilECSTimePlace::loadFromJson

(

$a_json

)

load from json

public

Parameters

object

json representation

Exceptions

ilException

Definition at line 56 of file class.ilECSTimePlace.php.

References ilDateTime\_before(), getUTBegin(), getUTEnd(), IL_CAL_DATE, IL_CAL_UNIX, and ILIAS\Repository\logger().

                                         : void
    {
        if (!is_object($a_json)) {
            $this->logger->error(__METHOD__ . ': Cannot load from JSON. No object given.');
            throw new ilException('Cannot parse ECSContent.');
        }

        $this->logger->debug(__METHOD__ . ': ' . print_r($a_json, true));

        $this->room = $a_json->room ?? "";
        $this->begin = $a_json->begin ?? "";
        $this->end = $a_json->end ?? "";
        $this->cycle = $a_json->cycle ?? "";

        $two = new ilDate('2000-01-02', IL_CAL_DATE);
        if (ilDate::_before(new ilDateTime($this->getUTBegin(), IL_CAL_UNIX), $two)) {
            $this->begin = '';
        }
        if (ilDate::_before(new ilDateTime($this->getUTEnd(), IL_CAL_UNIX), $two)) {
            $this->end = '';
        }
    }

Here is the call graph for this function:

setBegin()

ilECSTimePlace::setBegin

(

$a_begin

)

set begin

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

References IL_CAL_DATE, IL_CAL_UNIX, and ilTimeZone\UTC.

                                      : void
    {
        // is it unix time ?
        if (is_numeric($a_begin) && $a_begin) {
            $dt = new ilDateTime($a_begin, IL_CAL_UNIX, ilTimeZone::UTC);
            $this->end = $dt->get(IL_CAL_DATE);
        } else {
            $this->begin = $a_begin;
        }
    }

setCycle()

ilECSTimePlace::setCycle

(

$a_cycle

)

set cycle

Definition at line 158 of file class.ilECSTimePlace.php.

                                      : void
    {
        $this->cycle = $a_cycle;
    }

setEnd()

ilECSTimePlace::setEnd

(

string

$a_end

)

set end

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

References IL_CAL_DATE, IL_CAL_UNIX, and ilTimeZone\UTC.

                                         : void
    {
        // is it unix time ?
        if (is_numeric($a_end) && $a_end) {
            $dt = new ilDateTime($a_end, IL_CAL_UNIX, ilTimeZone::UTC);
            $this->end = $dt->get(IL_CAL_DATE);
        } else {
            $this->end = $a_end;
        }
    }

setRoom()

ilECSTimePlace::setRoom

(

string

$a_room

)

set room

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

                                           : void
    {
        $this->room = $a_room;
    }

Field Documentation

$begin

string ilECSTimePlace::$begin = ''

private

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

Referenced by getBegin().

$cycle

string ilECSTimePlace::$cycle = ''

private

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

Referenced by getCycle().

$end

string ilECSTimePlace::$end = ''

private

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

Referenced by getEnd().

$logger

ilLogger ilECSTimePlace::$logger

private

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

$room

string ilECSTimePlace::$room = ''

private

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

Referenced by getRoom().

---

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

• components/ILIAS/WebServices/ECS/classes/class.ilECSTimePlace.php