Parameter.php

Go to the documentation of this file.

<?php
 
namespace Sabre\VObject;
 
use ArrayIterator;
use Sabre\Xml;
 
class Parameter extends Node {
 
    public $name;
 
    public $noName = false;
 
    protected $value;
 
    function __construct(Document $root, $name, $value = null) {
 
        $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);
        }
 
    }
 
    static function guessParameterNameByValue($value) {
        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;
    }
 
    function setValue($value) {
 
        $this->value = $value;
 
    }
 
    function getValue() {
 
        if (is_array($this->value)) {
            return implode(',', $this->value);
        } else {
            return $this->value;
        }
 
    }
 
    function setParts(array $value) {
 
        $this->value = $value;
 
    }
 
    function getParts() {
 
        if (is_array($this->value)) {
            return $this->value;
        } elseif (is_null($this->value)) {
            return [];
        } else {
            return [$this->value];
        }
 
    }
 
    function addValue($part) {
 
        if (is_null($this->value)) {
            $this->value = $part;
        } else {
            $this->value = array_merge((array)$this->value, (array)$part);
        }
 
    }
 
    function has($value) {
 
        return in_array(
            strtolower($value),
            array_map('strtolower', (array)$this->value)
        );
 
    }
 
    function serialize() {
 
        $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;
                }
 
            }
        );
 
    }
 
    function jsonSerialize() {
 
        return $this->value;
 
    }
 
    function xmlSerialize(Xml\Writer $writer) {
 
        foreach (explode(',', $this->value) as $value) {
            $writer->writeElement('text', $value);
        }
 
    }
 
    function __toString() {
 
        return (string)$this->getValue();
 
    }
 
    function getIterator() {
 
        if (!is_null($this->iterator))
            return $this->iterator;
 
        return $this->iterator = new ArrayIterator((array)$this->value);
 
    }
 
}