\PHPExcel_DocumentProperties

PHPExcel_DocumentProperties

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
getCreator()
setCreator()
getLastModifiedBy()
setLastModifiedBy()
getCreated()
setCreated()
getModified()
setModified()
getTitle()
setTitle()
getDescription()
setDescription()
getSubject()
setSubject()
getKeywords()
setKeywords()
getCategory()
setCategory()
getCompany()
setCompany()
getManager()
setManager()
getCustomProperties()
isCustomPropertySet()
getCustomPropertyValue()
getCustomPropertyType()
setCustomProperty()
__clone()
convertProperty()
convertPropertyType()
No public properties found
PROPERTY_TYPE_BOOLEAN
PROPERTY_TYPE_INTEGER
PROPERTY_TYPE_FLOAT
PROPERTY_TYPE_DATE
PROPERTY_TYPE_STRING
PROPERTY_TYPE_UNKNOWN
No protected methods found
No protected properties found
N/A
No private methods found
$creator
$lastModifiedBy
$created
$modified
$title
$description
$subject
$keywords
$category
$manager
$company
$customProperties
N/A

Constants

PROPERTY_TYPE_BOOLEAN

PROPERTY_TYPE_BOOLEAN = 'b'

constants

PROPERTY_TYPE_INTEGER

PROPERTY_TYPE_INTEGER = 'i'

PROPERTY_TYPE_FLOAT

PROPERTY_TYPE_FLOAT = 'f'

PROPERTY_TYPE_DATE

PROPERTY_TYPE_DATE = 'd'

PROPERTY_TYPE_STRING

PROPERTY_TYPE_STRING = 's'

PROPERTY_TYPE_UNKNOWN

PROPERTY_TYPE_UNKNOWN = 'u'

Properties

$creator

$creator : string

Creator

Type

string

$lastModifiedBy

$lastModifiedBy : string

LastModifiedBy

Type

string

$created

$created : \datetime

Created

Type

\datetime

$modified

$modified : \datetime

Modified

Type

\datetime

$title

$title : string

Title

Type

string

$description

$description : string

Description

Type

string

$subject

$subject : string

Subject

Type

string

$keywords

$keywords : string

Keywords

Type

string

$category

$category : string

Category

Type

string

$manager

$manager : string

Manager

Type

string

$company

$company : string

Company

Type

string

$customProperties

$customProperties : string

Custom Properties

Type

string

Methods

__construct()

__construct() 

Create a new PHPExcel_DocumentProperties

getCreator()

getCreator() : string

Get Creator

Returns

string

setCreator()

setCreator(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Creator

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getLastModifiedBy()

getLastModifiedBy() : string

Get Last Modified By

Returns

string

setLastModifiedBy()

setLastModifiedBy(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Last Modified By

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getCreated()

getCreated() : \datetime

Get Created

Returns

\datetime

setCreated()

setCreated(\datetime  $pValue = null) : \PHPExcel_DocumentProperties

Set Created

Parameters

\datetime $pValue

Returns

\PHPExcel_DocumentProperties

getModified()

getModified() : \datetime

Get Modified

Returns

\datetime

setModified()

setModified(\datetime  $pValue = null) : \PHPExcel_DocumentProperties

Set Modified

Parameters

\datetime $pValue

Returns

\PHPExcel_DocumentProperties

getTitle()

getTitle() : string

Get Title

Returns

string

setTitle()

setTitle(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Title

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getDescription()

getDescription() : string

Get Description

Returns

string

setDescription()

setDescription(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Description

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getSubject()

getSubject() : string

Get Subject

Returns

string

setSubject()

setSubject(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Subject

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getKeywords()

getKeywords() : string

Get Keywords

Returns

string

setKeywords()

setKeywords(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Keywords

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getCategory()

getCategory() : string

Get Category

Returns

string

setCategory()

setCategory(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Category

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getCompany()

getCompany() : string

Get Company

Returns

string

setCompany()

setCompany(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Company

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getManager()

getManager() : string

Get Manager

Returns

string

setManager()

setManager(string  $pValue = '') : \PHPExcel_DocumentProperties

Set Manager

Parameters

string $pValue

Returns

\PHPExcel_DocumentProperties

getCustomProperties()

getCustomProperties() : array

Get a List of Custom Property Names

Returns

array —

of string

isCustomPropertySet()

isCustomPropertySet(string  $propertyName) : boolean

Check if a Custom Property is defined

Parameters

string $propertyName

Returns

boolean

getCustomPropertyValue()

getCustomPropertyValue(string  $propertyName) : string

Get a Custom Property Value

Parameters

string $propertyName

Returns

string

getCustomPropertyType()

getCustomPropertyType(string  $propertyName) : string

Get a Custom Property Type

Parameters

string $propertyName

Returns

string

setCustomProperty()

setCustomProperty(string  $propertyName, mixed  $propertyValue = '', string  $propertyType = null) : \PHPExcel_DocumentProperties

Set a Custom Property

Parameters

string $propertyName
mixed $propertyValue
string $propertyType

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

Returns

\PHPExcel_DocumentProperties

__clone()

__clone() 

Implement PHP __clone to create a deep clone, not just a shallow copy.

convertProperty()

convertProperty(  $propertyValue,   $propertyType) 

Parameters

$propertyValue
$propertyType

convertPropertyType()

convertPropertyType(  $propertyType) 

Parameters

$propertyType