Contentserv PHP API

CSOfficeXmlFileMetaData extends CSFileMetaData
in package

Tags

Table of Contents

APP_XML  = 'app.xml'
ATTRIBUTE_CONTENT_TYPE  = 'ContentType'
ATTRIBUTE_CONTENT_TYPE_VALUE  = 'application/vnd.openxmlformats-officedocument.custom-properties+xml'
ATTRIBUTE_FMT_ID_VALUE  = '{D5CDD505-2E9C-101B-9397-08002B2CF9AE}'
ATTRIBUTE_FMTID  = 'fmtid'
ATTRIBUTE_ID  = 'Id'
ATTRIBUTE_NAME  = 'name'
ATTRIBUTE_OVERRIDE  = 'Override'
ATTRIBUTE_PART_NAME  = 'PartName'
ATTRIBUTE_PID  = 'pid'
ATTRIBUTE_RELATIONSHIP  = 'Relationship'
ATTRIBUTE_RELS_TYPE_VALUE  = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties'
ATTRIBUTE_RID  = 'rId'
ATTRIBUTE_TARGET  = 'Target'
ATTRIBUTE_TYPE  = 'Type'
ATTRIBUTE_VALUE_FALSE  = 'false'
ATTRIBUTE_VALUE_TRUE  = 'true'
CONTENT_TYPES_XML  = '[Content_Types].xml'
CORE_XML  = 'core.xml'
CUSTOM_DATATYPE_BOOL  = 'Bool'
CUSTOM_DATATYPE_FLOAT  = 'Float'
CUSTOM_DATATYPE_INT  = 'Int'
CUSTOM_DATATYPE_TEXT  = 'Text'
CUSTOM_DATATYPE_TIME  = 'Time'
CUSTOM_XML  = 'custom.xml'
DOCPROPS_DIR  = 'docProps/'
META_DATA_EXIF  = 8
META_DATA_IPTC  = 32
META_DATA_MODULE  = 2
META_DATA_PLUGIN  = 1
META_DATA_WIDGET  = 4
META_DATA_XML  = 64
META_DATA_XMP  = 16
OUTPUT_MESSAGE  = 'Message'
OUTPUT_RESULT  = 'Result'
Defines the keys of the result output.
OUTPUT_TYPE  = 'Type'
RELS_DIR  = '_rels/'
RELS_XML  = '.rels'
TEMPLATE_CUSTOM_XML_FILE  = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties" xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"/>'
XML_DATE_TIME_FORMAT  = 'Y-m-d\TH:i:s\Z'
XML_ELEMENT_COREPROPERTIES  = 'coreProperties'
XML_ELEMENT_PROPERTIES  = 'Properties'
XML_ELEMENT_PROPERTY  = 'property'
addData()  : mixed
Adds the metadata.
getClass()  : CSFileMetaData
Returns the current classname of the class.
getData()  : array<string|int, mixed>
Returns the metadata for the provided keys. If passed null, returns all the metadata
getFile()  : CSMamFile|Mamfile
Returns CSMamFile
getInstance()  : static
Get self instance
getSupportedTypeNames()  : array<string|int, mixed>
Returns suported metadata type names
getType()  : int
Returns the metadata type from defined constants
isSupportedType()  : int
Checks whether the type is supported or not using bitwise operator
removeData()  : mixed
Removes the metadata
resetData()  : mixed
Resets or deletes the complete metadata
setData()  : mixed
Sets the metadata.
setFile()  : mixed
Sets the CSMamFile

Constants

ATTRIBUTE_CONTENT_TYPE_VALUE

public mixed ATTRIBUTE_CONTENT_TYPE_VALUE = 'application/vnd.openxmlformats-officedocument.custom-properties+xml'
Tags

ATTRIBUTE_FMT_ID_VALUE

public mixed ATTRIBUTE_FMT_ID_VALUE = '{D5CDD505-2E9C-101B-9397-08002B2CF9AE}'
Tags

ATTRIBUTE_RELS_TYPE_VALUE

public mixed ATTRIBUTE_RELS_TYPE_VALUE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties'
Tags

META_DATA_EXIF

public mixed META_DATA_EXIF = 8
Tags

META_DATA_IPTC

public mixed META_DATA_IPTC = 32
Tags

META_DATA_MODULE

public mixed META_DATA_MODULE = 2
Tags

META_DATA_PLUGIN

public mixed META_DATA_PLUGIN = 1
Tags

META_DATA_WIDGET

public mixed META_DATA_WIDGET = 4
Tags

META_DATA_XML

public mixed META_DATA_XML = 64
Tags

META_DATA_XMP

public mixed META_DATA_XMP = 16
Tags

OUTPUT_RESULT

Defines the keys of the result output.

public string OUTPUT_RESULT = 'Result'
Tags

TEMPLATE_CUSTOM_XML_FILE

public mixed TEMPLATE_CUSTOM_XML_FILE = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties" xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"/>'
Tags

Methods

addData()

Adds the metadata.

public final addData(array<string|int, mixed> $aData) : mixed
Parameters
$aData : array<string|int, mixed>

Array of metadata properties with its values

Tags
Return values
mixed

getData()

Returns the metadata for the provided keys. If passed null, returns all the metadata

public final getData([array<string|int, mixed>|null $aKeys = null ]) : array<string|int, mixed>
Parameters
$aKeys : array<string|int, mixed>|null = null

array of keys

Tags
throws
CSMetaDataException
Return values
array<string|int, mixed>

of metadata values for provided keys

getInstance()

Get self instance

public final static getInstance(int $sMetaDataType) : static
Parameters
$sMetaDataType : int
Tags
Return values
static

getType()

Returns the metadata type from defined constants

public final getType() : int
Tags
Return values
int

isSupportedType()

Checks whether the type is supported or not using bitwise operator

public final isSupportedType(int $iType) : int
Parameters
$iType : int

integer for the respective type define above in constants

Tags
Return values
int

Returns 0 if not supported

removeData()

Removes the metadata

public final removeData(array<string|int, mixed> $aKeys) : mixed
Parameters
$aKeys : array<string|int, mixed>

array of properties that needs to be removed

Tags
Return values
mixed

resetData()

Resets or deletes the complete metadata

public final resetData() : mixed
Tags
Return values
mixed

setData()

Sets the metadata.

public final setData(array<string|int, mixed> $aData) : mixed
Parameters
$aData : array<string|int, mixed>

Array of metadata properties with its values

Tags
Return values
mixed

        

Search results