ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
Data Structures | |
class | BinaryTest |
class | BooleanTest |
class | CompoundTest |
class | FloatTest |
class | TextTest |
class | UriTest |
Public Member Functions | |
__construct (Component $root, $name, $value=null, array $parameters=[], $group=null) | |
Creates the generic property. More... | |
setValue ($value) | |
Updates the current value. More... | |
getValue () | |
Returns the current value. More... | |
setParts (array $parts) | |
Sets a multi-valued property. More... | |
getParts () | |
Returns a multi-valued property. More... | |
add ($name, $value=null) | |
Adds a new parameter. More... | |
parameters () | |
Returns an iterable list of children. More... | |
getValueType () | |
Returns the type of value. More... | |
setRawMimeDirValue ($val) | |
Sets a raw value coming from a mimedir (iCalendar/vCard) file. More... | |
getRawMimeDirValue () | |
Returns a raw mime-dir representation of the value. More... | |
serialize () | |
Turns the object back into a serialized blob. More... | |
getJsonValue () | |
Returns the value, in the format it should be encoded for JSON. More... | |
setJsonValue (array $value) | |
Sets the JSON value, as it would appear in a jCard or jCal object. More... | |
jsonSerialize () | |
This method returns an array, with the representation as it should be encoded in JSON. More... | |
setXmlValue (array $value) | |
Hydrate data from a XML subtree, as it would appear in a xCard or xCal object. More... | |
xmlSerialize (Xml\Writer $writer) | |
This method serializes the data into XML. More... | |
__toString () | |
Called when this object is being cast to a string. More... | |
offsetExists ($name) | |
Checks if an array element exists. More... | |
offsetGet ($name) | |
Returns a parameter. More... | |
offsetSet ($name, $value) | |
Creates a new parameter. More... | |
offsetUnset ($name) | |
Removes one or more parameters with the specified name. More... | |
__clone () | |
This method is automatically called when the object is cloned. More... | |
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... | |
Data Fields | |
$name | |
$group | |
$parameters = [] | |
$delimiter = ';' | |
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 | |
xmlSerializeValue (Xml\Writer $writer) | |
This method serializes only the value of a property. More... | |
Protected Attributes | |
$value | |
Protected Attributes inherited from Sabre\VObject\Node | |
$iterator = null | |
$root | |
A property is always in a KEY:VALUE structure, and may optionally contain parameters.
Definition at line 17 of file Property.php.
Sabre\VObject\Property::__construct | ( | Component | $root, |
$name, | |||
$value = null , |
|||
array | $parameters = [] , |
||
$group = null |
|||
) |
Creates the generic property.
Parameters must be specified in key=>value syntax.
Component | $root | The root document |
string | $name | |
string | array | null | $value | |
array | $parameters | List of parameters |
string | $group | The vcard property group |
Definition at line 72 of file Property.php.
References Sabre\VObject\Property\$group, Sabre\VObject\Property\$name, Sabre\VObject\Property\$parameters, Sabre\VObject\Node\$root, Sabre\VObject\Property\$value, Sabre\VObject\Property\add(), and Sabre\VObject\Property\setValue().
Sabre\VObject\Property::__clone | ( | ) |
This method is automatically called when the object is cloned.
Specifically, this will ensure all child elements are also cloned.
Definition at line 519 of file Property.php.
References $key, and Sabre\VObject\Property\parameters().
Sabre\VObject\Property::__toString | ( | ) |
Called when this object is being cast to a string.
If the property only had a single value, you will get just that. In the case the property had multiple values, the contents will be escaped and combined with ,.
Definition at line 416 of file Property.php.
References Sabre\VObject\Property\getValue().
Sabre\VObject\Property::add | ( | $name, | |
$value = null |
|||
) |
Adds a new parameter.
If a parameter with same name already existed, the values will be combined. If nameless parameter is added, we try to guess it's name.
string | $name | |
string | null | array | $value |
Definition at line 174 of file Property.php.
References Sabre\VObject\Property\$name, Sabre\VObject\Property\$value, Sabre\VObject\Parameter\guessParameterNameByValue(), and Sabre\VObject\Property\parameters().
Referenced by Sabre\VObject\Property\__construct(), Sabre\VObject\VCardConverter\convertParameters30(), and Sabre\VObject\VCardConverter\convertParameters40().
Sabre\VObject\Property::destroy | ( | ) |
Call this method on a document if you're done using it.
It's intended to remove all circular references, so PHP can easily clean it up.
Definition at line 651 of file Property.php.
References Sabre\VObject\Property\parameters().
Sabre\VObject\Property::getJsonValue | ( | ) |
Returns the value, in the format it should be encoded for JSON.
This method must always return an array.
Definition at line 271 of file Property.php.
References Sabre\VObject\Property\getParts().
Referenced by Sabre\VObject\Property\jsonSerialize(), and Sabre\VObject\Property\xmlSerializeValue().
Sabre\VObject\Property::getParts | ( | ) |
Returns a multi-valued property.
This method always returns an array, if there was only a single value, it will still be wrapped in an array.
Definition at line 152 of file Property.php.
References Sabre\VObject\Property\$value.
Referenced by Sabre\VObject\VCardConverter\convertProperty(), Sabre\VObject\Property\ICalendar\Duration\getDateInterval(), Sabre\VObject\Property\ICalendar\DateTime\getDateTimes(), Sabre\VObject\Property\FloatValue\getJsonValue(), Sabre\VObject\Property\ICalendar\Period\getJsonValue(), Sabre\VObject\Property\Text\getJsonValue(), Sabre\VObject\Property\getJsonValue(), Sabre\VObject\Property\ICalendar\Duration\getRawMimeDirValue(), Sabre\VObject\Property\ICalendar\Period\getRawMimeDirValue(), Sabre\VObject\Property\FloatValue\getRawMimeDirValue(), Sabre\VObject\Property\ICalendar\DateTime\getRawMimeDirValue(), Sabre\VObject\Property\Text\getRawMimeDirValue(), Sabre\VObject\Property\VCard\DateAndOrTime\getRawMimeDirValue(), Sabre\VObject\Property\Text\serialize(), Sabre\VObject\Cli\serializeProperty(), Sabre\VObject\Property\ICalendar\DateTime\validate(), Sabre\VObject\Property\Text\validate(), Sabre\VObject\Property\FloatValue\xmlSerializeValue(), and Sabre\VObject\Property\Text\xmlSerializeValue().
|
abstract |
Returns a raw mime-dir representation of the value.
Referenced by Sabre\VObject\Property\getValue(), Sabre\VObject\Property\parameters(), Sabre\VObject\Property\serialize(), and Sabre\VObject\Property\validate().
Sabre\VObject\Property::getValue | ( | ) |
Returns the current value.
This method will always return a singular value. If this was a multi-value object, some decision will be made first on how to represent it as a string.
To get the correct multi-value version, use getParts.
Definition at line 115 of file Property.php.
References Sabre\VObject\Property\$value, Sabre\VObject\Node\count(), and Sabre\VObject\Property\getRawMimeDirValue().
Referenced by Sabre\VObject\Property\__toString(), Sabre\VObject\VCardConverter\convertProperty(), Sabre\VObject\Property\VCard\DateAndOrTime\getDateTime(), Sabre\VObject\Property\VCard\TimeStamp\getJsonValue(), Sabre\VObject\Property\IntegerValue\getJsonValue(), Sabre\VObject\Property\Time\getJsonValue(), Sabre\VObject\Property\Binary\getJsonValue(), Sabre\VObject\Property\VCard\DateAndOrTime\getJsonValue(), Sabre\VObject\Property\ICalendar\CalAddress\getNormalizedValue(), Sabre\VObject\Property\VCard\LanguageTag\getRawMimeDirValue(), Sabre\VObject\Property\ICalendar\DateTime\isFloating(), Sabre\VObject\Cli\serializeProperty(), Sabre\VObject\Property\VCard\DateAndOrTime\validate(), Sabre\VObject\Property\VCard\TimeStamp\xmlSerializeValue(), and Sabre\VObject\Property\VCard\DateAndOrTime\xmlSerializeValue().
|
abstract |
Returns the type of value.
This corresponds to the VALUE= parameter. Every property also has a 'default' valueType.
Referenced by Sabre\VObject\VCardConverter\convertProperty(), Sabre\VObject\Property\jsonSerialize(), Sabre\VObject\Property\parameters(), and Sabre\VObject\Property\xmlSerializeValue().
Sabre\VObject\Property::jsonSerialize | ( | ) |
This method returns an array, with the representation as it should be encoded in JSON.
This is used to create jCard or jCal documents.
Definition at line 302 of file Property.php.
References Sabre\VObject\Property\$group, Sabre\VObject\Property\$parameters, Sabre\VObject\Property\getJsonValue(), Sabre\VObject\Property\getValueType(), and Sabre\VObject\Property\parameters().
Sabre\VObject\Property::offsetExists | ( | $name | ) |
Checks if an array element exists.
mixed | $name |
Definition at line 431 of file Property.php.
References Sabre\VObject\Property\$name, and Sabre\VObject\Property\parameters().
Sabre\VObject\Property::offsetGet | ( | $name | ) |
Returns a parameter.
If the parameter does not exist, null is returned.
string | $name |
Definition at line 453 of file Property.php.
References Sabre\VObject\Property\$name, and Sabre\VObject\Property\parameters().
Referenced by Sabre\VObject\Property\validate().
Sabre\VObject\Property::offsetSet | ( | $name, | |
$value | |||
) |
Creates a new parameter.
string | $name | |
mixed | $value |
Definition at line 474 of file Property.php.
References Sabre\VObject\Property\$name, Sabre\VObject\Property\$value, and Sabre\VObject\Property\parameters().
Sabre\VObject\Property::offsetUnset | ( | $name | ) |
Removes one or more parameters with the specified name.
string | $name |
Definition at line 497 of file Property.php.
References Sabre\VObject\Property\$name, and Sabre\VObject\Property\parameters().
Referenced by Sabre\VObject\Property\ICalendar\DateTime\setDateTimes().
Sabre\VObject\Property::parameters | ( | ) |
Returns an iterable list of children.
Definition at line 196 of file Property.php.
References Sabre\VObject\Property\$parameters, Sabre\VObject\Property\getRawMimeDirValue(), Sabre\VObject\Property\getValueType(), and Sabre\VObject\Property\setRawMimeDirValue().
Referenced by Sabre\VObject\Property\__clone(), Sabre\VObject\Property\add(), Sabre\VObject\VCardConverter\convertProperty(), Sabre\VObject\Property\destroy(), Sabre\VObject\Property\jsonSerialize(), Sabre\VObject\Property\offsetExists(), Sabre\VObject\Property\offsetGet(), Sabre\VObject\Property\offsetSet(), Sabre\VObject\Property\offsetUnset(), Sabre\VObject\Property\Text\serialize(), Sabre\VObject\Property\serialize(), Sabre\VObject\Cli\serializeProperty(), Sabre\VObject\Property\validate(), and Sabre\VObject\Property\xmlSerialize().
Sabre\VObject\Property::serialize | ( | ) |
Turns the object back into a serialized blob.
Definition at line 236 of file Property.php.
References Sabre\VObject\Property\$name, Sabre\VObject\Property\getRawMimeDirValue(), and Sabre\VObject\Property\parameters().
Sabre\VObject\Property::setJsonValue | ( | array | $value | ) |
Sets the JSON value, as it would appear in a jCard or jCal object.
The value must always be an array.
array | $value |
Definition at line 286 of file Property.php.
References Sabre\VObject\Node\count(), and Sabre\VObject\Property\setValue().
Referenced by Sabre\VObject\Property\setXmlValue().
Sabre\VObject\Property::setParts | ( | array | $parts | ) |
Sets a multi-valued property.
array | $parts |
Definition at line 138 of file Property.php.
Referenced by Sabre\VObject\Property\FloatValue\setRawMimeDirValue(), and Sabre\VObject\Property\Text\validate().
|
abstract |
Sets a raw value coming from a mimedir (iCalendar/vCard) file.
This has been 'unfolded', so only 1 line will be passed. Unescaping is not yet done, but parameters are not included.
string | $val |
Referenced by Sabre\VObject\Property\parameters(), and Sabre\VObject\Property\validate().
Sabre\VObject\Property::setValue | ( | $value | ) |
Updates the current value.
This may be either a single, or multiple strings in an array.
string | array | $value |
Definition at line 98 of file Property.php.
References Sabre\VObject\Property\$value.
Referenced by Sabre\VObject\Property\__construct(), Sabre\VObject\Property\Time\setJsonValue(), Sabre\VObject\Property\setJsonValue(), Sabre\VObject\Property\FlatText\setQuotedPrintableValue(), Sabre\VObject\Property\Text\setQuotedPrintableValue(), Sabre\VObject\Property\VCard\LanguageTag\setRawMimeDirValue(), Sabre\VObject\Property\IntegerValue\setRawMimeDirValue(), Sabre\VObject\Property\Boolean\setRawMimeDirValue(), Sabre\VObject\Property\ICalendar\Duration\setRawMimeDirValue(), Sabre\VObject\Property\ICalendar\Period\setRawMimeDirValue(), and Sabre\VObject\Property\Text\setRawMimeDirValue().
Sabre\VObject\Property::setXmlValue | ( | array | $value | ) |
Hydrate data from a XML subtree, as it would appear in a xCard or xCal object.
array | $value |
Definition at line 336 of file Property.php.
References Sabre\VObject\Property\setJsonValue().
Sabre\VObject\Property::validate | ( | $options = 0 | ) |
Validates the node for correctness.
The following options are supported:
An array is returned with warnings.
Every item in the array has the following properties:
int | $options |
Definition at line 546 of file Property.php.
References $message, PHPMailer\PHPMailer\$options, $warnings, Sabre\VObject\StringUtil\convertToUTF8(), Sabre\VObject\Property\getRawMimeDirValue(), Sabre\VObject\Document\ICALENDAR20, Sabre\VObject\StringUtil\isUTF8(), Sabre\VObject\Property\offsetGet(), Sabre\VObject\Property\parameters(), Sabre\VObject\Property\setRawMimeDirValue(), Sabre\VObject\Document\VCARD21, Sabre\VObject\Document\VCARD30, and Sabre\VObject\Document\VCARD40.
Sabre\VObject\Property::xmlSerialize | ( | Xml\Writer | $writer | ) |
This method serializes the data into XML.
This is used to create xCard or xCal documents.
Xml\Writer | $writer | XML writer. |
Definition at line 350 of file Property.php.
References Sabre\VObject\Property\$parameters, Sabre\VObject\Property\parameters(), and Sabre\VObject\Property\xmlSerializeValue().
|
protected |
This method serializes only the value of a property.
This is used to create xCard or xCal documents.
Xml\Writer | $writer | XML writer. |
Definition at line 395 of file Property.php.
References Sabre\VObject\Property\$value, $values, Sabre\VObject\Property\getJsonValue(), and Sabre\VObject\Property\getValueType().
Referenced by Sabre\VObject\Property\xmlSerialize().
Sabre\VObject\Property::$delimiter = ';' |
Definition at line 57 of file Property.php.
Sabre\VObject\Property::$group |
Definition at line 35 of file Property.php.
Referenced by Sabre\VObject\Property\__construct(), Sabre\VObject\Property\Text\__construct(), and Sabre\VObject\Property\jsonSerialize().
Sabre\VObject\Property::$name |
Definition at line 26 of file Property.php.
Referenced by Sabre\VObject\Property\__construct(), Sabre\VObject\Property\Text\__construct(), Sabre\VObject\Property\add(), Sabre\VObject\Property\offsetExists(), Sabre\VObject\Property\offsetGet(), Sabre\VObject\Property\ICalendar\DateTime\offsetSet(), Sabre\VObject\Property\offsetSet(), Sabre\VObject\Property\offsetUnset(), Sabre\VObject\Property\Text\serialize(), Sabre\VObject\Property\serialize(), Sabre\VObject\Property\ICalendar\Recur\validate(), and Sabre\VObject\Property\Text\validate().
Sabre\VObject\Property::$parameters = [] |
|
protected |
Definition at line 49 of file Property.php.
Referenced by Sabre\VObject\Property\__construct(), Sabre\VObject\Property\Text\__construct(), Sabre\VObject\Property\add(), Sabre\VObject\Property\ICalendar\Duration\getDateInterval(), Sabre\VObject\Property\UtcOffset\getJsonValue(), Sabre\VObject\Property\ICalendar\Recur\getParts(), Sabre\VObject\Property\getParts(), Sabre\VObject\Property\IntegerValue\getRawMimeDirValue(), Sabre\VObject\Property\Uri\getRawMimeDirValue(), Sabre\VObject\Property\ICalendar\Recur\getValue(), Sabre\VObject\Property\getValue(), Sabre\VObject\Property\ICalendar\DateTime\offsetSet(), Sabre\VObject\Property\offsetSet(), Sabre\VObject\Property\VCard\DateAndOrTime\setDateTime(), Sabre\VObject\Property\UtcOffset\setJsonValue(), Sabre\VObject\Property\ICalendar\Period\setJsonValue(), Sabre\VObject\Property\ICalendar\DateTime\setJsonValue(), Sabre\VObject\Property\ICalendar\Recur\setValue(), Sabre\VObject\Property\Binary\setValue(), Sabre\VObject\Property\ICalendar\DateTime\setValue(), Sabre\VObject\Property\VCard\DateAndOrTime\setValue(), Sabre\VObject\Property\setValue(), Sabre\VObject\Property\Boolean\setXmlValue(), Sabre\VObject\Property\Time\setXmlValue(), Sabre\VObject\Property\ICalendar\Recur\stringToArray(), Sabre\VObject\Property\ICalendar\Recur\validate(), Sabre\VObject\Property\ICalendar\DateTime\validate(), Sabre\VObject\Property\VCard\DateAndOrTime\validate(), Sabre\VObject\Property\FloatValue\xmlSerializeValue(), Sabre\VObject\Property\ICalendar\Period\xmlSerializeValue(), Sabre\VObject\Property\ICalendar\Recur\xmlSerializeValue(), Sabre\VObject\Property\VCard\DateAndOrTime\xmlSerializeValue(), and Sabre\VObject\Property\xmlSerializeValue().