DocumentProperties.php

Go to the documentation of this file.

<?php
class PHPExcel_DocumentProperties
{
    const PROPERTY_TYPE_BOOLEAN = 'b';
    const PROPERTY_TYPE_INTEGER = 'i';
    const PROPERTY_TYPE_FLOAT   = 'f';
    const PROPERTY_TYPE_DATE    = 'd';
    const PROPERTY_TYPE_STRING  = 's';
    const PROPERTY_TYPE_UNKNOWN = 'u';
 
    private $_creator    = 'Unknown Creator';
 
    private $_lastModifiedBy;
 
    private $_created;
 
    private $_modified;
 
    private $_title            = 'Untitled Spreadsheet';
 
    private $_description    = '';
 
    private $_subject        = '';
 
    private $_keywords        = '';
 
    private $_category        = '';
 
    private $_manager        = '';
 
    private $_company        = 'Microsoft Corporation';
 
    private $_customProperties    = array();
 
 
    public function __construct()
    {
        // Initialise values
        $this->_lastModifiedBy    = $this->_creator;
        $this->_created        = time();
        $this->_modified    = time();
    }
 
    public function getCreator() {
        return $this->_creator;
    }
 
    public function setCreator($pValue = '') {
        $this->_creator = $pValue;
        return $this;
    }
 
    public function getLastModifiedBy() {
        return $this->_lastModifiedBy;
    }
 
    public function setLastModifiedBy($pValue = '') {
        $this->_lastModifiedBy = $pValue;
        return $this;
    }
 
    public function getCreated() {
        return $this->_created;
    }
 
    public function setCreated($pValue = null) {
        if ($pValue === NULL) {
            $pValue = time();
        } elseif (is_string($pValue)) {
            if (is_numeric($pValue)) {
                $pValue = intval($pValue);
            } else {
                $pValue = strtotime($pValue);
            }
        }
 
        $this->_created = $pValue;
        return $this;
    }
 
    public function getModified() {
        return $this->_modified;
    }
 
    public function setModified($pValue = null) {
        if ($pValue === NULL) {
            $pValue = time();
        } elseif (is_string($pValue)) {
            if (is_numeric($pValue)) {
                $pValue = intval($pValue);
            } else {
                $pValue = strtotime($pValue);
            }
        }
 
        $this->_modified = $pValue;
        return $this;
    }
 
    public function getTitle() {
        return $this->_title;
    }
 
    public function setTitle($pValue = '') {
        $this->_title = $pValue;
        return $this;
    }
 
    public function getDescription() {
        return $this->_description;
    }
 
    public function setDescription($pValue = '') {
        $this->_description = $pValue;
        return $this;
    }
 
    public function getSubject() {
        return $this->_subject;
    }
 
    public function setSubject($pValue = '') {
        $this->_subject = $pValue;
        return $this;
    }
 
    public function getKeywords() {
        return $this->_keywords;
    }
 
    public function setKeywords($pValue = '') {
        $this->_keywords = $pValue;
        return $this;
    }
 
    public function getCategory() {
        return $this->_category;
    }
 
    public function setCategory($pValue = '') {
        $this->_category = $pValue;
        return $this;
    }
 
    public function getCompany() {
        return $this->_company;
    }
 
    public function setCompany($pValue = '') {
        $this->_company = $pValue;
        return $this;
    }
 
    public function getManager() {
        return $this->_manager;
    }
 
    public function setManager($pValue = '') {
        $this->_manager = $pValue;
        return $this;
    }
 
    public function getCustomProperties() {
        return array_keys($this->_customProperties);
    }
 
    public function isCustomPropertySet($propertyName) {
        return isset($this->_customProperties[$propertyName]);
    }
 
    public function getCustomPropertyValue($propertyName) {
        if (isset($this->_customProperties[$propertyName])) {
            return $this->_customProperties[$propertyName]['value'];
        }
 
    }
 
    public function getCustomPropertyType($propertyName) {
        if (isset($this->_customProperties[$propertyName])) {
            return $this->_customProperties[$propertyName]['type'];
        }
 
    }
 
    public function setCustomProperty($propertyName,$propertyValue='',$propertyType=NULL) {
        if (($propertyType === NULL) || (!in_array($propertyType,array(self::PROPERTY_TYPE_INTEGER,
                                                                       self::PROPERTY_TYPE_FLOAT,
                                                                       self::PROPERTY_TYPE_STRING,
                                                                       self::PROPERTY_TYPE_DATE,
                                                                       self::PROPERTY_TYPE_BOOLEAN)))) {
            if ($propertyValue === NULL) {
                $propertyType = self::PROPERTY_TYPE_STRING;
            } elseif (is_float($propertyValue)) {
                $propertyType = self::PROPERTY_TYPE_FLOAT;
            } elseif(is_int($propertyValue)) {
                $propertyType = self::PROPERTY_TYPE_INTEGER;
            } elseif (is_bool($propertyValue)) {
                $propertyType = self::PROPERTY_TYPE_BOOLEAN;
            } else {
                $propertyType = self::PROPERTY_TYPE_STRING;
            }
        }
 
        $this->_customProperties[$propertyName] = array('value' => $propertyValue, 'type' => $propertyType);
        return $this;
    }
 
    public function __clone() {
        $vars = get_object_vars($this);
        foreach ($vars as $key => $value) {
            if (is_object($value)) {
                $this->$key = clone $value;
            } else {
                $this->$key = $value;
            }
        }
    }
 
    public static function convertProperty($propertyValue,$propertyType) {
        switch ($propertyType) {
            case 'empty'    :    //    Empty
                return '';
                break;
            case 'null'        :    //    Null
                return NULL;
                break;
            case 'i1'        :    //    1-Byte Signed Integer
            case 'i2'        :    //    2-Byte Signed Integer
            case 'i4'        :    //    4-Byte Signed Integer
            case 'i8'        :    //    8-Byte Signed Integer
            case 'int'        :    //    Integer
                return (int) $propertyValue;
                break;
            case 'ui1'        :    //    1-Byte Unsigned Integer
            case 'ui2'        :    //    2-Byte Unsigned Integer
            case 'ui4'        :    //    4-Byte Unsigned Integer
            case 'ui8'        :    //    8-Byte Unsigned Integer
            case 'uint'        :    //    Unsigned Integer
                return abs((int) $propertyValue);
                break;
            case 'r4'        :    //    4-Byte Real Number
            case 'r8'        :    //    8-Byte Real Number
            case 'decimal'    :    //    Decimal
                return (float) $propertyValue;
                break;
            case 'lpstr'    :    //    LPSTR
            case 'lpwstr'    :    //    LPWSTR
            case 'bstr'        :    //    Basic String
                return $propertyValue;
                break;
            case 'date'        :    //    Date and Time
            case 'filetime'    :    //    File Time
                return strtotime($propertyValue);
                break;
            case 'bool'        :    //    Boolean
                return ($propertyValue == 'true') ? True : False;
                break;
            case 'cy'        :    //    Currency
            case 'error'    :    //    Error Status Code
            case 'vector'    :    //    Vector
            case 'array'    :    //    Array
            case 'blob'        :    //    Binary Blob
            case 'oblob'    :    //    Binary Blob Object
            case 'stream'    :    //    Binary Stream
            case 'ostream'    :    //    Binary Stream Object
            case 'storage'    :    //    Binary Storage
            case 'ostorage'    :    //    Binary Storage Object
            case 'vstream'    :    //    Binary Versioned Stream
            case 'clsid'    :    //    Class ID
            case 'cf'        :    //    Clipboard Data
                return $propertyValue;
                break;
        }
        return $propertyValue;
    }
 
    public static function convertPropertyType($propertyType) {
        switch ($propertyType) {
            case 'i1'        :    //    1-Byte Signed Integer
            case 'i2'        :    //    2-Byte Signed Integer
            case 'i4'        :    //    4-Byte Signed Integer
            case 'i8'        :    //    8-Byte Signed Integer
            case 'int'        :    //    Integer
            case 'ui1'        :    //    1-Byte Unsigned Integer
            case 'ui2'        :    //    2-Byte Unsigned Integer
            case 'ui4'        :    //    4-Byte Unsigned Integer
            case 'ui8'        :    //    8-Byte Unsigned Integer
            case 'uint'        :    //    Unsigned Integer
                return self::PROPERTY_TYPE_INTEGER;
                break;
            case 'r4'        :    //    4-Byte Real Number
            case 'r8'        :    //    8-Byte Real Number
            case 'decimal'    :    //    Decimal
                return self::PROPERTY_TYPE_FLOAT;
                break;
            case 'empty'    :    //    Empty
            case 'null'        :    //    Null
            case 'lpstr'    :    //    LPSTR
            case 'lpwstr'    :    //    LPWSTR
            case 'bstr'        :    //    Basic String
                return self::PROPERTY_TYPE_STRING;
                break;
            case 'date'        :    //    Date and Time
            case 'filetime'    :    //    File Time
                return self::PROPERTY_TYPE_DATE;
                break;
            case 'bool'        :    //    Boolean
                return self::PROPERTY_TYPE_BOOLEAN;
                break;
            case 'cy'        :    //    Currency
            case 'error'    :    //    Error Status Code
            case 'vector'    :    //    Vector
            case 'array'    :    //    Array
            case 'blob'        :    //    Binary Blob
            case 'oblob'    :    //    Binary Blob Object
            case 'stream'    :    //    Binary Stream
            case 'ostream'    :    //    Binary Stream Object
            case 'storage'    :    //    Binary Storage
            case 'ostorage'    :    //    Binary Storage Object
            case 'vstream'    :    //    Binary Versioned Stream
            case 'clsid'    :    //    Class ID
            case 'cf'        :    //    Clipboard Data
                return self::PROPERTY_TYPE_UNKNOWN;
                break;
        }
        return self::PROPERTY_TYPE_UNKNOWN;
    }
 
}