BINARY property. More...

Inheritance diagram for Sabre\VObject\Property\Binary:

Collaboration diagram for Sabre\VObject\Property\Binary:

Public Member Functions
	setValue ($value)
	Updates the current 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...

	getValueType ()
	Returns the type of value. 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...

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...

Data Fields
	$delimiter = null

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

Additional Inherited Members
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

BINARY property.

This object represents BINARY values.

Binary values are most commonly used by the iCalendar ATTACH property, and the vCard PHOTO property.

This property will transparently encode and decode to base64.

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

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

Definition at line 21 of file Binary.php.

Member Function Documentation

◆ getJsonValue()

Sabre\VObject\Property\Binary::getJsonValue ( )

Returns the value, in the format it should be encoded for json.

This method must always return an array.

Returns: array

Definition at line 106 of file Binary.php.

References Sabre\VObject\Property\getValue().

                             {
 
         return [base64_encode($this->getValue())];
 
     }

Here is the call graph for this function:

◆ getRawMimeDirValue()

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

Returns a raw mime-dir representation of the value.

Returns: string

Definition at line 79 of file Binary.php.

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

◆ getValueType()

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

Returns the type of value.

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

Returns: string

Definition at line 93 of file Binary.php.

                             {
 
         return 'BINARY';
 
     }

◆ setJsonValue()

Sabre\VObject\Property\Binary::setJsonValue ( array $value )

Sets the json value, as it would appear in a jCard or jCal object.

The value must always be an array.

Parameters

array $value

Returns: void

Definition at line 121 of file Binary.php.

                                         {
 
         $value = array_map('base64_decode', $value);
         parent::setJsonValue($value);
 
     }

◆ setRawMimeDirValue()

Sabre\VObject\Property\Binary::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 68 of file Binary.php.

                                       {
 
         $this->value = base64_decode($val);
 
     }

◆ setValue()

Sabre\VObject\Property\Binary::setValue ( $value )

Updates the current value.

This may be either a single, or multiple strings in an array.

Parameters

string | array $value

Returns: void

Definition at line 40 of file Binary.php.

References Sabre\VObject\Property\$value, and Sabre\VObject\Node\count().

                               {
 
         if (is_array($value)) {
 
             if (count($value) === 1) {
                 $this->value = $value[0];
             } else {
                 throw new \InvalidArgumentException('The argument must either be a string or an array with only one child');
             }
 
         } else {
 
             $this->value = $value;
 
         }
 
     }

Here is the call graph for this function:

Field Documentation

◆ $delimiter

Sabre\VObject\Property\Binary::$delimiter = null

Definition at line 29 of file Binary.php.

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

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

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getJsonValue()

◆ getRawMimeDirValue()

◆ getValueType()

◆ setJsonValue()

◆ setRawMimeDirValue()

◆ setValue()

Field Documentation

◆ $delimiter