Xmp PHP Extension Reference Documentation

CkXmp

Current Version: 11.0.0

Chilkat XMP is a software component (SDK, toolkit, library, etc) for accessing, manipulating, and adding XMP metadata to JPEG and TIFF files.

Object Creation

$obj = new CkXmp();

Properties

DebugLogFilePath
string debugLogFilePath();
void put_DebugLogFilePath(string strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
LastErrorHtml
(read-only)
string lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
(read-only)
string lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
(read-only)
string lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
NumEmbedded
(read-only)
int get_NumEmbedded()

The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.

top
StructInnerDescrip
bool get_StructInnerDescrip()
void put_StructInnerDescrip(bool boolVal);

Determines whether structures are stored with rdf:parseType="Resource", or within an "rdf:Description" sub-node.

top
UncommonOptions
string uncommonOptions();
void put_UncommonOptions(string strVal);
Introduced in version 9.5.0.80

A property to be used for future uncommon needs. The default value is the empty string.

top
VerboseLogging
bool get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
(read-only)
string version();

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

AddArray
bool AddArray(CkXml $xml, string $arrType, string $propName, CkStringArray $values);

Adds or replaces an XMP property array. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The 2nd argument specifies the array type, which can be "bag", "seq", or "alt". The property name should be prefixed with the namespace, such as "dc:subject".

More Information and Examples
top
AddNsMapping
void AddNsMapping(string $ns, string $uri);

Adds a namespace to URI mapping. When a property is added via AddSimpleString or any of the other methods, the property name is namespace qualified. When adding the first property in a namespace, the rdf:Description is automatically added and the URI is obtained from the namespace-to-URI mappings. The standard (and commonly used) namespace mappings are defined by default. This is only used if the namespace is custom or not already handled.

top
AddSimpleInt
bool AddSimpleInt(CkXml $iXml, string $propName, int $propVal);

Adds or updates an XMP integer property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as "tiff:XResolution".

top
AddSimpleStr
bool AddSimpleStr(CkXml $iXml, string $propName, string $propVal);

Adds or updates a simple XMP string property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as "photoshop:Credit".

top
AddStructProp
bool AddStructProp(CkXml $iChilkatXml, string $structName, string $propName, string $propValue);

Adds or updates an XMP structured property value. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The structure name should be prefixed with the namespace, such as "Iptc4xmpCore:CreatorContactInfo". The property name within the structure should also be prefixed with the namespace, such as "Iptc4xmpCore:CiAdrCity".

top
Append
bool Append(CkXml $iXml);

Appends a new XMP metadata file to the XMP object. Any XMPs appended via this method will be present in the file when SaveAppFile is called. Files containing XMP metadata typically only include a single XMP document, so this method is usually only called when adding XMP metadata to a file for the first time.

top
GetArray
CkStringArray GetArray(CkXml $iXml, string $propName);

Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as "dc:subject".

Returns null on failure

top
GetEmbedded
CkXml GetEmbedded(int $index);

Returns the Nth embedded XMP document as a Chilkat XML object.

Returns null on failure

More Information and Examples
top
GetProperty
CkXml GetProperty(CkXml $iXml, string $propName);

To be documented soon...

Returns null on failure

top
GetSimpleInt
int GetSimpleInt(CkXml $iXml, string $propName);

Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as "tiff:ResolutionUnit".

top
GetSimpleStr
bool GetSimpleStr(CkXml $iXml, string $propName, CkString outStr);
string getSimpleStr(CkXml iXml, string propName);

Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as "photoshop:Source".

Returns true for success, false for failure.

More Information and Examples
top
GetStructPropNames
CkStringArray GetStructPropNames(CkXml $iXml, string $structName);

Returns the property names used by an exsting structure within an XMP document. The contents of the structure can be retrieved by calling GetStructValue for each property name returned by GetStructPropNames.

Returns null on failure

top
GetStructValue
bool GetStructValue(CkXml $iXml, string $structName, string $propName, CkString outStr);
string getStructValue(CkXml iXml, string structName, string propName);

Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.

Returns true for success, false for failure.

More Information and Examples
top
LoadAppFile
bool LoadAppFile(string $filename);

Loads a TIFF or JPG file into the XMP object.

top
LoadFromBuffer Deprecated
bool LoadFromBuffer(CkByteData $fileData, string $ext);

Loads a JPG or TIFF from an byte buffer containing the image file data.

top
NewXmp
CkXml NewXmp();

Creates and returns a new/empty XMP metadata document as a Chilkat XML object.

Returns null on failure

More Information and Examples
top
RemoveAllEmbedded
bool RemoveAllEmbedded();

Removes all XMP metadata documents from an XMP object. After calling this method, call SaveAppFile to rewrite the JPG or TIFF file with the XMP metadata removed.

Returns true for success, false for failure.

top
RemoveArray
bool RemoveArray(CkXml $iXml, string $propName);

Removes an XMP array property from the XMP document.

top
RemoveEmbedded
bool RemoveEmbedded(int $index);

Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.

Returns true for success, false for failure.

top
RemoveNsMapping
void RemoveNsMapping(string $ns);

Removes a namespace-to-URI mapping.

top
RemoveSimple
bool RemoveSimple(CkXml $iXml, string $propName);

Removes a simple XMP property from the XMP document.

top
RemoveStruct
bool RemoveStruct(CkXml $iXml, string $structName);

Removes an XMP structure property from the XMP document.

top
RemoveStructProp
bool RemoveStructProp(CkXml $iXml, string $structName, string $propName);

Removes a single member from an XMP structured property.

top
SaveAppFile
bool SaveAppFile(string $filename);

Persists all changes made to the XMP document(s) by saving the XMP object to a file. Changes made by adding, updating, or removing properties are not persisted to the filesystem until this is called.

top
SaveToBuffer Deprecated
bool SaveToBuffer(CkByteData outBytes);

Saves a JPG or TIFF image with updated XMP to a byte buffer.

Returns true for success, false for failure.

top