class 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

Constants

PROPERTY_TYPE_BOOLEAN

constants

PROPERTY_TYPE_INTEGER

PROPERTY_TYPE_FLOAT

PROPERTY_TYPE_DATE

PROPERTY_TYPE_STRING

PROPERTY_TYPE_UNKNOWN

Methods

__construct()

Create a new PHPExcel_DocumentProperties

string
getCreator()

Get Creator

setCreator(string $pValue = '')

Set Creator

string
getLastModifiedBy()

Get Last Modified By

setLastModifiedBy(string $pValue = '')

Set Last Modified By

getCreated()

Get Created

setCreated(datetime $pValue = null)

Set Created

getModified()

Get Modified

setModified(datetime $pValue = null)

Set Modified

string
getTitle()

Get Title

setTitle(string $pValue = '')

Set Title

string
getDescription()

Get Description

setDescription(string $pValue = '')

Set Description

string
getSubject()

Get Subject

setSubject(string $pValue = '')

Set Subject

string
getKeywords()

Get Keywords

setKeywords(string $pValue = '')

Set Keywords

string
getCategory()

Get Category

setCategory(string $pValue = '')

Set Category

string
getCompany()

Get Company

setCompany(string $pValue = '')

Set Company

string
getManager()

Get Manager

setManager(string $pValue = '')

Set Manager

array
getCustomProperties()

Get a List of Custom Property Names

boolean
isCustomPropertySet(string $propertyName)

Check if a Custom Property is defined

string
getCustomPropertyValue(string $propertyName)

Get a Custom Property Value

string
getCustomPropertyType(string $propertyName)

Get a Custom Property Type

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

Set a Custom Property

__clone()

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

static 
convertProperty($propertyValue, $propertyType)

No description

static 
convertPropertyType($propertyType)

No description

Details

at line 135
__construct()

Create a new PHPExcel_DocumentProperties

at line 148
string getCreator()

Get Creator

Return Value

string

at line 159
PHPExcel_DocumentProperties setCreator(string $pValue = '')

Set Creator

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 170
string getLastModifiedBy()

Get Last Modified By

Return Value

string

at line 181
PHPExcel_DocumentProperties setLastModifiedBy(string $pValue = '')

Set Last Modified By

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 192
datetime getCreated()

Get Created

Return Value

datetime

at line 203
PHPExcel_DocumentProperties setCreated(datetime $pValue = null)

Set Created

Parameters

datetime $pValue

Return Value

PHPExcel_DocumentProperties

at line 224
datetime getModified()

Get Modified

Return Value

datetime

at line 235
PHPExcel_DocumentProperties setModified(datetime $pValue = null)

Set Modified

Parameters

datetime $pValue

Return Value

PHPExcel_DocumentProperties

at line 256
string getTitle()

Get Title

Return Value

string

at line 267
PHPExcel_DocumentProperties setTitle(string $pValue = '')

Set Title

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 278
string getDescription()

Get Description

Return Value

string

at line 289
PHPExcel_DocumentProperties setDescription(string $pValue = '')

Set Description

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 300
string getSubject()

Get Subject

Return Value

string

at line 311
PHPExcel_DocumentProperties setSubject(string $pValue = '')

Set Subject

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 322
string getKeywords()

Get Keywords

Return Value

string

at line 333
PHPExcel_DocumentProperties setKeywords(string $pValue = '')

Set Keywords

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 344
string getCategory()

Get Category

Return Value

string

at line 355
PHPExcel_DocumentProperties setCategory(string $pValue = '')

Set Category

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 366
string getCompany()

Get Company

Return Value

string

at line 377
PHPExcel_DocumentProperties setCompany(string $pValue = '')

Set Company

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 388
string getManager()

Get Manager

Return Value

string

at line 399
PHPExcel_DocumentProperties setManager(string $pValue = '')

Set Manager

Parameters

string $pValue

Return Value

PHPExcel_DocumentProperties

at line 410
array getCustomProperties()

Get a List of Custom Property Names

Return Value

array of string

at line 421
boolean isCustomPropertySet(string $propertyName)

Check if a Custom Property is defined

Parameters

string $propertyName

Return Value

boolean

at line 432
string getCustomPropertyValue(string $propertyName)

Get a Custom Property Value

Parameters

string $propertyName

Return Value

string

at line 446
string getCustomPropertyType(string $propertyName)

Get a Custom Property Type

Parameters

string $propertyName

Return Value

string

at line 467
PHPExcel_DocumentProperties setCustomProperty(string $propertyName, mixed $propertyValue = '', string $propertyType = null)

Set a Custom Property

Parameters

string $propertyName
mixed $propertyValue
string $propertyType 'i' : Integer 'f' : Floating Point 's' : String 'd' : Date/Time 'b' : Boolean

Return Value

PHPExcel_DocumentProperties

at line 497
__clone()

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

at line 509
static convertProperty($propertyValue, $propertyType)

Parameters

$propertyValue
$propertyType

at line 568
static convertPropertyType($propertyType)

Parameters

$propertyType