Documentation

DocumentProperties
in package

PHPProject_DocumentProperties

Tags
category

PHPProject

copyright

Copyright (c) 2012 - 2012 PHPProject (https: // github.com/PHPOffice/PHPProject)

Table of Contents

Constants

PROPERTY_TYPE_BOOLEAN  : mixed = 'b'
constants
PROPERTY_TYPE_DATE  : mixed = 'd'
PROPERTY_TYPE_FLOAT  : mixed = 'f'
PROPERTY_TYPE_INTEGER  : mixed = 'i'
PROPERTY_TYPE_STRING  : mixed = 's'
PROPERTY_TYPE_UNKNOWN  : mixed = 'u'

Properties

$category  : string
Category
$company  : string
Company
$created  : int
Created
$creator  : string
Creator
$customProperties  : array<string, array{value: mixed, type: string}>
Custom Properties
$description  : string
Description
$keywords  : string
Keywords
$lastModifiedBy  : string
LastModifiedBy
$manager  : string
Manager
$modified  : int
Modified
$subject  : string
Subject
$title  : string
Title

Methods

__construct()  : mixed
Create a new PHPProject_DocumentProperties
convertProperty()  : mixed
convertPropertyType()  : string
getCategory()  : string
Get Category
getCompany()  : string
Get Company
getCreated()  : 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()  : string|null
Get a Custom Property Value
getDescription()  : string
Get Description
getKeywords()  : string
Get Keywords
getLastModifiedBy()  : string
Get Last Modified By
getManager()  : string
Get Manager
getModified()  : int
Get Modified
getSubject()  : string
Get Subject
getTitle()  : string
Get Title
isCustomPropertySet()  : bool
Check if a Custom Property is defined
setCategory()  : self
Set Category
setCompany()  : self
Set Company
setCreated()  : self
Set Created
setCreator()  : self
Set Creator
setCustomProperty()  : self
Set a Custom Property
setDescription()  : self
Set Description
setKeywords()  : self
Set Keywords
setLastModifiedBy()  : self
Set Last Modified By
setManager()  : self
Set Manager
setModified()  : self
Set Modified
setSubject()  : self
Set Subject
setTitle()  : self
Set Title

Constants

Properties

$customProperties

Custom Properties

private array<string, array{value: mixed, type: string}> $customProperties = array()

Methods

__construct()

Create a new PHPProject_DocumentProperties

public __construct() : mixed

convertProperty()

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

convertPropertyType()

public static convertPropertyType(string $propertyType) : string
Parameters
$propertyType : 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) : string|null
Parameters
$propertyName : string
Return values
string|null

getCustomPropertyValue()

Get a Custom Property Value

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

getDescription()

Get Description

public getDescription() : string
Return values
string

getLastModifiedBy()

Get Last Modified By

public getLastModifiedBy() : 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 $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self

setCompany()

Set Company

public setCompany([string $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self

setCreated()

Set Created

public setCreated([int|string|null $pValue = null ]) : self
Parameters
$pValue : int|string|null = null
Return values
self

setCreator()

Set Creator

public setCreator([string $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self

setCustomProperty()

Set a Custom Property

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

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

Return values
self

setDescription()

Set Description

public setDescription([string $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self

setKeywords()

Set Keywords

public setKeywords([string $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self

setLastModifiedBy()

Set Last Modified By

public setLastModifiedBy([string $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self

setManager()

Set Manager

public setManager([string $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self

setModified()

Set Modified

public setModified([int|string|null $pValue = null ]) : self
Parameters
$pValue : int|string|null = null
Return values
self

setSubject()

Set Subject

public setSubject([string $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self

setTitle()

Set Title

public setTitle([string $pValue = '' ]) : self
Parameters
$pValue : string = ''
Return values
self
On this page

Search results