Inheritance diagram for Sabre\VObject\Property\Text:

Collaboration diagram for Sabre\VObject\Property\Text:

Public Member Functions
	__construct (Component $root, $name, $value=null, array $parameters=[], $group=null)
	Creates the property. More...

	setRawMimeDirValue ($val)
	Sets a raw value coming from a mimedir (iCalendar/vCard) file. More...

	setQuotedPrintableValue ($val)
	Sets the value as a quoted-printable encoded string. More...

	getRawMimeDirValue ()
	Returns a raw mime-dir representation of the value. More...

	getJsonValue ()
	Returns the value, in the format it should be encoded for json. More...

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

	serialize ()
	Turns the object back into a serialized blob. More...

	validate ($options=0)
	Validates the node for correctness. 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 = ','

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
	xmlSerializeValue (Xml\Writer $writer)
	This method serializes only the value of a property. More...

Protected Member Functions inherited from Sabre\VObject\Property
	xmlSerializeValue (Xml\Writer $writer)
	This method serializes only the value of a property. More...

Protected Attributes
	$structuredValues

	$minimumPropertyValues

Protected Attributes inherited from Sabre\VObject\Property
	$value

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

	$root

Detailed Description

Text property.

This object represents TEXT values.

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

Constructor & Destructor Documentation

◆ __construct()

Sabre\VObject\Property\Text::__construct	(	Component	$root,
			$name,
			$value = `null`,
		array	$parameters = `[]`,
			$group = `null`
	)

Creates the property.

You can specify the parameters either in key=>value syntax, in which case parameters will automatically be created, or you can just pass a list of Parameter objects.

Parameters

Component	$root	The root document
string	$name
string \| array \| null	$value
array	$parameters	List of parameters
string	$group	The vcard property group

Returns: void

Definition at line 75 of file Text.php.

References Sabre\VObject\Property\$group, Sabre\VObject\Property\$name, Sabre\VObject\Property\$parameters, and Sabre\VObject\Property\$value.

                                                                                                        {
 
         // There's two types of multi-valued text properties:
         // 1. multivalue properties.
         // 2. structured value properties
         //
         // The former is always separated by a comma, the latter by semi-colon.
         if (in_array($name, $this->structuredValues)) {
             $this->delimiter = ';';
         }
 
         parent::__construct($root, $name, $value, $parameters, $group);
 
     }

Member Function Documentation

◆ getJsonValue()

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

References Sabre\VObject\Property\getParts().

                             {
 
         // Structured text values should always be returned as a single
         // array-item. Multi-value text should be returned as multiple items in
         // the top-array.
         if (in_array($this->name, $this->structuredValues)) {
             return [$this->getParts()];
         }
         return $this->getParts();
 
     }

Here is the call graph for this function:

◆ getRawMimeDirValue()

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

Returns a raw mime-dir representation of the value.

Returns: string

Definition at line 134 of file Text.php.

References Sabre\VObject\Property\getParts().

Referenced by Sabre\VObject\Property\Unknown\getJsonValue().

                                   {
 
         $val = $this->getParts();
 
         if (isset($this->minimumPropertyValues[$this->name])) {
             $val = array_pad($val, $this->minimumPropertyValues[$this->name], '');
         }
 
         foreach ($val as &$item) {
 
             if (!is_array($item)) {
                 $item = [$item];
             }
 
             foreach ($item as &$subItem) {
                 $subItem = strtr(
                     $subItem,
                     [
                         '\\' => '\\\\',
                         ';'  => '\;',
                         ','  => '\,',
                         "\n" => '\n',
                         "\r" => "",
                     ]
                 );
             }
             $item = implode(',', $item);
 
         }
 
         return implode($this->delimiter, $val);
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValueType()

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

Returns the type of value.

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

Returns: string

Definition at line 195 of file Text.php.

                             {
 
         return 'TEXT';
 
     }

◆ serialize()

Sabre\VObject\Property\Text::serialize ( )

Turns the object back into a serialized blob.

Returns: string

Definition at line 206 of file Text.php.

References $ii, Sabre\VObject\Property\$name, $out, Sabre\VObject\Node\count(), Sabre\VObject\Property\getParts(), Sabre\VObject\Property\parameters(), and Sabre\VObject\Document\VCARD21.

                          {
 
         // We need to kick in a special type of encoding, if it's a 2.1 vcard.
         if ($this->root->getDocumentType() !== Document::VCARD21) {
             return parent::serialize();
         }
 
         $val = $this->getParts();
 
         if (isset($this->minimumPropertyValues[$this->name])) {
             $val = \array_pad($val, $this->minimumPropertyValues[$this->name], '');
         }
 
         // Imploding multiple parts into a single value, and splitting the
         // values with ;.
         if (\count($val) > 1) {
             foreach ($val as $k => $v) {
                 $val[$k] = \str_replace(';', '\;', $v);
             }
             $val = \implode(';', $val);
         } else {
             $val = $val[0];
         }
 
         $str = $this->name;
         if ($this->group) $str = $this->group . '.' . $this->name;
         foreach ($this->parameters as $param) {
 
             if ($param->getValue() === 'QUOTED-PRINTABLE') {
                 continue;
             }
             $str .= ';' . $param->serialize();
 
         }
 
 
 
         // If the resulting value contains a \n, we must encode it as
         // quoted-printable.
         if (\strpos($val, "\n") !== false) {
 
             $str .= ';ENCODING=QUOTED-PRINTABLE:';
             $lastLine = $str;
             $out = null;
 
             // The PHP built-in quoted-printable-encode does not correctly
             // encode newlines for us. Specifically, the \r\n sequence must in
             // vcards be encoded as =0D=OA and we must insert soft-newlines
             // every 75 bytes.
             for ($ii = 0;$ii < \strlen($val);$ii++) {
                 $ord = \ord($val[$ii]);
                 // These characters are encoded as themselves.
                 if ($ord >= 32 && $ord <= 126) {
                     $lastLine .= $val[$ii];
                 } else {
                     $lastLine .= '=' . \strtoupper(\bin2hex($val[$ii]));
                 }
                 if (\strlen($lastLine) >= 75) {
                     // Soft line break
                     $out .= $lastLine . "=\r\n ";
                     $lastLine = null;
                 }
 
             }
             if (!\is_null($lastLine)) $out .= $lastLine . "\r\n";
             return $out;
 
         } else {
             $str .= ':' . $val;
 
             $str = \preg_replace(
                 '/(
                     (?:^.)?         # 1 additional byte in first line because of missing single space (see next line)
                     .{1,74}         # max 75 bytes per line (1 byte is used for a single space added after every CRLF)
                     (?![\x80-\xbf]) # prevent splitting multibyte characters
                 )/x',
                 "$1\r\n ",
                 $str
             );
 
             // remove single space after last CRLF
             return \substr($str, 0, -1);
 
         }
 
     }

Here is the call graph for this function:

◆ setQuotedPrintableValue()

Sabre\VObject\Property\Text::setQuotedPrintableValue ( $val )

Sets the value as a quoted-printable encoded string.

Parameters

string $val

Returns: void

Definition at line 113 of file Text.php.

References Sabre\VObject\Property\setValue().

                                            {
 
         $val = quoted_printable_decode($val);
 
         // Quoted printable only appears in vCard 2.1, and the only character
         // that may be escaped there is ;. So we are simply splitting on just
         // that.
         //
         // We also don't have to unescape \\, so all we need to look for is a ;
         // that's not preceeded with a \.
         $regex = '# (?<!\\\\) ; #x';
         $matches = preg_split($regex, $val);
         $this->setValue($matches);
 
     }

Here is the call graph for this function:

◆ setRawMimeDirValue()

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

References Sabre\VObject\Property\setValue(), and Sabre\VObject\Parser\MimeDir\unescapeValue().

                                       {
 
         $this->setValue(MimeDir::unescapeValue($val, $this->delimiter));
 
     }

Here is the call graph for this function:

◆ validate()

Sabre\VObject\Property\Text::validate ( $options = 0 )

Validates the node for correctness.

The following options are supported:

Node::REPAIR - If something is broken, and automatic repair may be attempted.

An array is returned with warnings.

Every item in the array has the following properties:

level - (number between 1 and 3 with severity information)
message - (human readable message)
node - (reference to the offending node)

Parameters

int $options

Returns: array

Definition at line 389 of file Text.php.

References Sabre\VObject\Property\$name, PHPMailer\PHPMailer\$options, $warnings, Sabre\VObject\Node\count(), Sabre\VObject\Property\getParts(), and Sabre\VObject\Property\setParts().

                                     {
 
         $warnings = parent::validate($options);
 
         if (isset($this->minimumPropertyValues[$this->name])) {
 
             $minimum = $this->minimumPropertyValues[$this->name];
             $parts = $this->getParts();
             if (count($parts) < $minimum) {
                 $warnings[] = [
                     'level'   => $options & self::REPAIR ? 1 : 3,
                     'message' => 'The ' . $this->name . ' property must have at least ' . $minimum . ' values. It only has ' . count($parts),
                     'node'    => $this,
                 ];
                 if ($options & self::REPAIR) {
                     $parts = array_pad($parts, $minimum, '');
                     $this->setParts($parts);
                 }
             }
 
         }
         return $warnings;
 
     }

Here is the call graph for this function:

◆ xmlSerializeValue()

Sabre\VObject\Property\Text::xmlSerializeValue ( Xml\Writer $writer )

protected

This method serializes only the value of a property.

This is used to create xCard or xCal documents.

Parameters

Xml\Writer $writer XML writer.

Returns: void

Definition at line 301 of file Text.php.

References $i, $map, $values, and Sabre\VObject\Property\getParts().

                                                              {
 
         $values = $this->getParts();
 
         $map = function($items) use ($values, $writer) {
             foreach ($items as $i => $item) {
                 $writer->writeElement(
                     $item,
                     !empty($values[$i]) ? $values[$i] : null
                 );
             }
         };
 
         switch ($this->name) {
 
             // Special-casing the REQUEST-STATUS property.
             //
             // See:
             // http://tools.ietf.org/html/rfc6321#section-3.4.1.3
             case 'REQUEST-STATUS':
                 $writer->writeElement('code', $values[0]);
                 $writer->writeElement('description', $values[1]);
 
                 if (isset($values[2])) {
                     $writer->writeElement('data', $values[2]);
                 }
                 break;
 
             case 'N':
                 $map([
                     'surname',
                     'given',
                     'additional',
                     'prefix',
                     'suffix'
                 ]);
                 break;
 
             case 'GENDER':
                 $map([
                     'sex',
                     'text'
                 ]);
                 break;
 
             case 'ADR':
                 $map([
                     'pobox',
                     'ext',
                     'street',
                     'locality',
                     'region',
                     'code',
                     'country'
                 ]);
                 break;
 
             case 'CLIENTPIDMAP':
                 $map([
                     'sourceid',
                     'uri'
                 ]);
                 break;
 
             default:
                 parent::xmlSerializeValue($writer);
         }
 
     }

Here is the call graph for this function:

Field Documentation

◆ $delimiter

Sabre\VObject\Property\Text::$delimiter = ','

Definition at line 28 of file Text.php.

◆ $minimumPropertyValues

Sabre\VObject\Property\Text::$minimumPropertyValues

protected

Initial value:

= [

'N' => 5

Definition at line 55 of file Text.php.

◆ $structuredValues

Sabre\VObject\Property\Text::$structuredValues

protected

Initial value:

= [
        
        'N',
        'ADR',
        'ORG',
        'GENDER',
        'CLIENTPIDMAP',
        
        'REQUEST-STATUS',
    ]

Definition at line 35 of file Text.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getJsonValue()

◆ getRawMimeDirValue()

◆ getValueType()

◆ serialize()

◆ setQuotedPrintableValue()

◆ setRawMimeDirValue()

◆ validate()

◆ xmlSerializeValue()

Field Documentation

◆ $delimiter

◆ $minimumPropertyValues

◆ $structuredValues