\PhpOffice\PhpSpreadsheet\DocumentProperties

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

File: vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Document/Properties.php
Package: Default
Class hierarchy: \PhpOffice\PhpSpreadsheet\Document\Properties

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 : integer

Created.

Type

integer

$modified

$modified : integer

Modified.

Type

integer

$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 Document Properties instance.

getCreator()

getCreator() : string

Get Creator.

Returns

string

setCreator()

setCreator(string  $creator) : $this

Set Creator.

Parameters

string

$creator

Returns

$this

getLastModifiedBy()

getLastModifiedBy() : string

Get Last Modified By.

Returns

string

setLastModifiedBy()

setLastModifiedBy(string  $pValue) : $this

Set Last Modified By.

Parameters

string

$pValue

Returns

$this

getCreated()

getCreated() : integer

Get Created.

Returns

integer

setCreated()

setCreated(integer|string  $time) : $this

Set Created.

Parameters

integer|string

$time

Returns

$this

getModified()

getModified() : integer

Get Modified.

Returns

integer

setModified()

setModified(integer|string  $time) : $this

Set Modified.

Parameters

integer|string

$time

Returns

$this

getTitle()

getTitle() : string

Get Title.

Returns

string

setTitle()

setTitle(string  $title) : $this

Set Title.

Parameters

string

$title

Returns

$this

getDescription()

getDescription() : string

Get Description.

Returns

string

setDescription()

setDescription(string  $description) : $this

Set Description.

Parameters

string

$description

Returns

$this

getSubject()

getSubject() : string

Get Subject.

Returns

string

setSubject()

setSubject(string  $subject) : $this

Set Subject.

Parameters

string

$subject

Returns

$this

getKeywords()

getKeywords() : string

Get Keywords.

Returns

string

setKeywords()

setKeywords(string  $keywords) : $this

Set Keywords.

Parameters

string

$keywords

Returns

$this

getCategory()

getCategory() : string

Get Category.

Returns

string

setCategory()

setCategory(string  $category) : $this

Set Category.

Parameters

string

$category

Returns

$this

getCompany()

getCompany() : string

Get Company.

Returns

string

setCompany()

setCompany(string  $company) : $this

Set Company.

Parameters

string

$company

Returns

$this

getManager()

getManager() : string

Get Manager.

Returns

string

setManager()

setManager(string  $manager) : $this

Set Manager.

Parameters

string

$manager

Returns

$this

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) : mixed

Get a Custom Property Value.

Parameters

string

$propertyName

Returns

mixed

getCustomPropertyType()

getCustomPropertyType(string  $propertyName) : string

Get a Custom Property Type.

Parameters

string

$propertyName

Returns

string

setCustomProperty()

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

Set a Custom Property.

Parameters

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

Returns

$this

__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