ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Sabre\VObject\Component\VTimeZone Class Reference

The VTimeZone component. More...

+ Inheritance diagram for Sabre\VObject\Component\VTimeZone:
+ Collaboration diagram for Sabre\VObject\Component\VTimeZone:

Public Member Functions

 getTimeZone ()
 Returns the PHP DateTimeZone for this VTIMEZONE component. More...
 
 getValidationRules ()
 
- Public Member Functions inherited from Sabre\VObject\Component
 __construct (Document $root, $name, array $children=[], $defaults=true)
 Creates a new component. More...
 
 add ()
 Adds a new property or component, and returns the new item. More...
 
 remove ($item)
 This method removes a component or property from this component. More...
 
 children ()
 Returns a flat list of all the properties and components in this component. More...
 
 getComponents ()
 This method only returns a list of sub-components. More...
 
 select ($name)
 Returns an array with elements that match the specified name. More...
 
 serialize ()
 Turns the object back into a serialized blob. More...
 
 jsonSerialize ()
 This method returns an array, with the representation as it should be encoded in JSON. More...
 
 xmlSerialize (Xml\Writer $writer)
 This method serializes the data into XML. More...
 
 __isset ($name)
 This method checks if a sub-element with the specified name exists. More...
 
 __set ($name, $value)
 Using the setter method you can add properties or subcomponents. More...
 
 __unset ($name)
 Removes all properties and components within this component with the specified name. More...
 
 __clone ()
 This method is automatically called when the object is cloned. More...
 
 getValidationRules ()
 
 validate ($options=0)
 Validates the node for correctness. More...
 
 destroy ()
 Call this method on a document if you're done using it. More...
 
- Public Member Functions inherited from Sabre\VObject\Node
 serialize ()
 Serializes the node into a mimedir format. More...
 
 jsonSerialize ()
 This method returns an array, with the representation as it should be encoded in JSON. More...
 
 xmlSerialize (Xml\Writer $writer)
 This method serializes the data into XML. More...
 
 destroy ()
 Call this method on a document if you're done using it. More...
 
 getIterator ()
 Returns the iterator for this object. More...
 
 setIterator (ElementList $iterator)
 Sets the overridden iterator. More...
 
 validate ($options=0)
 Validates the node for correctness. More...
 
 count ()
 Returns the number of elements. More...
 
 offsetExists ($offset)
 Checks if an item exists through ArrayAccess. More...
 
 offsetGet ($offset)
 Gets an item through ArrayAccess. More...
 
 offsetSet ($offset, $value)
 Sets an item through ArrayAccess. More...
 
 offsetUnset ($offset)
 Sets an item through ArrayAccess. More...
 
- Public Member Functions inherited from Sabre\Xml\XmlSerializable
 xmlSerialize (Writer $writer)
 The xmlSerialize method is called during xml writing. More...
 

Additional Inherited Members

- Data Fields inherited from Sabre\VObject\Component
 $name
 
- Data Fields inherited from Sabre\VObject\Node
const REPAIR = 1
 The following constants are used by the validate() method. More...
 
const PROFILE_CARDDAV = 2
 If this option is set, the validator will operate on the vcards on the assumption that the vcards need to be valid for CardDAV. More...
 
const PROFILE_CALDAV = 4
 If this option is set, the validator will operate on iCalendar objects on the assumption that the vcards need to be valid for CalDAV. More...
 
 $parent
 
- Protected Member Functions inherited from Sabre\VObject\Component
 getDefaults ()
 This method should return a list of default property values. More...
 
- Protected Attributes inherited from Sabre\VObject\Component
 $children = []
 
- Protected Attributes inherited from Sabre\VObject\Node
 $iterator = null
 
 $root
 

Detailed Description

The VTimeZone component.

This component adds functionality to a component, specific for VTIMEZONE components.

Author
Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 17 of file VTimeZone.php.

Member Function Documentation

◆ getTimeZone()

Sabre\VObject\Component\VTimeZone::getTimeZone ( )

Returns the PHP DateTimeZone for this VTIMEZONE component.

If we can't accurately determine the timezone, this method will return UTC.

Returns
\DateTimeZone

Definition at line 27 of file VTimeZone.php.

27 {
28
29 return VObject\TimeZoneUtil::getTimeZone((string)$this->TZID, $this->root);
30
31 }
static getTimeZone($tzid, Component $vcalendar=null, $failIfUncertain=false)
This method will try to find out the correct timezone for an iCalendar date-time value.

References Sabre\VObject\TimeZoneUtil\getTimeZone().

+ Here is the call graph for this function:

◆ getValidationRules()

Sabre\VObject\Component\VTimeZone::getValidationRules ( )

Reimplemented from Sabre\VObject\Component.

Definition at line 48 of file VTimeZone.php.

48 {
49
50 return [
51 'TZID' => 1,
52
53 'LAST-MODIFIED' => '?',
54 'TZURL' => '?',
55
56 // At least 1 STANDARD or DAYLIGHT must appear.
57 //
58 // The validator is not specific yet to pick this up, so these
59 // rules are too loose.
60 'STANDARD' => '*',
61 'DAYLIGHT' => '*',
62 ];
63
64 }

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