Inheritance diagram for Sabre\VObject\Parameter:

Collaboration diagram for Sabre\VObject\Parameter:

Public Member Functions
	__construct (Document $root, $name, $value=null)
	Sets up the object. More...

	setValue ($value)
	Updates the current value. More...

	getValue ()
	Returns the current value. More...

	setParts (array $value)
	Sets multiple values for this parameter. More...

	getParts ()
	Returns all values for this parameter. More...

	addValue ($part)
	Adds a value to this parameter. More...

	has ($value)
	Checks if this parameter contains the specified value. 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...

	__toString ()
	Called when this object is being cast to a string. More...

	getIterator ()
	Returns the iterator for this object. 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...

Static Public Member Functions
static	guessParameterNameByValue ($value)
	Try to guess property name by value, can be used for vCard 2.1 nameless parameters. More...

Data Fields
	$name

	$noName = false

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 Attributes
	$value

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

	$root

Detailed Description

VObject Parameter.

This class represents a parameter. A parameter is always tied to a property. In the case of: DTSTART;VALUE=DATE:20101108 VALUE=DATE would be the parameter name and value.

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

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

Definition at line 20 of file Parameter.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\VObject\Parameter::__construct	(	Document	$root,
			$name,
			$value = `null`
	)

Sets up the object.

It's recommended to use the create:: factory method instead.

Parameters

string	$name
string	$value

Definition at line 53 of file Parameter.php.

                                                               {
 
        $this->name = strtoupper($name);
        $this->root = $root;
        if (is_null($name)) {
            $this->noName = true;
            $this->name = static::guessParameterNameByValue($value);
        }
 
        // If guessParameterNameByValue() returns an empty string
        // above, we're actually dealing with a parameter that has no value.
        // In that case we have to move the value to the name.
        if ($this->name === '') {
            $this->noName = false;
            $this->name = strtoupper($value);
        } else {
            $this->setValue($value);
        }
 
    }

References Sabre\VObject\Parameter\$name, Sabre\VObject\Node\$root, Sabre\VObject\Parameter\$value, and Sabre\VObject\Parameter\setValue().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

Sabre\VObject\Parameter::__toString ( )

Called when this object is being cast to a string.

Returns: string

Definition at line 374 of file Parameter.php.

                          {
 
        return (string)$this->getValue();
 
    }

References Sabre\VObject\Parameter\getValue().

Here is the call graph for this function:

◆ addValue()

Sabre\VObject\Parameter::addValue ( $part )

Adds a value to this parameter.

If the argument is specified as an array, all items will be added to the parameter value list.

Parameters

string | array $part

Returns: void

Definition at line 249 of file Parameter.php.

                             {
 
        if (is_null($this->value)) {
            $this->value = $part;
        } else {
            $this->value = array_merge((array)$this->value, (array)$part);
        }
 
    }

◆ getIterator()

Sabre\VObject\Parameter::getIterator ( )

Returns the iterator for this object.

Returns: ElementList

Reimplemented from Sabre\VObject\Node.

Definition at line 385 of file Parameter.php.

                           {
 
        if (!is_null($this->iterator))
            return $this->iterator;
 
        return $this->iterator = new ArrayIterator((array)$this->value);
 
    }

References Sabre\VObject\Node\$iterator.

◆ getParts()

Sabre\VObject\Parameter::getParts ( )

Returns all values for this parameter.

If there were no values, an empty array will be returned.

Returns: array

Definition at line 227 of file Parameter.php.

                        {
 
        if (is_array($this->value)) {
            return $this->value;
        } elseif (is_null($this->value)) {
            return [];
        } else {
            return [$this->value];
        }
 
    }

References Sabre\VObject\Parameter\$value.

Referenced by Sabre\VObject\Parameter\serialize().

Here is the caller graph for this function:

◆ getValue()

Sabre\VObject\Parameter::getValue ( )

Returns the current value.

This method will always return a string, or null. If there were multiple values, it will automatically concatenate them (separated by comma).

Returns: string|null

Definition at line 197 of file Parameter.php.

                        {
 
        if (is_array($this->value)) {
            return implode(',', $this->value);
        } else {
            return $this->value;
        }
 
    }

References Sabre\VObject\Parameter\$value.

Referenced by Sabre\VObject\Parameter\__toString().

Here is the caller graph for this function:

◆ guessParameterNameByValue()

static Sabre\VObject\Parameter::guessParameterNameByValue ( $value )

static

Try to guess property name by value, can be used for vCard 2.1 nameless parameters.

Figuring out what the name should have been. Note that a ton of these are rather silly in 2014 and would probably rarely be used, but we like to be complete.

Parameters

string $value

Returns: string

Definition at line 85 of file Parameter.php.

                                                      {
        switch (strtoupper($value)) {
 
            // Encodings
            case '7-BIT' :
            case 'QUOTED-PRINTABLE' :
            case 'BASE64' :
                $name = 'ENCODING';
                break;
 
            // Common types
            case 'WORK' :
            case 'HOME' :
            case 'PREF' :
 
            // Delivery Label Type
            case 'DOM' :
            case 'INTL' :
            case 'POSTAL' :
            case 'PARCEL' :
 
            // Telephone types
            case 'VOICE' :
            case 'FAX' :
            case 'MSG' :
            case 'CELL' :
            case 'PAGER' :
            case 'BBS' :
            case 'MODEM' :
            case 'CAR' :
            case 'ISDN' :
            case 'VIDEO' :
 
            // EMAIL types (lol)
            case 'AOL' :
            case 'APPLELINK' :
            case 'ATTMAIL' :
            case 'CIS' :
            case 'EWORLD' :
            case 'INTERNET' :
            case 'IBMMAIL' :
            case 'MCIMAIL' :
            case 'POWERSHARE' :
            case 'PRODIGY' :
            case 'TLX' :
            case 'X400' :
 
            // Photo / Logo format types
            case 'GIF' :
            case 'CGM' :
            case 'WMF' :
            case 'BMP' :
            case 'DIB' :
            case 'PICT' :
            case 'TIFF' :
            case 'PDF' :
            case 'PS' :
            case 'JPEG' :
            case 'MPEG' :
            case 'MPEG2' :
            case 'AVI' :
            case 'QTIME' :
 
            // Sound Digital Audio Type
            case 'WAVE' :
            case 'PCM' :
            case 'AIFF' :
 
            // Key types
            case 'X509' :
            case 'PGP' :
                $name = 'TYPE';
                break;
 
            // Value types
            case 'INLINE' :
            case 'URL' :
            case 'CONTENT-ID' :
            case 'CID' :
                $name = 'VALUE';
                break;
 
            default:
                $name = '';
        }
 
        return $name;
    }

References Sabre\VObject\Parameter\$name, and Sabre\VObject\Parameter\$value.

Referenced by Sabre\VObject\Property\add().

Here is the caller graph for this function:

◆ has()

Sabre\VObject\Parameter::has ( $value )

Checks if this parameter contains the specified value.

This is a case-insensitive match. It makes sense to call this for for instance the TYPE parameter, to see if it contains a keyword such as 'WORK' or 'FAX'.

Parameters

string $value

Returns: bool

Definition at line 270 of file Parameter.php.

                         {
 
        return in_array(
            strtolower($value),
            array_map('strtolower', (array)$this->value)
        );
 
    }

References Sabre\VObject\Parameter\$value.

◆ jsonSerialize()

Sabre\VObject\Parameter::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.

Returns: array

Reimplemented from Sabre\VObject\Node.

Definition at line 347 of file Parameter.php.

                             {
 
        return $this->value;
 
    }

References Sabre\VObject\Parameter\$value.

◆ serialize()

Sabre\VObject\Parameter::serialize ( )

Turns the object back into a serialized blob.

Returns: string

Reimplemented from Sabre\VObject\Node.

Definition at line 284 of file Parameter.php.

                         {
 
        $value = $this->getParts();
 
        if (count($value) === 0) {
            return $this->name . '=';
        }
 
        if ($this->root->getDocumentType() === Document::VCARD21 && $this->noName) {
 
            return implode(';', $value);
 
        }
 
        return $this->name . '=' . array_reduce(
            $value,
            function($out, $item) {
 
                if (!is_null($out)) $out .= ',';
 
                // If there's no special characters in the string, we'll use the simple
                // format.
                //
                // The list of special characters is defined as:
                //
                // Any character except CONTROL, DQUOTE, ";", ":", ","
                //
                // by the iCalendar spec:
                // https://tools.ietf.org/html/rfc5545#section-3.1
                //
                // And we add ^ to that because of:
                // https://tools.ietf.org/html/rfc6868
                //
                // But we've found that iCal (7.0, shipped with OSX 10.9)
                // severaly trips on + characters not being quoted, so we
                // added + as well.
                if (!preg_match('#(?: [\n":;\^,\+] )#x', $item)) {
                    return $out . $item;
                } else {
                    // Enclosing in double-quotes, and using RFC6868 for encoding any
                    // special characters
                    $out .= '"' . strtr(
                        $item,
                        [
                            '^'  => '^^',
                            "\n" => '^n',
                            '"'  => '^\'',
                        ]
                    ) . '"';
                    return $out;
                }
 
            }
        );
 
    }

References $out, Sabre\VObject\Parameter\$value, Sabre\VObject\Node\count(), Sabre\VObject\Parameter\getParts(), and Sabre\VObject\Document\VCARD21.

Here is the call graph for this function:

◆ setParts()

Sabre\VObject\Parameter::setParts ( array $value )

Sets multiple values for this parameter.

Parameters

array $value

Returns: void

Definition at line 214 of file Parameter.php.

                                    {
 
        $this->value = $value;
 
    }

References Sabre\VObject\Parameter\$value.

◆ setValue()

Sabre\VObject\Parameter::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 183 of file Parameter.php.

                              {
 
        $this->value = $value;
 
    }

References Sabre\VObject\Parameter\$value.

Referenced by Sabre\VObject\Parameter\__construct().

Here is the caller graph for this function:

◆ xmlSerialize()

Sabre\VObject\Parameter::xmlSerialize ( Xml\Writer $writer )

This method serializes the data into XML.

This is used to create xCard or xCal documents.

Parameters

Xml\Writer $writer XML writer.

Returns: void

Reimplemented from Sabre\VObject\Node.

Definition at line 361 of file Parameter.php.

                                              {
 
        foreach (explode(',', $this->value) as $value) {
            $writer->writeElement('text', $value);
        }
 
    }

References Sabre\VObject\Parameter\$value.

Field Documentation

◆ $name

Sabre\VObject\Parameter::$name

Definition at line 27 of file Parameter.php.

Referenced by Sabre\VObject\Parameter\__construct(), and Sabre\VObject\Parameter\guessParameterNameByValue().

◆ $noName

Sabre\VObject\Parameter::$noName = false

Definition at line 36 of file Parameter.php.

◆ $value

Sabre\VObject\Parameter::$value

protected

Definition at line 43 of file Parameter.php.

Referenced by Sabre\VObject\Parameter\__construct(), Sabre\VObject\Parameter\getParts(), Sabre\VObject\Parameter\getValue(), Sabre\VObject\Parameter\guessParameterNameByValue(), Sabre\VObject\Parameter\has(), Sabre\VObject\Parameter\jsonSerialize(), Sabre\VObject\Parameter\serialize(), Sabre\VObject\Parameter\setParts(), Sabre\VObject\Parameter\setValue(), and Sabre\VObject\Parameter\xmlSerialize().

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

libs/composer/vendor/sabre/vobject/lib/Parameter.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ addValue()

◆ getIterator()

◆ getParts()

◆ getValue()

◆ guessParameterNameByValue()

◆ has()

◆ jsonSerialize()

◆ serialize()

◆ setParts()

◆ setValue()

◆ xmlSerialize()

Field Documentation

◆ $name

◆ $noName

◆ $value