ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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. More...
 
 setValue ($a_value)
 set value More...
 
 getValue ()
 get value More...
 
 getItems ()
 get items More...
 
 getName ()
 get name More...
 
 getItemsByName ($a_name, $a_recursive=true)
 Get items by name. More...
 
 addItem ($a_item)
 Add item. More...
 

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

◆ __construct()

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

Constructor.

@access public

Parameters
stringname

Reimplemented in ilICalValue, ilICalParameter, and ilICalProperty.

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

48 {
49 $this->name = $a_name;
50 $this->value = $a_value;
51 }

Member Function Documentation

◆ addItem()

ilICalItem::addItem (   $a_item)

Add item.

@access public

Parameters
ilICalItem

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

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

◆ getItems()

ilICalItem::getItems ( )

get items

@access public

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

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

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

+ Here is the caller graph for this function:

◆ getItemsByName()

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

Get items by name.

@access public

Parameters
stringname

Reimplemented in ilICalComponent, and ilICalProperty.

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

106 {
107 return array();
108 }

◆ getName()

ilICalItem::getName ( )

get name

@access public

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

94 {
95 return $this->name;
96 }

References $name.

◆ getValue()

ilICalItem::getValue ( )

get value

@access public

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

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

◆ setValue()

ilICalItem::setValue (   $a_value)

set value

@access public

Parameters
stringvalue

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

61 {
62 $this->value = $a_value;
63 }

Field Documentation

◆ $items

ilICalItem::$items = array()
protected

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

◆ $name

ilICalItem::$name = ''
protected

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

Referenced by getName().

◆ $value

ilICalItem::$value = ''
protected

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


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