Documentation

Properties

in package

• Application

Table of Contents

Constants

PROPERTY_TYPE_BOOLEAN  = 'b'

constants

PROPERTY_TYPE_DATE  = 'd'

PROPERTY_TYPE_FLOAT  = 'f'

PROPERTY_TYPE_INTEGER  = 'i'

PROPERTY_TYPE_STRING  = 's'

PROPERTY_TYPE_UNKNOWN  = 'u'

SUGGESTED_VIEWPORT  = 'width=device-width, initial-scale=1'

PROPERTY_TYPE_ARRAY  = [ 'i' => self::PROPERTY_TYPE_INTEGER, // Integer 'i1' => self::PROPERTY_TYPE_INTEGER, // 1-Byte Signed Integer 'i2' => self::PROPERTY_TYPE_INTEGER, // 2-Byte Signed Integer 'i4' => self::PROPERTY_TYPE_INTEGER, // 4-Byte Signed Integer 'i8' => self::PROPERTY_TYPE_INTEGER, // 8-Byte Signed Integer 'int' => self::PROPERTY_TYPE_INTEGER, // Integer 'ui1' => self::PROPERTY_TYPE_INTEGER, // 1-Byte Unsigned Integer 'ui2' => self::PROPERTY_TYPE_INTEGER, // 2-Byte Unsigned Integer 'ui4' => self::PROPERTY_TYPE_INTEGER, // 4-Byte Unsigned Integer 'ui8' => self::PROPERTY_TYPE_INTEGER, // 8-Byte Unsigned Integer 'uint' => self::PROPERTY_TYPE_INTEGER, // Unsigned Integer 'f' => self::PROPERTY_TYPE_FLOAT, // Real Number 'r4' => self::PROPERTY_TYPE_FLOAT, // 4-Byte Real Number 'r8' => self::PROPERTY_TYPE_FLOAT, // 8-Byte Real Number 'decimal' => self::PROPERTY_TYPE_FLOAT, // Decimal 's' => self::PROPERTY_TYPE_STRING, // String 'empty' => self::PROPERTY_TYPE_STRING, // Empty 'null' => self::PROPERTY_TYPE_STRING, // Null 'lpstr' => self::PROPERTY_TYPE_STRING, // LPSTR 'lpwstr' => self::PROPERTY_TYPE_STRING, // LPWSTR 'bstr' => self::PROPERTY_TYPE_STRING, // Basic String 'd' => self::PROPERTY_TYPE_DATE, // Date and Time 'date' => self::PROPERTY_TYPE_DATE, // Date and Time 'filetime' => self::PROPERTY_TYPE_DATE, // File Time 'b' => self::PROPERTY_TYPE_BOOLEAN, // Boolean 'bool' => self::PROPERTY_TYPE_BOOLEAN, ]

SPECIAL_TYPES  = ['empty' => '', 'null' => null]

VALID_PROPERTY_TYPE_LIST  = [self::PROPERTY_TYPE_BOOLEAN, self::PROPERTY_TYPE_INTEGER, self::PROPERTY_TYPE_FLOAT, self::PROPERTY_TYPE_DATE, self::PROPERTY_TYPE_STRING]

Properties

$category  : string

Category.

$company  : string

Company.

$created  : float|int

Created.

$creator  : string

Creator.

$customProperties  : array<string|int, array{value: null|bool|float|int|string, type: string}>

Custom Properties.

$description  : string

Description.

$hyperlinkBase  : string

$keywords  : string

Keywords.

$lastModifiedBy  : string

LastModifiedBy.

$manager  : string

Manager.

$modified  : float|int

Modified.

$subject  : string

Subject.

$title  : string

Title.

$viewport  : string

Methods

__construct()  : mixed

Create a new Document Properties instance.

convertProperty()  : bool|int|float|string|null

Convert property to form desired by Excel.

convertPropertyType()  : string

getCategory()  : string

Get Category.

getCompany()  : string

Get Company.

getCreated()  : float|int

Get Created.

getCreator()  : string

Get Creator.

getCustomProperties()  : array<string|int, string>

Get a List of Custom Property Names.

getCustomPropertyType()  : string|null

Get a Custom Property Type.

getCustomPropertyValue()  : bool|int|float|string|null

Get a Custom Property Value.

getDescription()  : string

Get Description.

getHyperlinkBase()  : string

getKeywords()  : string

Get Keywords.

getLastModifiedBy()  : string

Get Last Modified By.

getManager()  : string

Get Manager.

getModified()  : float|int

Get Modified.

getSubject()  : string

Get Subject.

getTitle()  : string

Get Title.

getViewport()  : string

isCustomPropertySet()  : bool

Check if a Custom Property is defined.

setCategory()  : $this

Set Category.

setCompany()  : $this

Set Company.

setCreated()  : $this

Set Created.

setCreator()  : $this

Set Creator.

setCustomProperty()  : $this

Set a Custom Property.

setDescription()  : $this

Set Description.

setHyperlinkBase()  : self

setKeywords()  : $this

Set Keywords.

setLastModifiedBy()  : $this

Set Last Modified By.

setManager()  : $this

Set Manager.

setModified()  : $this

Set Modified.

setSubject()  : $this

Set Subject.

setTitle()  : $this

Set Title.

setViewport()  : self

convertProperty2()  : bool|int|float|string|null

Convert property to form desired by Excel.

identifyPropertyType()  : string

intOrFloatTimestamp()  : float|int