ilDateList Class Reference

List of dates. More...

Inheritance diagram for ilDateList:

Collaboration diagram for ilDateList:

Public Member Functions
	__construct ($a_type)
	Constructor. More...
	rewind ()
	Iterator Rewind. More...
	current ()
	Iterator Current. More...
	key ()
	Iterator key. More...
	next ()
	Iterator next. More...
	valid ()
	Iterator valid. More...
	get ()
	get More...
	getAtPosition ($a_pos)
	get item at specific position More...
	add ($date)
	add a date to the date list More...
	merge (ilDateList $other_list)
	Merge two lists. More...
	remove (ilDateTime $remove)
	remove from list More...
	removeByDAY (ilDateTime $remove)
	sort ()
	Sort list. More...
	__toString ()
	to string More...

Data Fields
const	TYPE_DATE = 1
const	TYPE_DATETIME = 2

Protected Attributes
	$list_item = array()
	$type

Detailed Description

List of dates.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilDateList::__construct

(

$a_type

)

Constructor.

@access public

Parameters

type	list of TYPE_DATE or type TYPE_DATETIME

Definition at line 50 of file class.ilDateList.php.

    {
        $this->type = $a_type;
        $this->list_item = array();
    }

References $a_type.

Member Function Documentation

__toString()

ilDateList::__toString

(

)

to string

@access public

Definition at line 203 of file class.ilDateList.php.

    {
        $out = '<br />';
        foreach ($this->get() as $date) {
            $out .= $date->get(IL_CAL_DATETIME, '', 'Europe/Berlin') . '<br/>';
        }
        return $out;
    }

References $out, and IL_CAL_DATETIME.

add()

ilDateList::add

(

$date

)

add a date to the date list

@access public

Parameters

object

ilDateTime

Definition at line 138 of file class.ilDateList.php.

    {
        // the unix time is the key.
        // It's casted to string because array_merge overwrites only string keys
        // @see merge
        $this->list_item[(string) $date->get(IL_CAL_UNIX)] = clone $date;
    }

References IL_CAL_UNIX.

Referenced by merge().

Here is the caller graph for this function:

current()

ilDateList::current

(

)

Iterator Current.

Returns

Definition at line 70 of file class.ilDateList.php.

    {
        return current($this->list_item);
    }

References current().

Referenced by current(), and valid().

Here is the call graph for this function:

Here is the caller graph for this function:

get()

ilDateList::get

(

)

get

@access public

Definition at line 109 of file class.ilDateList.php.

    {
        return $this->list_item ? $this->list_item : array();
    }

Referenced by ilCalendarRecurrenceCalculator\applyBYDAYRules(), ilCalendarRecurrenceCalculator\applyBYMONTHDAYRules(), ilCalendarRecurrenceCalculator\applyBYMONTHRules(), ilCalendarRecurrenceCalculator\applyBYWEEKNORules(), ilCalendarRecurrenceCalculator\applyBYYEARDAYRules(), and merge().

Here is the caller graph for this function:

getAtPosition()

ilDateList::getAtPosition

(

$a_pos

)

get item at specific position

@access public

Parameters

int	position (first position is 1)

Definition at line 121 of file class.ilDateList.php.

    {
        $counter = 1;
        foreach ($this->get() as $item) {
            if ($counter++ == $a_pos) {
                return $item;
            }
        }
        return null;
    }

References $counter.

key()

ilDateList::key

(

)

Iterator key.

Returns

Definition at line 79 of file class.ilDateList.php.

    {
        return key($this->list_item);
    }

References key().

Referenced by key().

Here is the call graph for this function:

Here is the caller graph for this function:

merge()

ilDateList::merge

(

ilDateList

$other_list

)

Merge two lists.

@access public

Parameters

object

ilDateList

Definition at line 153 of file class.ilDateList.php.

    {
        foreach ($other_list->get() as $new_date) {
            $this->add($new_date);
        }
    }

References add(), and get().

Here is the call graph for this function:

next()

ilDateList::next

(

)

Iterator next.

Returns

Definition at line 88 of file class.ilDateList.php.

    {
        return next($this->list_item);
    }

References next().

Referenced by next().

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

ilDateList::remove

(

ilDateTime

$remove

)

remove from list

@access public

Parameters

object

ilDateTime

Definition at line 167 of file class.ilDateList.php.

    {
        $unix_remove = $remove->get(IL_CAL_UNIX);
        if (isset($this->list_item[$unix_remove])) {
            unset($this->list_item[$unix_remove]);
        }
        return true;
    }

References IL_CAL_UNIX.

removeByDAY()

ilDateList::removeByDAY

(

ilDateTime

$remove

)

Definition at line 176 of file class.ilDateList.php.

    {
        foreach ($this->list_item as $key => $dt) {
            if (ilDateTime::_equals($remove, $dt, IL_CAL_DAY, ilTimeZone::UTC)) {
                unset($this->list_item[$key]);
            }
        }
        return true;
    }

References $key, ilDateTime\_equals(), IL_CAL_DAY, and ilTimeZone\UTC.

Here is the call graph for this function:

rewind()

ilDateList::rewind

(

)

Iterator Rewind.

Returns

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

    {
        reset($this->list_item);
    }

sort()

ilDateList::sort

(

)

Sort list.

@access public

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

    {
        return ksort($this->list_item, SORT_NUMERIC);
    }

Referenced by ilCalendarRecurrenceCalculator\applyBYSETPOSRules().

Here is the caller graph for this function:

valid()

ilDateList::valid

(

)

Iterator valid.

Returns

Definition at line 97 of file class.ilDateList.php.

    {
        return $this->current() !== false;
    }

References current().

Here is the call graph for this function:

Field Documentation

$list_item

ilDateList::$list_item = array()

protected

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

$type

ilDateList::$type

protected

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

TYPE_DATE

const ilDateList::TYPE_DATE = 1

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

Referenced by ilCalendarUtil\_buildMonthDayList(), ilCalendarUtil\_buildWeekDayList(), and ilCalendarRecurrenceCalculator\initDateList().

TYPE_DATETIME

const ilDateList::TYPE_DATETIME = 2

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

Referenced by ilConsultationHoursGUI\createAppointments(), and ilCalendarRecurrenceCalculator\initDateList().

---

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

• Services/Calendar/classes/class.ilDateList.php