Contentserv PHP API

CSMetaData
in package

Tags

Table of Contents

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
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
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.

Constants

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

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 —

getSupportedTypeNames()

Returns suported metadata type names

public static getSupportedTypeNames() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

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