Representation of ECS EContent Time Place. More...

Collaboration diagram for ilECSTimePlace:

Public Member Functions
	__construct ()
	Constructor. More...

	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 ($a_end)
	set end More...

	getEnd ()
	get end More...

	getUTEnd ()
	get end as unix time More...

	setRoom ($a_room)
	set room More...

	getRoom ()
	get room More...

	setCycle ($a_cycle)
	set cycle More...

	getCycle ()
	get cycle More...

Data Fields
	$room = ''

	$begin = ''

	$end = ''

	$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 34 of file class.ilECSTimePlace.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSTimePlace::__construct ( )

Constructor.

@access public

Parameters

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

        {
                
        }

Member Function Documentation

◆ getBegin()

ilECSTimePlace::getBegin ( )

get begin

@access public

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

        {
                return $this->begin;
        }

References $begin.

◆ getCycle()

ilECSTimePlace::getCycle ( )

get cycle

@access public

Parameters

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

        {
                return $this->cycle;
        }

References $cycle.

◆ getEnd()

ilECSTimePlace::getEnd ( )

get end

@access public

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

        {
                return $this->end;
        }

References $end.

◆ getRoom()

ilECSTimePlace::getRoom ( )

get room

@access public

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

        {
                return $this->room;
        }

References $room.

◆ getUTBegin()

ilECSTimePlace::getUTBegin ( )

get begin as unix time

@access public

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

        {
                include_once './Services/Calendar/classes/class.ilDateTime.php';
                $dt = new ilDateTime($this->begin, IL_CAL_DATE, ilTimeZone::UTC);
                return $dt->get(IL_CAL_UNIX);
                
        }

References IL_CAL_DATE, IL_CAL_UNIX, and ilTimeZone\UTC.

Referenced by loadFromJson().

Here is the caller graph for this function:

◆ getUTEnd()

ilECSTimePlace::getUTEnd ( )

get end as unix time

@access public

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

        {
                include_once './Services/Calendar/classes/class.ilDateTime.php';
                $dt = new ilDateTime($this->end, IL_CAL_DATE, ilTimeZone::UTC);
                return $dt->get(IL_CAL_UNIX);
        }

References IL_CAL_DATE, IL_CAL_UNIX, and ilTimeZone\UTC.

Referenced by loadFromJson().

Here is the caller graph for this function:

◆ loadFromJson()

ilECSTimePlace::loadFromJson ( $a_json )

load from json

@access public

Parameters

object json representation

Exceptions

ilException

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

        {
                global $ilLog;
 
                if(!is_object($a_json))
                {
                        $ilLog->write(__METHOD__ . ': Cannot load from JSON. No object given.');
                        throw new ilException('Cannot parse ECSContent.');
                }
                
                $GLOBALS['ilLog']->write(__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;
                #$this->day = $a_json->day;
                
                $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 = '';
                }
        }

References $GLOBALS, $ilLog, ilDateTime\_before(), getUTBegin(), getUTEnd(), IL_CAL_DATE, and IL_CAL_UNIX.

Here is the call graph for this function:

◆ setBegin()

ilECSTimePlace::setBegin ( $a_begin )

set begin

@access public

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

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

References IL_CAL_DATE, IL_CAL_UNIX, and ilTimeZone\UTC.

◆ setCycle()

ilECSTimePlace::setCycle ( $a_cycle )

set cycle

@access public

Parameters

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

        {
                $this->cycle = $a_cycle;
        }

◆ setEnd()

ilECSTimePlace::setEnd ( $a_end )

set end

@access public

Parameters

string end

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

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

References IL_CAL_DATE, IL_CAL_UNIX, and ilTimeZone\UTC.

◆ setRoom()

ilECSTimePlace::setRoom ( $a_room )

set room

@access public

Parameters

string room

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

        {
                $this->room = $a_room;
        }

Field Documentation

◆ $begin

ilECSTimePlace::$begin = ''

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

Referenced by getBegin().

◆ $cycle

ilECSTimePlace::$cycle = ''

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

Referenced by getCycle().

◆ $end

ilECSTimePlace::$end = ''

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

Referenced by getEnd().

◆ $room

ilECSTimePlace::$room = ''

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

Referenced by getRoom().

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

Services/WebServices/ECS/classes/class.ilECSTimePlace.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBegin()

◆ getCycle()

◆ getEnd()

◆ getRoom()

◆ getUTBegin()

◆ getUTEnd()

◆ loadFromJson()

◆ setBegin()

◆ setCycle()

◆ setEnd()

◆ setRoom()

Field Documentation

◆ $begin

◆ $cycle

◆ $end

◆ $room