ilICalItem Class Reference

Abstract base class for all ical items (Component, Parameter and Value) More...

Inheritance diagram for ilICalItem:

Collaboration diagram for ilICalItem:

Public Member Functions
	__construct ($a_name, $a_value= '')
	Constructor.
	setValue ($a_value)
	set value
	getValue ()
	get value
	getItems ()
	get items
	getName ()
	get name
	getItemsByName ($a_name, $a_recursive=true)
	Get items by name.
	addItem ($a_item)
	Add item.

Protected Attributes
	$name = ''
	$value = ''
	$items = array()

Detailed Description

Abstract base class for all ical items (Component, Parameter and Value)

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

ilICalItem::__construct	(		$a_name,
			$a_value = ''
	)

Constructor.

public

Parameters

string

name

Reimplemented in ilICalValue, ilICalProperty, and ilICalParameter.

Definition at line 47 of file class.ilICalItem.php.

        {
                $this->name = $a_name;
                $this->value = $a_value;
        }

Member Function Documentation

ilICalItem::addItem

(

$a_item

)

Add item.

public

Parameters

ilICalItem

Definition at line 117 of file class.ilICalItem.php.

        {
                $this->items[] = $a_item;
        }

ilICalItem::getItems

(

)

get items

public

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

Referenced by ilICalProperty\getItemsByName(), and ilICalComponent\getItemsByName().

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

Here is the caller graph for this function:

ilICalItem::getItemsByName	(		$a_name,
			$a_recursive = true
	)

Get items by name.

public

Parameters

string

name

Reimplemented in ilICalComponent, and ilICalProperty.

Definition at line 105 of file class.ilICalItem.php.

        {
                return array();
        }

ilICalItem::getName

(

)

get name

public

Definition at line 93 of file class.ilICalItem.php.

References $name.

        {
                return $this->name;
        }

ilICalItem::getValue

(

)

get value

public

Definition at line 71 of file class.ilICalItem.php.

        {
                return trim($this->value);
        }

ilICalItem::setValue

(

$a_value

)

set value

public

Parameters

string

value

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

        {
                $this->value = $a_value;
        }

Field Documentation

ilICalItem::$items = array()

protected

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

ilICalItem::$name = ''

protected

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

Referenced by getName().

ilICalItem::$value = ''

protected

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

---

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

• Services/Calendar/classes/iCal/class.ilICalItem.php