[ class tree: core ] [ index: core ] [ all elements ]

Class: Image_XMP

Source Location: /zp-extensions/class-video/getid3/module.tag.xmp.php

Class Image_XMP

Class Overview

************************************************************************************************ SWISScenter Source Nigel Barnes

Provides functions for reading information from the 'APP1' Extensible Metadata Platform (XMP) segment of JPEG format files. This XMP segment is XML based and contains the Resource Description Framework (RDF) data, which itself can contain the Dublin Core Metadata Initiative (DCMI) information.

This code uses segments from the JPEG Metadata Toolkit project by Evan Hunter. ***********************************************************************************************

Located in /zp-extensions/class-video/getid3/module.tag.xmp.php [line 33]



		
		
		
		

Properties

Methods

[ Top ]
Property Summary
array   $_aXMP  
boolean   $_bXMPParse  
string   $_sFilename  

[ Top ]
Method Summary
Image_XMP   Image_XMP()   Constructor
array   getAllTags()   Get a copy of all XMP tags extracted from the image
boolean   isValid()   Returns the status of XMP parsing during instantiation
array   read_XMP_array_from_text()   Parses a string containing XMP data (XML), and returns an array which contains all the XMP (XML) information.
array   _get_jpeg_header_data()   Reads all the JPEG header segments from an JPEG image file into an array
string   _get_XMP_text()   Retrieves XMP information from an APP1 JPEG segment and returns the raw XML text as a string.

[ Top ]
Properties
array   $_aXMP = array() [line 47]
API Tags:
See:  Image_XMP::getAllTags()


[ Top ]
boolean   $_bXMPParse = false [line 54]
API Tags:
See:  Image_XMP::isValid()


[ Top ]
string   $_sFilename = null [line 40]
API Tags:
See:  Image_XMP::Image_XMP()


[ Top ]
Methods
Constructor Image_XMP  [line 399]

  Image_XMP Image_XMP( string $sFilename  )

Constructor

Parameters:
string   $sFilename:  - Name of the image file to access and extract XMP information from.


[ Top ]
getAllTags  [line 74]

  array getAllTags( )

Get a copy of all XMP tags extracted from the image


API Tags:
Return:  - An array of XMP fields as it extracted by the XMPparse() function


[ Top ]
isValid  [line 64]

  boolean isValid( )

Returns the status of XMP parsing during instantiation

You'll normally want to call this method before trying to get XMP fields.


API Tags:
Return:  Returns true if an APP1 segment was found to contain XMP metadata.


[ Top ]
read_XMP_array_from_text  [line 229]

  array read_XMP_array_from_text( $xmltext, string $xml_text  )

Parses a string containing XMP data (XML), and returns an array which contains all the XMP (XML) information.

Parameters:
string   $xml_text:  - a string containing the XMP data (XML) to be parsed
   $xmltext: 

API Tags:
Return:  - an array containing all xmp details retrieved.


[ Top ]
_get_jpeg_header_data  [line 86]

  array _get_jpeg_header_data( string $filename  )

Reads all the JPEG header segments from an JPEG image file into an array

Parameters:
string   $filename:  - the filename of the JPEG file to read

API Tags:
Return:  - Array of JPEG header segments


[ Top ]
_get_XMP_text  [line 196]

  string _get_XMP_text( string $filename  )

Retrieves XMP information from an APP1 JPEG segment and returns the raw XML text as a string.

Parameters:
string   $filename:  - the filename of the JPEG file to read

API Tags:
Return:  - the string of raw XML text


[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:07:49 +0100 by phpDocumentor 1.4.3