VCard.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\User\Profile;

class VCard
{
    // Address values for the ADR type
    public const ADR_TYPE_NONE = 0;
    public const ADR_TYPE_DOM = 1;
    public const ADR_TYPE_INTL = 2;
    public const ADR_TYPE_POSTAL = 4;
    public const ADR_TYPE_PARCEL = 8;
    public const ADR_TYPE_HOME = 16;
    public const ADR_TYPE_WORK = 32;
    public const ADR_TYPE_PREF = 64;

    // Communication values for the TEL type
    public const TEL_TYPE_NONE = 0;
    public const TEL_TYPE_HOME = 1;
    public const TEL_TYPE_MSG = 2;
    public const TEL_TYPE_WORK = 4;
    public const TEL_TYPE_PREF = 8;
    public const TEL_TYPE_VOICE = 16;
    public const TEL_TYPE_FAX = 32;
    public const TEL_TYPE_CELL = 64;
    public const TEL_TYPE_VIDEO = 128;
    public const TEL_TYPE_PAGER = 256;
    public const TEL_TYPE_BBS = 512;
    public const TEL_TYPE_MODEM = 1024;
    public const TEL_TYPE_CAR = 2048;
    public const TEL_TYPE_ISDN = 4096;
    public const TEL_TYPE_PCS = 8192;

    // Communication values for the EMAIL type
    public const EMAIL_TYPE_NONE = 0;
    public const EMAIL_TYPE_INTERNET = 1;
    public const EMAIL_TYPE_x400 = 2;
    public const EMAIL_TYPE_PREF = 4;

    public array $types;

    // The filename of the vCard used when saving the vCard
    public string $filename;

    public function __construct(string $version = '3.0')
    {
        $this->types = [
            'FN' => '',
            'N' => '',
            'NICKNAME' => '',
            'PHOTO' => [],
            'BDAY' => '',
            'ADR' => [],
            'LABEL' => [],
            'TEL' => [],
            'EMAIL' => [],
            'MAILER' => '',
            'TZ' => '',
            'GEO' => '',
            'TITLE' => '',
            'ROLE' => '',
            'LOGO' => [],
            'AGENT' => '',
            'ORG' => '',
            'CATEGORIES' => '',
            'NOTE' => '',
            'PRODID' => '',
            'REV' => '',
            'SORT-STRING' => '',
            'SOUND' => [],
            'UID' => '',
            'URL' => '',
            'CLASS' => '',
            'KEY' => []
        ];
        $this->types['VERSION'] = $version;
    }

    public function encode(string $string): string
    {
        return $this->escape(quoted_printable_encode($string));
    }

    public function fold(string $string = ''): string
    {
        $folded_string = '';
        preg_match_all('/(.{1,74})/', $string, $matches);
        for ($i = 0, $iMax = count($matches[1]); $i < $iMax; $i++) {
            if ($i < (count($matches[1]) - 1)) {
                $matches[1][$i] .= "\n";
            }
            if ($i > 0) {
                $matches[1][$i] = ' ' . $matches[1][$i];
            }
            $folded_string .= $matches[1][$i];
        }
        return $folded_string;
    }

    public function escape(string $string): string
    {
        $string = preg_replace('/(?<!\\\\)(\\\\)([^;,n\\\\])/', '\${1}\${1}\${2}', $string);
        $string = preg_replace('/(?<!\\\\);/', '\\;', $string);
        $string = preg_replace('/(?<!\\\\),/', '\\,', $string);
        $string = preg_replace('/\n/', '\\n', $string);
        return $string;
    }

    public function explodeVar(string $variable, string $separator = ','): array
    {
        $exploded = explode($separator, $variable);
        foreach ($exploded as $index => $var) {
            $exploded[$index] = $this->escape($var);
        }
        return $exploded;
    }

    public function buildVCard(): string
    {
        $fn = $n = $nickname = $photo = $bday = $adr = $label = $tel = $email = $mailer =
        $tz = $geo = $title = $role = $logo = $agent = $org = $categories = $note = $prodid =
        $rev = $sortstring = $sound = $uid = $url = $class = $key = 0;

        $vcard = "BEGIN:VCARD\n";
        $vcard .= 'VERSION:' . $this->types['VERSION'] . "\n";
        foreach ($this->types as $type => $var) {
            \ilLoggerFactory::getLogger('user')->debug(print_r($this->types, true));

            switch ($type) {
                case 'FN':
                    if (strcmp($this->types['FN'], '') != 0) {
                        $fn = $this->fold('FN:' . $this->types['FN']) . "\n";
                    } else {
                        $fn = '';
                    }
                    break;
                case 'N':
                    if (strcmp($this->types['N'], '') != 0) {
                        $n = $this->fold('N:' . $this->types['N']) . "\n";
                    } else {
                        $n = '';
                    }
                    break;
                case 'NICKNAME':
                    if (strcmp($this->types['NICKNAME'], '') != 0) {
                        $nickname = $this->fold('NICKNAME:' . $this->types['NICKNAME']) . "\n";
                    } else {
                        $nickname = '';
                    }
                    break;
                case 'PHOTO':
                    $photo = '';
                    if (isset($this->types['PHOTO'])) {
                        if (strcmp(($this->types['PHOTO']['VALUE'] ?? ''), '') != 0) {
                            $photo = $this->fold('PHOTO;VALUE=uri:' . $this->types['PHOTO']['VALUE']) . "\n";
                        } elseif (strcmp(($this->types['PHOTO']['ENCODING'] ?? ''), '') != 0) {
                            $photo = 'PHOTO;ENCODING=' . $this->types['PHOTO']['ENCODING'];
                            if (strcmp($this->types['PHOTO']['TYPE'], '') != 0) {
                                $photo .= ';TYPE=' . $this->types['PHOTO']['TYPE'];
                            }
                            $photo .= ':' . $this->types['PHOTO']['PHOTO'];
                            $photo = $this->fold($photo) . "\n";
                        }
                    }
                    break;
                case 'BDAY':
                    if (strcmp($this->types['BDAY'], '') != 0) {
                        $bday = $this->fold('BDAY:' . $this->types['BDAY']) . "\n";
                    } else {
                        $bday = '';
                    }
                    break;
                case 'ADR':
                    if (count($this->types['ADR'])) {
                        $addresses = '';
                        foreach ($this->types['ADR'] as $key => $address) {
                            $test = implode('', $address);
                            if (strcmp($test, '') != 0) {
                                $adr = 'ADR';
                                $adr_types = [];
                                if ($address['TYPE'] > 0) {
                                    if (($address['TYPE'] & ADR_TYPE_DOM) > 0) {
                                        $adr_types[] = 'dom';
                                    }
                                    if (($address['TYPE'] & ADR_TYPE_INTL) > 0) {
                                        $adr_types[] = 'intl';
                                    }
                                    if (($address['TYPE'] & ADR_TYPE_POSTAL) > 0) {
                                        $adr_types[] = 'postal';
                                    }
                                    if (($address['TYPE'] & ADR_TYPE_PARCEL) > 0) {
                                        $adr_types[] = 'parcel';
                                    }
                                    if (($address['TYPE'] & ADR_TYPE_HOME) > 0) {
                                        $adr_types[] = 'home';
                                    }
                                    if (($address['TYPE'] & ADR_TYPE_WORK) > 0) {
                                        $adr_types[] = 'work';
                                    }
                                    if (($address['TYPE'] & ADR_TYPE_PREF) > 0) {
                                        $adr_types[] = 'pref';
                                    }
                                    $adr .= ';TYPE=' . implode(',', $adr_types);
                                }
                                $adr .= ':' . $address['POBOX'] . ';' . $address['EXTENDED_ADDRESS'] .
                                    ';' . $address['STREET_ADDRESS'] . ';' . $address['LOCALITY'] .
                                    ';' . $address['REGION'] . ';' . $address['POSTAL_CODE'] .
                                    ';' . $address['COUNTRY'];
                                $adr = $this->fold($adr) . "\n";
                                $addresses .= $adr;
                            }
                        }
                        $adr = $addresses;
                    } else {
                        $adr = '';
                    }
                    break;
                case 'LABEL':
                    $label = '';
                    if (isset($this->types['LABEL'])) {
                        if (strcmp(($this->types['LABEL']['LABEL'] ?? ''), '') != 0) {
                            $label = 'LABEL';
                            $adr_types = [];
                            if ($this->types['LABEL']['TYPE'] > 0) {
                                if (($this->types['LABEL']['TYPE'] & self::ADR_TYPE_DOM) > 0) {
                                    $adr_types[] = 'dom';
                                }
                                if (($this->types['LABEL']['TYPE'] & self::ADR_TYPE_INTL) > 0) {
                                    $adr_types[] = 'intl';
                                }
                                if (($this->types['LABEL']['TYPE'] & self::ADR_TYPE_POSTAL) > 0) {
                                    $adr_types[] = 'postal';
                                }
                                if (($this->types['LABEL']['TYPE'] & self::ADR_TYPE_PARCEL) > 0) {
                                    $adr_types[] = 'parcel';
                                }
                                if (($this->types['LABEL']['TYPE'] & self::ADR_TYPE_HOME) > 0) {
                                    $adr_types[] = 'home';
                                }
                                if (($this->types['LABEL']['TYPE'] & self::ADR_TYPE_WORK) > 0) {
                                    $adr_types[] = 'work';
                                }
                                if (($this->types['LABEL']['TYPE'] & self::ADR_TYPE_PREF) > 0) {
                                    $adr_types[] = 'pref';
                                }
                                $label .= ';TYPE=' . implode(',', $adr_types);
                            }
                            $label .= ':' . $this->types['LABEL']['LABEL'];
                            $label = $this->fold($label) . "\n";
                        }
                    }
                    break;
                case 'TEL':
                    if (count($this->types['TEL'])) {
                        $phonenumbers = '';
                        foreach ($this->types['TEL'] as $key => $phone) {
                            if (strcmp($phone['TEL'], '') != 0) {
                                $tel = 'TEL';
                                $tel_types = [];
                                if ($phone['TYPE'] > 0) {
                                    if (($phone['TYPE'] & self::TEL_TYPE_HOME) > 0) {
                                        $tel_types[] = 'home';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_MSG) > 0) {
                                        $tel_types[] = 'msg';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_WORK) > 0) {
                                        $tel_types[] = 'work';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_PREF) > 0) {
                                        $tel_types[] = 'pref';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_VOICE) > 0) {
                                        $tel_types[] = 'voice';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_FAX) > 0) {
                                        $tel_types[] = 'fax';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_CELL) > 0) {
                                        $tel_types[] = 'cell';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_VIDEO) > 0) {
                                        $tel_types[] = 'video';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_PAGER) > 0) {
                                        $tel_types[] = 'pager';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_BBS) > 0) {
                                        $tel_types[] = 'bbs';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_MODEM) > 0) {
                                        $tel_types[] = 'modem';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_CAR) > 0) {
                                        $tel_types[] = 'car';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_ISDN) > 0) {
                                        $tel_types[] = 'isdn';
                                    }
                                    if (($phone['TYPE'] & self::TEL_TYPE_PCS) > 0) {
                                        $tel_types[] = 'pcs';
                                    }
                                    $tel .= ';TYPE=' . implode(',', $tel_types);
                                }
                                $tel .= ':' . $phone['TEL'];
                                $tel = $this->fold($tel) . "\n";
                                $phonenumbers .= $tel;
                            }
                        }
                        $tel = $phonenumbers;
                    } else {
                        $tel = '';
                    }
                    break;
                case 'EMAIL':
                    if (count($this->types['EMAIL'])) {
                        $emails = '';
                        foreach ($this->types['EMAIL'] as $key => $mail) {
                            if (strcmp($mail['EMAIL'], '') != 0) {
                                $email = 'EMAIL';
                                $adr_types = [];
                                if ($mail['TYPE'] > 0) {
                                    if (($mail['TYPE'] & self::EMAIL_TYPE_INTERNET) > 0) {
                                        $adr_types[] = 'internet';
                                    }
                                    if (($mail['TYPE'] & self::EMAIL_TYPE_x400) > 0) {
                                        $adr_types[] = 'x400';
                                    }
                                    if (($mail['TYPE'] & self::EMAIL_TYPE_PREF) > 0) {
                                        $adr_types[] = 'pref';
                                    }
                                    $email .= ';TYPE=' . implode(',', $adr_types);
                                }
                                $email .= ':' . $mail['EMAIL'];
                                $email = $this->fold($email) . "\n";
                                $emails .= $email;
                            }
                        }
                        $email = $emails;
                    } else {
                        $email = '';
                    }
                    break;
                case 'MAILER':
                    if (strcmp(($this->types['MAILER'] ?? ''), '') != 0) {
                        $mailer = $this->fold('MAILER:' . $this->types['MAILER']) . "\n";
                    } else {
                        $mailer = '';
                    }
                    break;
                case 'TZ':
                    if (strcmp(($this->types['TZ'] ?? ''), '') != 0) {
                        $tz = $this->fold('TZ:' . $this->types['TZ']) . "\n";
                    } else {
                        $tz = '';
                    }
                    break;
                case 'GEO':
                    if (isset($this->types['GEO']) and
                        (strcmp(($this->types['GEO']['LAT'] ?? ''), '') != 0) and
                        (strcmp(($this->types['GEO']['LON'] ?? ''), '') != 0)) {
                        $geo = $this->fold(
                            'GEO:' . $this->types['GEO']['LAT'] . ';' . $this->types['GEO']['LON']
                        ) . "\n";
                    } else {
                        $geo = '';
                    }
                    break;
                case 'TITLE':
                    if (strcmp(($this->types['TITLE'] ?? ''), '') != 0) {
                        $title = $this->fold('TITLE:' . $this->types['TITLE']) . "\n";
                    } else {
                        $title = '';
                    }
                    break;
                case 'ROLE':
                    if (strcmp(($this->types['ROLE'] ?? ''), '') != 0) {
                        $role = $this->fold('ROLE:' . $this->types['ROLE']) . "\n";
                    } else {
                        $role = '';
                    }
                    break;
                case 'LOGO':
                    $logo = '';
                    if (isset($this->types['LOGO'])) {
                        if (strcmp(($this->types['LOGO']['VALUE'] ?? ''), '') != 0) {
                            $logo = $this->fold('LOGO;VALUE=uri:' . $this->types['LOGO']['VALUE']) . "\n";
                        } elseif (strcmp(($this->types['LOGO']['ENCODING'] ?? ''), '') != 0) {
                            $logo = 'LOGO;ENCODING=' . $this->types['LOGO']['ENCODING'];
                            if (strcmp($this->types['LOGO']['TYPE'], '') != 0) {
                                $logo .= ';TYPE=' . $this->types['LOGO']['TYPE'];
                            }
                            $logo .= ':' . $this->types['LOGO']['LOGO'];
                            $logo = $this->fold($logo) . "\n";
                        }
                    }
                    break;
                case 'AGENT':
                    if (strcmp(($this->types['AGENT'] ?? ''), '') != 0) {
                        $agent = $this->fold('AGENT:' . $this->types['AGENT']) . "\n";
                    } else {
                        $agent = '';
                    }
                    break;
                case 'ORG':
                    if (strcmp(($this->types['ORG'] ?? ''), '') != 0) {
                        $org = $this->fold('ORG:' . $this->types['ORG']) . "\n";
                    } else {
                        $org = '';
                    }
                    break;
                case 'CATEGORIES':
                    if (strcmp(($this->types['CATEGORIES'] ?? ''), '') != 0) {
                        $categories = $this->fold('CATEGORIES:' . $this->types['CATEGORIES']) . "\n";
                    } else {
                        $categories = '';
                    }
                    break;
                case 'NOTE':
                    if (strcmp(($this->types['NOTE'] ?? ''), '') != 0) {
                        $note = $this->fold('NOTE:' . $this->types['NOTE']) . "\n";
                    } else {
                        $note = '';
                    }
                    break;
                case 'PRODID':
                    if (strcmp(($this->types['PRODID'] ?? ''), '') != 0) {
                        $prodid = $this->fold('PRODID:' . $this->types['PRODID']) . "\n";
                    } else {
                        $prodid = '';
                    }
                    break;
                case 'REV':
                    if (strcmp(($this->types['REV'] ?? ''), '') != 0) {
                        $rev = $this->fold('REV:' . $this->types['REV']) . "\n";
                    } else {
                        $rev = '';
                    }
                    break;
                case 'SORT-STRING':
                    if (strcmp(($this->types['SORT-STRING'] ?? ''), '') != 0) {
                        $sortstring = $this->fold('SORT-STRING:' . $this->types['SORT-STRING']) . "\n";
                    } else {
                        $sortstring = '';
                    }
                    break;
                case 'SOUND':
                    $sound = '';
                    if (isset($this->types['SOUND'])) {
                        if (strcmp(($this->types['SOUND']['VALUE'] ?? ''), '') != 0) {
                            $sound = $this->fold('SOUND;VALUE=uri:' . $this->types['SOUND']['VALUE']) . "\n";
                        } elseif (strcmp(($this->types['SOUND']['ENCODING'] ?? ''), '') != 0) {
                            $sound = 'SOUND;ENCODING=' . $this->types['SOUND']['ENCODING'];
                            if (strcmp($this->types['SOUND']['TYPE'], '') != 0) {
                                $sound .= ';TYPE=' . $this->types['SOUND']['TYPE'];
                            }
                            $sound .= ':' . $this->types['SOUND']['SOUND'];
                            $sound = $this->fold($sound) . "\n";
                        }
                    }
                    break;
                case 'UID':
                    $uid = '';
                    if (isset($this->types['UID'])) {
                        if (strcmp(($this->types['UID']['UID'] ?? ''), '') != 0) {
                            $uid = 'UID';
                            if (strcmp($this->types['UID']['TYPE'], '') != 0) {
                                $uid .= ';TYPE=' . $this->types['UID']['TYPE'];
                            }
                            $uid .= ':' . $this->types['UID']['UID'];
                            $uid = $this->fold($uid) . "\n";
                        }
                    }
                    break;
                case 'URL':
                    if (strcmp(($this->types['URL'] ?? ''), '') != 0) {
                        $url = $this->fold('URL:' . $this->types['URL']) . "\n";
                    } else {
                        $url = '';
                    }
                    break;
                case 'KEY':
                    $key = '';
                    if (isset($this->types['KEY'])) {
                        if (strcmp(($this->types['KEY']['KEY'] ?? ''), '') != 0) {
                            $key = 'KEY';
                            if (strcmp($this->types['KEY']['TYPE'], '') != 0) {
                                $key .= ';TYPE=' . $this->types['KEY']['TYPE'];
                            }
                            if (strcmp($this->types['KEY']['ENCODING'], '') != 0) {
                                $key .= ';ENCODING=' . $this->types['KEY']['ENCODING'];
                            }
                            $key .= ':' . $this->types['KEY']['KEY'];
                            $key = $this->fold($key) . "\n";
                        }
                    }
                    break;
                case 'CLASS':
                    if (strcmp(($this->types['CLASS'] ?? ''), '') != 0) {
                        $class = $this->fold('CLASS:' . $this->types['CLASS']) . "\n";
                    } else {
                        $class = '';
                    }
                    break;
            }
        }
        $vcard .= $fn . $n . $nickname . $photo . $bday . $adr . $label . $tel . $email . $mailer .
            $tz . $geo . $title . $role . $logo . $agent . $org . $categories . $note . $prodid .
            $rev . $sortstring . $sound . $uid . $url . $class . $key;
        $vcard .= "END:vCard\n";
        return $vcard;
    }

    public function quoted_printable_encode(string $input, int $line_max = 76): string
    {
        $hex = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'];
        $lines = preg_split('/(\r\n|\r|\n)/', $input);
        $eol = "\r\n";
        $linebreak = '=0D=0A';
        $escape = '=';
        $output = '';

        for ($j = 0, $jMax = count($lines); $j < $jMax; $j++) {
            $line = $lines[$j];
            $linlen = strlen($line);
            $newline = '';
            for ($i = 0; $i < $linlen; $i++) {
                $c = substr($line, $i, 1);
                $dec = ord($c);
                if (($dec == 32) && ($i == ($linlen - 1))) { // convert space at eol only
                    $c = '=20';
                } elseif (($dec == 61) || ($dec < 32) || ($dec > 126)) { // always encode '\t', which is *not* required
                    $h2 = floor($dec / 16);
                    $h1 = floor($dec % 16);
                    $c = $escape . $hex[(string) $h2] . $hex[(string) $h1];
                }
                if ((strlen($newline) + strlen($c)) >= $line_max) { // CRLF is not counted
                    $output .= $newline . $escape . $eol; // soft line break; ' =\r\n' is okay
                    $newline = '    ';
                }
                $newline .= $c;
            } // end of for
            $output .= $newline;
            if ($j < count($lines) - 1) {
                $output .= $linebreak;
            }
        }
        return trim($output);
    }

    // Identification Types
    // These types are used in the vCard profile to capture information
    // associated with the identification and naming of the person or
    // resource associated with the vCard.

    public function setFormattedName(string $formatted_name): void
    {
        $this->types['FN'] = $this->escape($formatted_name);
    }

    public function setName(
        string $family_name,
        string $given_name = '',
        string $additional_names = '',
        string $honorific_prefixes = '',
        string $honorific_suffixes = ''
    ): void {
        $familynames = $this->explodeVar($family_name);
        $givennames = $this->explodeVar($given_name);
        $addnames = $this->explodeVar($additional_names);
        $prefixes = $this->explodeVar($honorific_prefixes);
        $suffixes = $this->explodeVar($honorific_suffixes);

        $this->types['N'] =
            implode(',', $familynames) .
            ';' .
            implode(',', $givennames) .
            ';' .
            implode(',', $addnames) .
            ';' .
            implode(',', $prefixes) .
            ';' .
            implode(',', $suffixes);

        $this->filename = $given_name . '_' . $family_name . '.vcf';
        if (strcmp($this->types['FN'], '') === 0) {
            $fn = trim("$honorific_prefixes $given_name $additional_names $family_name $honorific_suffixes");
            $fn = preg_replace('/\s{2,10}/', ' ', $fn);
            $this->setFormattedName($fn);
        }
    }

    public function setNickname(string $nickname): void
    {
        $nicknames = $this->explodeVar($nickname);
        $this->types['NICKNAME'] = implode(',', $nicknames);
    }

    public function setPhoto(
        string $photo,
        string $type = ''
    ): void {
        $value = '';
        $encoding = '';
        if (preg_match('/^http/', $photo)) {
            $value = $this->encode($photo);
        } else {
            $encoding = 'b';
            $photo = base64_encode($photo);
        }
        $this->types['PHOTO'] = [
            'VALUE' => $value,
            'TYPE' => $type,
            'ENCODING' => $encoding,
            'PHOTO' => $photo
        ];
    }

    public function setBirthday(int $year, int $month, int $day): void
    {
        if (($year < 1) or ($day < 1) or ($month < 1)) {
            $this->types['BDAY'] = '';
        } else {
            $this->types['BDAY'] = sprintf('%04d-%02d-%02d', $year, $month, $day);
        }
    }

    // Delivery Addressing Types
    // These types are concerned with information related to the delivery
    // addressing or label for the vCard object.

    public function setAddress(
        string $po_box = '',
        string $extended_address = '',
        string $street_address = '',
        string $locality = '',
        string $region = '',
        string $postal_code = '',
        string $country = '',
        int $type = self::ADR_TYPE_NONE
    ): void {
        if ($type === self::ADR_TYPE_NONE) {
            $type = self::ADR_TYPE_INTL + self::ADR_TYPE_POSTAL + self::ADR_TYPE_PARCEL + self::ADR_TYPE_WORK;
        }
        $po_box = implode(',', $this->explodeVar($po_box));
        $extended_address = implode(',', $this->explodeVar($extended_address));
        $street_address = implode(',', $this->explodeVar($street_address));
        $locality = implode(',', $this->explodeVar($locality));
        $region = implode(',', $this->explodeVar($region));
        $postal_code = implode(',', $this->explodeVar($postal_code));
        $country = implode(',', $this->explodeVar($country));
        $this->types['ADR'][] = [
            'POBOX' => $po_box,
            'EXTENDED_ADDRESS' => $extended_address,
            'STREET_ADDRESS' => $street_address,
            'LOCALITY' => $locality,
            'REGION' => $region,
            'POSTAL_CODE' => $postal_code,
            'COUNTRY' => $country,
            'TYPE' => $type
        ];
    }

    public function setLabel(
        string $label = '',
        int $type = self::ADR_TYPE_NONE
    ): void {
        if ($type == self::ADR_TYPE_NONE) {
            $type = self::ADR_TYPE_INTL + self::ADR_TYPE_POSTAL + self::ADR_TYPE_PARCEL + self::ADR_TYPE_WORK;
        }
        $this->types['LABEL'] = [
            'LABEL' => $this->escape($label),
            'TYPE' => $type
        ];
    }

    // Telecommunications Addressing Types
    // These types are concerned with information associated with the
    // telecommunications addressing of the object the vCard represents.

    public function setPhone(
        string $number = '',
        int $type = self::TEL_TYPE_VOICE
    ): void {
        $this->types['TEL'][] = [
            'TEL' => $this->escape($number),
            'TYPE' => $type
        ];
    }

    public function setEmail(
        string $address = '',
        int $type = self::EMAIL_TYPE_INTERNET
    ): void {
        $this->types['EMAIL'][] = [
            'EMAIL' => $this->escape($address),
            'TYPE' => $type
        ];
    }

    public function setMailer(string $name = ''): void
    {
        $this->types['MAILER'] = $this->escape($name);
    }

    // Geographical Types
    // These types are concerned with information associated with
    // geographical positions or regions associated with the object the
    // vCard represents.

    public function setTimezone(string $zone = ''): void
    {
        $this->types['TZ'] = $this->escape($zone);
    }

    public function setPosition(string $latitude = '', string $longitude = ''): void
    {
        $this->types['GEO'] = [
            'LAT' => $latitude,
            'LON' => $longitude
        ];
    }

    // Organizational Types
    // These types are concerned with information associated with
    // characteristics of the organization or organizational units of the
    // object the vCard represents.

    public function setTitle(string $title = ''): void
    {
        $this->types['TITLE'] = $this->escape($title);
    }

    public function setRole(string $role = ''): void
    {
        $this->types['ROLE'] = $this->escape($role);
    }

    public function setLogo(string $logo, string $type = ''): void
    {
        $value = '';
        $encoding = '';
        if (preg_match('/^http/', $logo)) {
            $value = $this->encode($logo);
        } else {
            $encoding = 'b';
            $logo = base64_encode($logo);
        }
        $this->types['LOGO'] = [
            'VALUE' => $value,
            'TYPE' => $type,
            'ENCODING' => $encoding,
            'LOGO' => $logo
        ];
    }

    public function setAgent(string $agent = ''): void
    {
        $this->types['AGENT'] = $this->escape($agent);
    }

    public function setOrganization(string $organization = ''): void
    {
        $organization = implode(';', $this->explodeVar($organization, ';'));
        $this->types['ORG'] = $organization;
    }

    // Explanatory Types
    // These types are concerned with additional explanations, such as that
    // related to informational notes or revisions specific to the vCard.

    public function setCategories(string $categories): void
    {
        $categories = implode(',', $this->explodeVar($categories));
        $this->types['CATEGORIES'] = $categories;
    }

    public function setNote(string $note = ''): void
    {
        $this->types['NOTE'] = $this->escape($note);
    }

    public function setProductId(string $product_id = ''): void
    {
        $this->types['PRODID'] = $this->escape($product_id);
    }

    public function setRevision(string $revision_date = ''): void
    {
        $this->types['REV'] = $this->escape($revision_date);
    }

    public function setSortString(string $string = ''): void
    {
        $this->types['SORT-STRING'] = $this->escape($string);
    }

    public function setSound(string $sound = '', string $type = ''): void
    {
        $value = '';
        $encoding = '';
        if (preg_match('/^http/', $sound)) {
            $value = $this->encode($sound);
        } else {
            $encoding = 'b';
            $sound = base64_encode($sound);
        }
        $this->types['SOUND'] = [
            'VALUE' => $value,
            'TYPE' => $type,
            'ENCODING' => $encoding,
            'SOUND' => $sound
        ];
    }

    public function setUID(string $uid = '', string $type = ''): void
    {
        $this->types['UID'] = [
            'UID' => $this->escape($uid),
            'TYPE' => $type
        ];
    }

    public function setURL(string $uri = ''): void
    {
        $this->types['URL'] = $this->escape($uri);
    }

    public function setVersion(string $version = '3.0'): void
    {
        $this->types['VERSION'] = $version;
    }

    // Security Types
    // These types are concerned with the security of communication pathways
    // or access to the vCard.

    public function setClassification(string $classification = ''): void
    {
        $this->types['CLASS'] = $this->escape($classification);
    }

    public function setKey(string $key = '', string $type = ''): void
    {
        $encoding = 'b';
        $key = base64_encode($key);
        $this->types['KEY'] = [
            'KEY' => $key,
            'TYPE' => $type,
            'ENCODING' => $encoding
        ];
    }

    public function getFilename(): string
    {
        if (strcmp($this->filename, '') == 0) {
            return 'vcard.vcf';
        } else {
            return $this->filename;
        }
    }

    public function getMimetype(): string
    {
        return 'text/x-vcard';
    }
}