Documentation

Properties
in package

Table of Contents

Constants

PROPERTY_TYPE_BOOLEAN  = 'b'
constants
PROPERTY_TYPE_DATE  = 'd'
PROPERTY_TYPE_FLOAT  = 'f'
PROPERTY_TYPE_INTEGER  = 'i'
PROPERTY_TYPE_STRING  = 's'
PROPERTY_TYPE_UNKNOWN  = 'u'
SUGGESTED_VIEWPORT  = 'width=device-width, initial-scale=1'

Methods

__construct()  : mixed
Create a new Document Properties instance.
convertProperty()  : bool|int|float|string|null
Convert property to form desired by Excel.
convertPropertyType()  : string
getCategory()  : string
Get Category.
getCompany()  : string
Get Company.
getCreated()  : float|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()  : bool|int|float|string|null
Get a Custom Property Value.
getDescription()  : string
Get Description.
getHyperlinkBase()  : string
getKeywords()  : string
Get Keywords.
getLastModifiedBy()  : string
Get Last Modified By.
getManager()  : string
Get Manager.
getModified()  : float|int
Get Modified.
getSubject()  : string
Get Subject.
getTitle()  : string
Get Title.
getViewport()  : string
isCustomPropertySet()  : bool
Check if a Custom Property is defined.
setCategory()  : $this
Set Category.
setCompany()  : $this
Set Company.
setCreated()  : $this
Set Created.
setCreator()  : $this
Set Creator.
setCustomProperty()  : $this
Set a Custom Property.
setDescription()  : $this
Set Description.
setHyperlinkBase()  : self
setKeywords()  : $this
Set Keywords.
setLastModifiedBy()  : $this
Set Last Modified By.
setManager()  : $this
Set Manager.
setModified()  : $this
Set Modified.
setSubject()  : $this
Set Subject.
setTitle()  : $this
Set Title.
setViewport()  : self

Constants

PROPERTY_TYPE_BOOLEAN

constants

public mixed PROPERTY_TYPE_BOOLEAN = 'b'

PROPERTY_TYPE_DATE

public mixed PROPERTY_TYPE_DATE = 'd'

PROPERTY_TYPE_FLOAT

public mixed PROPERTY_TYPE_FLOAT = 'f'

PROPERTY_TYPE_INTEGER

public mixed PROPERTY_TYPE_INTEGER = 'i'

PROPERTY_TYPE_STRING

public mixed PROPERTY_TYPE_STRING = 's'

PROPERTY_TYPE_UNKNOWN

public mixed PROPERTY_TYPE_UNKNOWN = 'u'

SUGGESTED_VIEWPORT

public mixed SUGGESTED_VIEWPORT = 'width=device-width, initial-scale=1'

Methods

__construct()

Create a new Document Properties instance.

public __construct() : mixed

convertProperty()

Convert property to form desired by Excel.

public static convertProperty(bool|int|float|string|null $propertyValue, string $propertyType) : bool|int|float|string|null
Parameters
$propertyValue : bool|int|float|string|null
$propertyType : string
Return values
bool|int|float|string|null

convertPropertyType()

public static convertPropertyType(string $propertyType) : string
Parameters
$propertyType : string
Return values
string

getCategory()

Get Category.

public getCategory() : string
Return values
string

getCompany()

Get Company.

public getCompany() : string
Return values
string

getCreated()

Get Created.

public getCreated() : float|int
Return values
float|int

getCreator()

Get Creator.

public getCreator() : 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) : bool|int|float|string|null
Parameters
$propertyName : string
Return values
bool|int|float|string|null

getDescription()

Get Description.

public getDescription() : string
Return values
string

getHyperlinkBase()

public getHyperlinkBase() : string
Return values
string

getKeywords()

Get Keywords.

public getKeywords() : string
Return values
string

getLastModifiedBy()

Get Last Modified By.

public getLastModifiedBy() : string
Return values
string

getManager()

Get Manager.

public getManager() : string
Return values
string

getModified()

Get Modified.

public getModified() : float|int
Return values
float|int

getSubject()

Get Subject.

public getSubject() : string
Return values
string

getTitle()

Get Title.

public getTitle() : string
Return values
string

getViewport()

public getViewport() : 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 $category) : $this
Parameters
$category : string
Return values
$this

setCompany()

Set Company.

public setCompany(string $company) : $this
Parameters
$company : string
Return values
$this

setCreated()

Set Created.

public setCreated(null|float|int|string $timestamp) : $this
Parameters
$timestamp : null|float|int|string
Return values
$this

setCreator()

Set Creator.

public setCreator(string $creator) : $this
Parameters
$creator : string
Return values
$this

setCustomProperty()

Set a Custom Property.

public setCustomProperty(string $propertyName[, bool|int|float|string|null $propertyValue = '' ][, string|null $propertyType = null ]) : $this
Parameters
$propertyName : string
$propertyValue : bool|int|float|string|null = ''
$propertyType : string|null = null

see self::VALID_PROPERTY_TYPE_LIST

Return values
$this

setDescription()

Set Description.

public setDescription(string $description) : $this
Parameters
$description : string
Return values
$this

setHyperlinkBase()

public setHyperlinkBase(string $hyperlinkBase) : self
Parameters
$hyperlinkBase : string
Return values
self

setKeywords()

Set Keywords.

public setKeywords(string $keywords) : $this
Parameters
$keywords : string
Return values
$this

setLastModifiedBy()

Set Last Modified By.

public setLastModifiedBy(string $modifiedBy) : $this
Parameters
$modifiedBy : string
Return values
$this

setManager()

Set Manager.

public setManager(string $manager) : $this
Parameters
$manager : string
Return values
$this

setModified()

Set Modified.

public setModified(null|float|int|string $timestamp) : $this
Parameters
$timestamp : null|float|int|string
Return values
$this

setSubject()

Set Subject.

public setSubject(string $subject) : $this
Parameters
$subject : string
Return values
$this

setTitle()

Set Title.

public setTitle(string $title) : $this
Parameters
$title : string
Return values
$this

setViewport()

public setViewport(string $viewport) : self
Parameters
$viewport : string
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results