DocInfo
Document information
Table of Contents
- PROPERTY_TYPE_BOOLEAN = 'b'
- PROPERTY_TYPE_DATE = 'd'
- PROPERTY_TYPE_FLOAT = 'f'
- PROPERTY_TYPE_INTEGER = 'i'
- PROPERTY_TYPE_STRING = 's'
- PROPERTY_TYPE_UNKNOWN = 'u'
- $category : string
- Category
- $company : string
- Company
- $created : int
- Created
- $creator : string
- Creator
- $customProperties : array<string|int, mixed>
- Custom Properties
- $description : string
- Description
- $keywords : string
- Keywords
- $lastModifiedBy : string
- LastModifiedBy
- $manager : string
- Manager
- $modified : int
- Modified
- $subject : string
- Subject
- $title : string
- Title
- __construct() : mixed
- Create new instance
- convertProperty() : mixed
- Convert document property based on type
- convertPropertyType() : string
- Convert document property type
- getCategory() : string
- Get Category
- getCompany() : string
- Get Company
- getCreated() : int
- Get Created
- getCreator() : string
- Get Creator
- getCustomProperties() : array<string|int, mixed>
- Get a List of Custom Property Names
- getCustomPropertyType() : string
- Get a Custom Property Type
- getCustomPropertyValue() : mixed
- Get a Custom Property Value
- getDescription() : string
- Get Description
- getKeywords() : string
- Get Keywords
- getLastModifiedBy() : string
- Get Last Modified By
- getManager() : string
- Get Manager
- getModified() : int
- Get Modified
- getSubject() : string
- Get Subject
- getTitle() : string
- Get Title
- isCustomPropertySet() : bool
- Check if a Custom Property is defined
- setCategory() : self
- Set Category
- setCompany() : self
- Set Company
- setCreated() : self
- Set Created
- setCreator() : self
- Set Creator
- setCustomProperty() : self
- Set a Custom Property
- setDescription() : self
- Set Description
- setKeywords() : self
- Set Keywords
- setLastModifiedBy() : self
- Set Last Modified By
- setManager() : self
- Set Manager
- setModified() : self
- Set Modified
- setSubject() : self
- Set Subject
- setTitle() : self
- Set Title
- getConversion() : string
- Get conversion model depending on property type
- setValue() : mixed
- Set default for null and empty value
Constants
PROPERTY_TYPE_BOOLEAN
public
mixed
PROPERTY_TYPE_BOOLEAN
= 'b'
Tags
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'
Properties
$category
Category
private
string
$category
$company
Company
private
string
$company
$created
Created
private
int
$created
$creator
Creator
private
string
$creator
$customProperties
Custom Properties
private
array<string|int, mixed>
$customProperties
= array()
$description
Description
private
string
$description
$keywords
Keywords
private
string
$keywords
$lastModifiedBy
LastModifiedBy
private
string
$lastModifiedBy
$manager
Manager
private
string
$manager
$modified
Modified
private
int
$modified
$subject
Subject
private
string
$subject
$title
Title
private
string
$title
Methods
__construct()
Create new instance
public
__construct() : mixed
Return values
mixed —convertProperty()
Convert document property based on type
public
static convertProperty(string $propertyValue, string $propertyType) : mixed
Parameters
- $propertyValue : string
- $propertyType : string
Return values
mixed —convertPropertyType()
Convert document property type
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() : int
Return values
int —getCreator()
Get Creator
public
getCreator() : string
Return values
string —getCustomProperties()
Get a List of Custom Property Names
public
getCustomProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —of string
getCustomPropertyType()
Get a Custom Property Type
public
getCustomPropertyType(string $propertyName) : string
Parameters
- $propertyName : string
Return values
string —getCustomPropertyValue()
Get a Custom Property Value
public
getCustomPropertyValue(string $propertyName) : mixed
Parameters
- $propertyName : string
Return values
mixed —getDescription()
Get Description
public
getDescription() : 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() : int
Return values
int —getSubject()
Get Subject
public
getSubject() : string
Return values
string —getTitle()
Get Title
public
getTitle() : 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 $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —setCompany()
Set Company
public
setCompany([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —setCreated()
Set Created
public
setCreated([int $value = null ]) : self
Parameters
- $value : int = null
Return values
self —setCreator()
Set Creator
public
setCreator([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —setCustomProperty()
Set a Custom Property
public
setCustomProperty(string $propertyName[, mixed $propertyValue = '' ][, string $propertyType = null ]) : self
Parameters
- $propertyName : string
- $propertyValue : mixed = ''
- $propertyType : string = null
-
'i': Integer 'f': Floating Point 's': String 'd': Date/Time 'b': Boolean
Return values
self —setDescription()
Set Description
public
setDescription([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —setKeywords()
Set Keywords
public
setKeywords([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —setLastModifiedBy()
Set Last Modified By
public
setLastModifiedBy([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —setManager()
Set Manager
public
setManager([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —setModified()
Set Modified
public
setModified([int $value = null ]) : self
Parameters
- $value : int = null
Return values
self —setSubject()
Set Subject
public
setSubject([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —setTitle()
Set Title
public
setTitle([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
self —getConversion()
Get conversion model depending on property type
private
static getConversion(string $propertyType) : string
Parameters
- $propertyType : string
Return values
string —setValue()
Set default for null and empty value
private
setValue(mixed $value, mixed $default) : mixed
Parameters
- $value : mixed
- $default : mixed