Documentation

Properties

Table of Contents

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'
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]
$category  : string
Category.
$company  : string
Company.
$created  : float|int
Created.
$creator  : string
Creator.
$customProperties  : mixed
Custom Properties.
$description  : string
Description.
$keywords  : string
Keywords.
$lastModifiedBy  : string
LastModifiedBy.
$manager  : string
Manager.
$modified  : float|int
Modified.
$subject  : string
Subject.
$title  : string
Title.
__construct()  : mixed
Create a new Document Properties instance.
convertProperty()  : mixed
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()  : null|string
Get a Custom Property Type.
getCustomPropertyValue()  : mixed
Get a Custom Property Value.
getDescription()  : string
Get Description.
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.
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.
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.
convertProperty2()  : mixed
Convert property to form desired by Excel.
identifyPropertyType()  : string
intOrFloatTimestamp()  : float|int

Constants

PROPERTY_TYPE_BOOLEAN

constants

public mixed PROPERTY_TYPE_BOOLEAN = 'b'

PROPERTY_TYPE_DATE

public mixed PROPERTY_TYPE_DATE = 'd'

PROPERTY_TYPE_FLOAT

public mixed PROPERTY_TYPE_FLOAT = 'f'

PROPERTY_TYPE_INTEGER

public mixed PROPERTY_TYPE_INTEGER = 'i'

PROPERTY_TYPE_STRING

public mixed PROPERTY_TYPE_STRING = 's'

PROPERTY_TYPE_UNKNOWN

public mixed PROPERTY_TYPE_UNKNOWN = 'u'

PROPERTY_TYPE_ARRAY

private mixed 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

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

VALID_PROPERTY_TYPE_LIST

private mixed 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

Category.

private string $category = ''

$creator

Creator.

private string $creator = 'Unknown Creator'

$customProperties

Custom Properties.

private mixed $customProperties = []

$description

Description.

private string $description = ''

$keywords

Keywords.

private string $keywords = ''

$lastModifiedBy

LastModifiedBy.

private string $lastModifiedBy

$title

Title.

private string $title = 'Untitled Spreadsheet'

Methods

__construct()

Create a new Document Properties instance.

public __construct() : mixed
Return values
mixed

convertProperty()

Convert property to form desired by Excel.

public static convertProperty(mixed $propertyValue, string $propertyType) : mixed
Parameters
$propertyValue : mixed
$propertyType : string
Return values
mixed

convertPropertyType()

public static convertPropertyType(string $propertyType) : string
Parameters
$propertyType : string
Return values
string

getCategory()

Get Category.

public getCategory() : string
Return values
string

getCompany()

Get Company.

public getCompany() : string
Return values
string

getCreated()

Get Created.

public getCreated() : float|int
Return values
float|int

getCreator()

Get Creator.

public getCreator() : string
Return values
string

getCustomProperties()

Get a List of Custom Property Names.

public getCustomProperties() : array<string|int, string>
Return values
array<string|int, string>

getCustomPropertyType()

Get a Custom Property Type.

public getCustomPropertyType(string $propertyName) : null|string
Parameters
$propertyName : string
Return values
null|string

getCustomPropertyValue()

Get a Custom Property Value.

public getCustomPropertyValue(string $propertyName) : mixed
Parameters
$propertyName : string
Return values
mixed

getDescription()

Get Description.

public getDescription() : string
Return values
string

getKeywords()

Get Keywords.

public getKeywords() : string
Return values
string

getLastModifiedBy()

Get Last Modified By.

public getLastModifiedBy() : string
Return values
string

getManager()

Get Manager.

public getManager() : string
Return values
string

getModified()

Get Modified.

public getModified() : float|int
Return values
float|int

getSubject()

Get Subject.

public getSubject() : string
Return values
string

getTitle()

Get Title.

public getTitle() : string
Return values
string

isCustomPropertySet()

Check if a Custom Property is defined.

public isCustomPropertySet(string $propertyName) : bool
Parameters
$propertyName : string
Return values
bool

setCategory()

Set Category.

public setCategory(string $category) : $this
Parameters
$category : string
Return values
$this

setCompany()

Set Company.

public setCompany(string $company) : $this
Parameters
$company : string
Return values
$this

setCreated()

Set Created.

public setCreated(null|float|int|string $timestamp) : $this
Parameters
$timestamp : null|float|int|string
Return values
$this

setCreator()

Set Creator.

public setCreator(string $creator) : $this
Parameters
$creator : string
Return values
$this

setCustomProperty()

Set a Custom Property.

public setCustomProperty(string $propertyName[, mixed $propertyValue = '' ][, string $propertyType = null ]) : $this
Parameters
$propertyName : string
$propertyValue : mixed = ''
$propertyType : string = null

'i' : Integer 'f' : Floating Point 's' : String 'd' : Date/Time 'b' : Boolean

Return values
$this

setDescription()

Set Description.

public setDescription(string $description) : $this
Parameters
$description : string
Return values
$this

setKeywords()

Set Keywords.

public setKeywords(string $keywords) : $this
Parameters
$keywords : string
Return values
$this

setLastModifiedBy()

Set Last Modified By.

public setLastModifiedBy(string $modifiedBy) : $this
Parameters
$modifiedBy : string
Return values
$this

setManager()

Set Manager.

public setManager(string $manager) : $this
Parameters
$manager : string
Return values
$this

setModified()

Set Modified.

public setModified(null|float|int|string $timestamp) : $this
Parameters
$timestamp : null|float|int|string
Return values
$this

setSubject()

Set Subject.

public setSubject(string $subject) : $this
Parameters
$subject : string
Return values
$this

setTitle()

Set Title.

public setTitle(string $title) : $this
Parameters
$title : string
Return values
$this

convertProperty2()

Convert property to form desired by Excel.

private static convertProperty2(mixed $propertyValue, string $type) : mixed
Parameters
$propertyValue : mixed
$type : string
Return values
mixed

identifyPropertyType()

private identifyPropertyType(mixed $propertyValue) : string
Parameters
$propertyValue : mixed
Return values
string

intOrFloatTimestamp()

private static intOrFloatTimestamp(null|float|int|string $timestamp) : float|int
Parameters
$timestamp : null|float|int|string
Return values
float|int

Search results