Inheritance diagram for Sabre\VObject\Property\Boolean:

Collaboration diagram for Sabre\VObject\Property\Boolean:

Public Member Functions
	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...

	getValueType ()
	Returns the type of value. More...

	setXmlValue (array $value)
	Hydrate data from a XML subtree, as it would appear in a xCard or xCal object. More...

Public Member Functions inherited from Sabre\VObject\Property
	__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...

Additional Inherited Members
Data Fields inherited from Sabre\VObject\Property
	$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 inherited from Sabre\VObject\Property
	xmlSerializeValue (Xml\Writer $writer)
	This method serializes only the value of a property. More...

Protected Attributes inherited from Sabre\VObject\Property
	$value

Protected Attributes inherited from Sabre\VObject\Node
	$iterator = null

	$root

Detailed Description

Boolean property.

This object represents BOOLEAN values. These are always the case-insenstive string TRUE or FALSE.

Automatic conversion to PHP's true and false are done.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

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

Definition at line 20 of file Boolean.php.

Member Function Documentation

◆ getRawMimeDirValue()

Sabre\VObject\Property\Boolean::getRawMimeDirValue ( )

Returns a raw mime-dir representation of the value.

Returns: string

Definition at line 44 of file Boolean.php.

                                   {
 
         return $this->value ? 'TRUE' : 'FALSE';
 
     }

◆ getValueType()

Sabre\VObject\Property\Boolean::getValueType ( )

Returns the type of value.

This corresponds to the VALUE= parameter. Every property also has a 'default' valueType.

Returns: string

Definition at line 58 of file Boolean.php.

                             {
 
         return 'BOOLEAN';
 
     }

◆ setRawMimeDirValue()

Sabre\VObject\Property\Boolean::setRawMimeDirValue ( $val )

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.

Parameters

string $val

Returns: void

Definition at line 32 of file Boolean.php.

References Sabre\VObject\Property\setValue().

                                       {
 
         $val = strtoupper($val) === 'TRUE' ? true : false;
         $this->setValue($val);
 
     }

Here is the call graph for this function:

◆ setXmlValue()

Sabre\VObject\Property\Boolean::setXmlValue ( array $value )

Hydrate data from a XML subtree, as it would appear in a xCard or xCal object.

Parameters

array $value

Returns: void

Definition at line 72 of file Boolean.php.

References Sabre\VObject\Property\$value.

                                        {
 
         $value = array_map(
             function($value) {
                 return 'true' === $value;
             },
             $value
         );
         parent::setXmlValue($value);
 
     }

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

libs/composer/vendor/sabre/vobject/lib/Property/Boolean.php