Documentation

DocumentProperties
in package

\PhpOffice\PhpPresentation\DocumentProperties.

Table of Contents

Constants

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

Properties

$category  : string
Category.
$company  : string
Company.
$created  : int
Created.
$creator  : string
Creator.
$customProperties  : array<string, array<string, mixed>>
Custom Properties.
$description  : string
Description.
$keywords  : string
Keywords.
$lastModifiedBy  : string
LastModifiedBy.
$modified  : int
Modified.
$revision  : string
Revision.
$status  : string
Status.
$subject  : string
Subject.
$title  : string
Title.

Methods

__construct()  : mixed
Create a new \PhpOffice\PhpPresentation\DocumentProperties.
getCategory()  : string
Get Category.
getCompany()  : string
Get Company.
getCreated()  : int
Get Created.
getCreator()  : string
Get Creator.
getCustomProperties()  : array<int, string>
Get a List of Custom Property Names.
getCustomPropertyType()  : string|null
Get a Custom Property Type.
getCustomPropertyValue()  : null|mixed
Get a Custom Property Value.
getDescription()  : string
Get Description.
getKeywords()  : string
Get Keywords.
getLastModifiedBy()  : string
Get Last Modified By.
getModified()  : int
Get Modified.
getRevision()  : string
Get Revision.
getStatus()  : string
Get Status.
getSubject()  : string
Get Subject.
getTitle()  : string
Get Title.
isCustomPropertySet()  : bool
Check if a Custom Property is defined.
setCategory()  : DocumentProperties
Set Category.
setCompany()  : DocumentProperties
Set Company.
setCreated()  : DocumentProperties
Set Created.
setCreator()  : DocumentProperties
Set Creator.
setCustomProperty()  : self
Set a Custom Property.
setDescription()  : DocumentProperties
Set Description.
setKeywords()  : DocumentProperties
Set Keywords.
setLastModifiedBy()  : DocumentProperties
Set Last Modified By.
setModified()  : DocumentProperties
Set Modified.
setRevision()  : self
Set Revision.
setStatus()  : self
Set Status.
setSubject()  : DocumentProperties
Set Subject.
setTitle()  : DocumentProperties
Set Title.

Constants

Properties

$customProperties

Custom Properties.

private array<string, array<string, mixed>> $customProperties = []

Methods

__construct()

Create a new \PhpOffice\PhpPresentation\DocumentProperties.

public __construct() : mixed

getCustomProperties()

Get a List of Custom Property Names.

public getCustomProperties() : array<int, string>
Return values
array<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) : null|mixed
Parameters
$propertyName : string
Return values
null|mixed

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

setCustomProperty()

Set a Custom Property.

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

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

Return values
self

setRevision()

Set Revision.

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

setStatus()

Set Status.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results