Inheritance diagram for Sabre\VObject\Component\VCard:

Collaboration diagram for Sabre\VObject\Component\VCard:

Public Member Functions
	getDocumentType ()
	Returns the current document type. More...

	convert ($target)
	Converts the document to a different vcard version. More...

	validate ($options=0)
	Validates the node for correctness. More...

	getValidationRules ()

	preferred ($propertyName)
	Returns a preferred field. More...

	getByType ($propertyName, $type)
	Returns a property with a specific TYPE value (ADR, TEL, or EMAIL). 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...

	getClassNameForPropertyName ($propertyName)
	Returns the default class for a property name. More...

Public Member Functions inherited from Sabre\VObject\Document
	__construct ()
	Creates a new document. More...

	getDocumentType ()
	Returns the current document type. More...

	create ($name)
	Creates a new component or property. More...

	createComponent ($name, array $children=null, $defaults=true)
	Creates a new component. More...

	createProperty ($name, $value=null, array $parameters=null, $valueType=null)
	Factory method for creating new properties. More...

	getClassNameForPropertyValue ($valueParam)
	This method returns a full class-name for a value parameter. More...

	getClassNameForPropertyName ($propertyName)
	Returns the default class for a property name. More...

Public Member Functions inherited from Sabre\VObject\Component
	__construct (Document $root, $name, array $children=[], $defaults=true)
	Creates a new component. More...

	add ()
	Adds a new property or component, and returns the new item. More...

	remove ($item)
	This method removes a component or property from this component. More...

	children ()
	Returns a flat list of all the properties and components in this component. More...

	getComponents ()
	This method only returns a list of sub-components. More...

	select ($name)
	Returns an array with elements that match the specified name. 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...

	__isset ($name)
	This method checks if a sub-element with the specified name exists. More...

	__set ($name, $value)
	Using the setter method you can add properties or subcomponents. More...

	__unset ($name)
	Removes all properties and components within this component with the specified name. More...

	__clone ()
	This method is automatically called when the object is cloned. More...

	getValidationRules ()

	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
const	DEFAULT_VERSION = self::VCARD21
	VCards with version 2.1, 3.0 and 4.0 are found. More...

Data Fields inherited from Sabre\VObject\Document
const	UNKNOWN = 1
	Unknown document type. More...

const	VCALENDAR10 = 2
	vCalendar 1.0. More...

const	ICALENDAR20 = 3
	iCalendar 2.0. More...

const	VCARD21 = 4
	vCard 2.1. More...

const	VCARD30 = 5
	vCard 3.0. More...

const	VCARD40 = 6
	vCard 4.0. More...

Data Fields inherited from Sabre\VObject\Component
	$name

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

Static Public Attributes
static	$defaultName = 'VCARD'

static	$componentMap

static	$valueMap

static	$propertyMap

Static Public Attributes inherited from Sabre\VObject\Document
static	$defaultName

static	$propertyMap = []

static	$componentMap = []

static	$valueMap = []

Protected Member Functions
	getDefaults ()
	This method should return a list of default property values. More...

	getDefaults ()
	This method should return a list of default property values. More...

Private Attributes
	$version = null

Additional Inherited Members
Protected Attributes inherited from Sabre\VObject\Component
	$children = []

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

	$root

Detailed Description

The VCard component.

This component represents the BEGIN:VCARD and END:VCARD found in every vcard.

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 18 of file VCard.php.

Member Function Documentation

◆ convert()

Sabre\VObject\Component\VCard::convert ( $target )

Converts the document to a different vcard version.

Use one of the VCARD constants for the target. This method will return a copy of the vcard in the new version.

At the moment the only supported conversion is from 3.0 to 4.0.

If input and output version are identical, a clone is returned.

Parameters

int $target

Returns: VCard

Definition at line 188 of file VCard.php.

                              {
 
        $converter = new VObject\VCardConverter();
        return $converter->convert($this, $target);
 
    }

References $target.

◆ getByType()

Sabre\VObject\Component\VCard::getByType	(	$propertyName,
		$type
	)

Returns a property with a specific TYPE value (ADR, TEL, or EMAIL).

This function will return null if the property does not exist. If there are multiple properties with the same TYPE value, only one will be returned.

Parameters

string	$propertyName
string	$type

Returns: VObject\Property|null

Definition at line 429 of file VCard.php.

                                             {
        foreach ($this->select($propertyName) as $field) {
            if (isset($field['TYPE']) && $field['TYPE']->has($type)) {
                return $field;
            }
        }
    }

References $type, and Sabre\VObject\Component\select().

Here is the call graph for this function:

◆ getClassNameForPropertyName()

Sabre\VObject\Component\VCard::getClassNameForPropertyName ( $propertyName )

Returns the default class for a property name.

Parameters

string $propertyName

Returns: string

Reimplemented from Sabre\VObject\Document.

Definition at line 546 of file VCard.php.

                                                        {
 
        $className = parent::getClassNameForPropertyName($propertyName);
 
        // In vCard 4, BINARY no longer exists, and we need URI instead.
        if ($className == 'Sabre\\VObject\\Property\\Binary' && $this->getDocumentType() === self::VCARD40) {
            return 'Sabre\\VObject\\Property\\Uri';
        }
        return $className;
 
    }

References Sabre\VObject\Component\VCard\getDocumentType().

Here is the call graph for this function:

◆ getDefaults()

Sabre\VObject\Component\VCard::getDefaults ( )

protected

This method should return a list of default property values.

Returns: array

Reimplemented from Sabre\VObject\Component.

Definition at line 442 of file VCard.php.

                                     {
 
        return [
            'VERSION' => '4.0',
            'PRODID'  => '-//Sabre//Sabre VObject ' . VObject\Version::VERSION . '//EN',
            'UID'     => 'sabre-vobject-' . VObject\UUIDUtil::getUUID(),
        ];
 
    }

References Sabre\VObject\UUIDUtil\getUUID(), and Sabre\VObject\Version\VERSION.

Here is the call graph for this function:

◆ getDocumentType()

Sabre\VObject\Component\VCard::getDocumentType ( )

Returns the current document type.

Returns: int

Reimplemented from Sabre\VObject\Document.

Definition at line 147 of file VCard.php.

                               {
 
        if (!$this->version) {
 
            $version = (string)$this->VERSION;
 
            switch ($version) {
                case '2.1' :
                    $this->version = self::VCARD21;
                    break;
                case '3.0' :
                    $this->version = self::VCARD30;
                    break;
                case '4.0' :
                    $this->version = self::VCARD40;
                    break;
                default :
                    // We don't want to cache the version if it's unknown,
                    // because we might get a version property in a bit.
                    return self::UNKNOWN;
            }
        }
 
        return $this->version;
 
    }

References Sabre\VObject\Component\VCard\$version, Sabre\VObject\Document\UNKNOWN, Sabre\VObject\Document\VCARD21, Sabre\VObject\Document\VCARD30, and Sabre\VObject\Document\VCARD40.

Referenced by Sabre\VObject\Component\VCard\getClassNameForPropertyName().

Here is the caller graph for this function:

◆ getValidationRules()

Sabre\VObject\Component\VCard::getValidationRules ( )

Reimplemented from Sabre\VObject\Component.

Definition at line 335 of file VCard.php.

                                  {
 
        return [
            'ADR'          => '*',
            'ANNIVERSARY'  => '?',
            'BDAY'         => '?',
            'CALADRURI'    => '*',
            'CALURI'       => '*',
            'CATEGORIES'   => '*',
            'CLIENTPIDMAP' => '*',
            'EMAIL'        => '*',
            'FBURL'        => '*',
            'IMPP'         => '*',
            'GENDER'       => '?',
            'GEO'          => '*',
            'KEY'          => '*',
            'KIND'         => '?',
            'LANG'         => '*',
            'LOGO'         => '*',
            'MEMBER'       => '*',
            'N'            => '?',
            'NICKNAME'     => '*',
            'NOTE'         => '*',
            'ORG'          => '*',
            'PHOTO'        => '*',
            'PRODID'       => '?',
            'RELATED'      => '*',
            'REV'          => '?',
            'ROLE'         => '*',
            'SOUND'        => '*',
            'SOURCE'       => '*',
            'TEL'          => '*',
            'TITLE'        => '*',
            'TZ'           => '*',
            'URL'          => '*',
            'VERSION'      => '1',
            'XML'          => '*',
 
            // FN is commented out, because it's already handled by the
            // validate function, which may also try to repair it.
            // 'FN'           => '+',
            'UID' => '?',
        ];
 
    }

◆ jsonSerialize()

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

Definition at line 458 of file VCard.php.

                             {
 
        // A vcard does not have sub-components, so we're overriding this
        // method to remove that array element.
        $properties = [];
 
        foreach ($this->children() as $child) {
            $properties[] = $child->jsonSerialize();
        }
 
        return [
            strtolower($this->name),
            $properties,
        ];
 
    }

References Sabre\VObject\Component\children().

Here is the call graph for this function:

◆ preferred()

Sabre\VObject\Component\VCard::preferred ( $propertyName )

Returns a preferred field.

VCards can indicate wether a field such as ADR, TEL or EMAIL is preferred by specifying TYPE=PREF (vcard 2.1, 3) or PREF=x (vcard 4, x being a number between 1 and 100).

If neither of those parameters are specified, the first is returned, if a field with that name does not exist, null is returned.

Parameters

string $fieldName

Returns: VObject\Property|null

Definition at line 395 of file VCard.php.

                                      {
 
        $preferred = null;
        $lastPref = 101;
        foreach ($this->select($propertyName) as $field) {
 
            $pref = 101;
            if (isset($field['TYPE']) && $field['TYPE']->has('PREF')) {
                $pref = 1;
            } elseif (isset($field['PREF'])) {
                $pref = $field['PREF']->getValue();
            }
 
            if ($pref < $lastPref || is_null($preferred)) {
                $preferred = $field;
                $lastPref = $pref;
            }
 
        }
        return $preferred;
 
    }

References Sabre\VObject\Component\select().

Here is the call graph for this function:

◆ validate()

Sabre\VObject\Component\VCard::validate ( $options = 0 )

Validates the node for correctness.

The following options are supported: Node::REPAIR - May attempt to automatically repair the problem.

This method returns an array with detected problems. Every element has the following properties:

level - problem level.
message - A human-readable string describing the issue.
node - A reference to the problematic node.

The level means: 1 - The issue was repaired (only happens if REPAIR was turned on) 2 - An inconsequential issue 3 - A severe issue.

Parameters

int $options

Returns: array

Reimplemented from Sabre\VObject\Component.

Definition at line 224 of file VCard.php.

                                    {
 
        $warnings = [];
 
        $versionMap = [
            self::VCARD21 => '2.1',
            self::VCARD30 => '3.0',
            self::VCARD40 => '4.0',
        ];
 
        $version = $this->select('VERSION');
        if (count($version) === 1) {
            $version = (string)$this->VERSION;
            if ($version !== '2.1' && $version !== '3.0' && $version !== '4.0') {
                $warnings[] = [
                    'level'   => 3,
                    'message' => 'Only vcard version 4.0 (RFC6350), version 3.0 (RFC2426) or version 2.1 (icm-vcard-2.1) are supported.',
                    'node'    => $this,
                ];
                if ($options & self::REPAIR) {
                    $this->VERSION = $versionMap[self::DEFAULT_VERSION];
                }
            }
            if ($version === '2.1' && ($options & self::PROFILE_CARDDAV)) {
                $warnings[] = [
                    'level'   => 3,
                    'message' => 'CardDAV servers are not allowed to accept vCard 2.1.',
                    'node'    => $this,
                ];
            }
 
        }
        $uid = $this->select('UID');
        if (count($uid) === 0) {
            if ($options & self::PROFILE_CARDDAV) {
                // Required for CardDAV
                $warningLevel = 3;
                $message = 'vCards on CardDAV servers MUST have a UID property.';
            } else {
                // Not required for regular vcards
                $warningLevel = 2;
                $message = 'Adding a UID to a vCard property is recommended.';
            }
            if ($options & self::REPAIR) {
                $this->UID = VObject\UUIDUtil::getUUID();
                $warningLevel = 1;
            }
            $warnings[] = [
                'level'   => $warningLevel,
                'message' => $message,
                'node'    => $this,
            ];
        }
 
        $fn = $this->select('FN');
        if (count($fn) !== 1) {
 
            $repaired = false;
            if (($options & self::REPAIR) && count($fn) === 0) {
                // We're going to try to see if we can use the contents of the
                // N property.
                if (isset($this->N)) {
                    $value = explode(';', (string)$this->N);
                    if (isset($value[1]) && $value[1]) {
                        $this->FN = $value[1] . ' ' . $value[0];
                    } else {
                        $this->FN = $value[0];
                    }
                    $repaired = true;
 
                // Otherwise, the ORG property may work
                } elseif (isset($this->ORG)) {
                    $this->FN = (string)$this->ORG;
                    $repaired = true;
 
                // Otherwise, the EMAIL property may work
                } elseif (isset($this->EMAIL)) {
                    $this->FN = (string)$this->EMAIL;
                    $repaired = true;
                }
 
            }
            $warnings[] = [
                'level'   => $repaired ? 1 : 3,
                'message' => 'The FN property must appear in the VCARD component exactly 1 time',
                'node'    => $this,
            ];
        }
 
        return array_merge(
            parent::validate($options),
            $warnings
        );
 
    }

References $message, PHPMailer\PHPMailer\$options, Sabre\VObject\Component\VCard\$version, $warnings, Sabre\VObject\Node\count(), Sabre\VObject\Component\VCard\DEFAULT_VERSION, Sabre\VObject\UUIDUtil\getUUID(), and Sabre\VObject\Component\select().

Here is the call graph for this function:

◆ xmlSerialize()

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

Definition at line 483 of file VCard.php.

                                              {
 
        $propertiesByGroup = [];
 
        foreach ($this->children() as $property) {
 
            $group = $property->group;
 
            if (!isset($propertiesByGroup[$group])) {
                $propertiesByGroup[$group] = [];
            }
 
            $propertiesByGroup[$group][] = $property;
 
        }
 
        $writer->startElement(strtolower($this->name));
 
        foreach ($propertiesByGroup as $group => $properties) {
 
            if (!empty($group)) {
 
                $writer->startElement('group');
                $writer->writeAttribute('name', strtolower($group));
 
            }
 
            foreach ($properties as $property) {
                switch ($property->name) {
 
                    case 'VERSION':
                        continue;
 
                    case 'XML':
                        $value = $property->getParts();
                        $fragment = new Xml\Element\XmlFragment($value[0]);
                        $writer->write($fragment);
                        break;
 
                    default:
                        $property->xmlSerialize($writer);
                        break;
 
                }
            }
 
            if (!empty($group)) {
                $writer->endElement();
            }
 
        }
 
        $writer->endElement();
 
    }

References Sabre\VObject\Component\children().

Here is the call graph for this function:

Field Documentation

◆ $componentMap

Sabre\VObject\Component\VCard::$componentMap

static

Initial value:

= [
        'VCARD' => 'Sabre\\VObject\\Component\\VCard',
    ]

Definition at line 41 of file VCard.php.

Referenced by Sabre\VObject\Parser\MimeDir\parseDocument().

◆ $defaultName

Sabre\VObject\Component\VCard::$defaultName = 'VCARD'

static

Definition at line 27 of file VCard.php.

◆ $propertyMap

Sabre\VObject\Component\VCard::$propertyMap

static

Definition at line 74 of file VCard.php.

◆ $valueMap

Sabre\VObject\Component\VCard::$valueMap

static

Initial value:

= [
        'BINARY'           => 'Sabre\\VObject\\Property\\Binary',
        'BOOLEAN'          => 'Sabre\\VObject\\Property\\Boolean',
        'CONTENT-ID'       => 'Sabre\\VObject\\Property\\FlatText',   
        'DATE'             => 'Sabre\\VObject\\Property\\VCard\\Date',
        'DATE-TIME'        => 'Sabre\\VObject\\Property\\VCard\\DateTime',
        'DATE-AND-OR-TIME' => 'Sabre\\VObject\\Property\\VCard\\DateAndOrTime', 
        'FLOAT'            => 'Sabre\\VObject\\Property\\FloatValue',
        'INTEGER'          => 'Sabre\\VObject\\Property\\IntegerValue',
        'LANGUAGE-TAG'     => 'Sabre\\VObject\\Property\\VCard\\LanguageTag',
        'TIMESTAMP'        => 'Sabre\\VObject\\Property\\VCard\\TimeStamp',
        'TEXT'             => 'Sabre\\VObject\\Property\\Text',
        'TIME'             => 'Sabre\\VObject\\Property\\Time',
        'UNKNOWN'          => 'Sabre\\VObject\\Property\\Unknown', 
        'URI'              => 'Sabre\\VObject\\Property\\Uri',
        'URL'              => 'Sabre\\VObject\\Property\\Uri', 
        'UTC-OFFSET'       => 'Sabre\\VObject\\Property\\UtcOffset',
    ]

Definition at line 50 of file VCard.php.

◆ $version

Sabre\VObject\Component\VCard::$version = null

private

Definition at line 34 of file VCard.php.

Referenced by Sabre\VObject\Component\VCard\getDocumentType(), and Sabre\VObject\Component\VCard\validate().

◆ DEFAULT_VERSION

const Sabre\VObject\Component\VCard::DEFAULT_VERSION = self::VCARD21

VCards with version 2.1, 3.0 and 4.0 are found.

If the VCARD doesn't know its version, 2.1 is assumed.

Definition at line 200 of file VCard.php.

Referenced by Sabre\VObject\Component\VCard\validate().

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

libs/composer/vendor/sabre/vobject/lib/Component/VCard.php

Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ convert()

◆ getByType()

◆ getClassNameForPropertyName()

◆ getDefaults()

◆ getDocumentType()

◆ getValidationRules()

◆ jsonSerialize()

◆ preferred()

◆ validate()

◆ xmlSerialize()

Field Documentation

◆ $componentMap

◆ $defaultName

◆ $propertyMap

◆ $valueMap

◆ $version

◆ DEFAULT_VERSION