Class to deal with reconciling and extracting metadata from bitmap images. More...

Collaboration diagram for BitmapMetadataHandler:

Public Member Functions
	addMetadata ($metaArray, $type= 'other')
	Add misc metadata.
	getExif ($filename, $byteOrder)
	Get exif info using exif class.
	getMetadataArray ()
	Merge together the various types of metadata the different types have different priorites, and are merged in order.
Static Public Member Functions
static	getTiffByteOrder ($filename)
	Read the first 2 bytes of a tiff file to figure out Little Endian or Big Endian.
static	GIF ($filename)
	function for gif images.
static	Jpeg ($filename)
	Main entry point for jpeg's.
static	PNG ($filename)
	Entry point for png At some point in the future this might merge the png various tEXt chunks to that are interesting, but for now it only does XMP.
static	Tiff ($filename)
	This doesn't do much yet, but eventually I plan to add XMP support for Tiff.
Private Member Functions
	doApp13 ($app13)
	This does the photoshop image resource app13 block of interest, IPTC-IIM metadata is stored here.
Private Attributes
string	$iptcType = 'iptc-no-hash'
	*
array	$metadata = array()
	*
array	$metaPriority
	Metadata priority *.

Detailed Description

Class to deal with reconciling and extracting metadata from bitmap images.

This is meant to comply with http://www.metadataworkinggroup.org/pdf/mwg_guidance.pdf

This sort of acts as an intermediary between MediaHandler::getMetadata and the various metadata extractors.

Todo:: Other image formats.

Definition at line 34 of file BitmapMetadataHandler.php.

Member Function Documentation

BitmapMetadataHandler::addMetadata	(	$	metaArray,
		$	type = `'other'`
	)

Add misc metadata.

Warning: atm if the metadata category doesn't have a priority, it will be silently discarded.

Parameters:

array	$metaArray	Array of metadata values
string	$type	Type. defaults to other. if two things have the same type they're merged

Definition at line 100 of file BitmapMetadataHandler.php.

BitmapMetadataHandler::doApp13 ( $ app13 ) [private]

This does the photoshop image resource app13 block of interest, IPTC-IIM metadata is stored here.

Mostly just calls doPSIR and doIPTC

Parameters:

string $app13 String containing app13 block from jpeg file

Definition at line 58 of file BitmapMetadataHandler.php.

BitmapMetadataHandler::getExif	(	$	filename,
		$	byteOrder
	)

Get exif info using exif class.

Basically what used to be in BitmapHandler::getMetadata(). Just calls stuff in the Exif class.

Parameters are passed to the Exif class.

Parameters:

string	$filename
string	$byteOrder

Definition at line 83 of file BitmapMetadataHandler.php.

BitmapMetadataHandler::getMetadataArray ( )

Merge together the various types of metadata the different types have different priorites, and are merged in order.

This function is generally called by the media handlers' getMetadata()

Returns:: array Metadata array

Definition at line 118 of file BitmapMetadataHandler.php.

static BitmapMetadataHandler::getTiffByteOrder ( $ filename ) [static]

Read the first 2 bytes of a tiff file to figure out Little Endian or Big Endian.

Needed for exif stuff.

Parameters:

string $filename The filename

Returns:: string 'BE' or 'LE' or false

Definition at line 294 of file BitmapMetadataHandler.php.

static BitmapMetadataHandler::GIF ( $ filename ) [static]

function for gif images.

They don't really have native metadata, so just merges together XMP and image comment.

Parameters:

string $filename Full path to file

Returns:: array Metadata array

Definition at line 227 of file BitmapMetadataHandler.php.

Referenced by GIFHandler\getMetadata().

static BitmapMetadataHandler::Jpeg ( $ filename ) [static]

Main entry point for jpeg's.

Parameters:

string $filename Filename (with full path)

Returns:: array Metadata result array.

Exceptions:

MWException On invalid file.

Definition at line 153 of file BitmapMetadataHandler.php.

Referenced by JpegHandler\getMetadata(), BitmapMetadataHandlerTest\testBadIPTC(), BitmapMetadataHandlerTest\testIPTCDates(), BitmapMetadataHandlerTest\testIPTCDatesInvalid(), BitmapMetadataHandlerTest\testJpegComment(), and BitmapMetadataHandlerTest\testMultilingualCascade().

static BitmapMetadataHandler::PNG ( $ filename ) [static]

Entry point for png At some point in the future this might merge the png various tEXt chunks to that are interesting, but for now it only does XMP.

Parameters:

string $filename Full path to file

Returns:: array Array for storage in img_metadata.

Definition at line 195 of file BitmapMetadataHandler.php.

Referenced by PNGHandler\getMetadata().

static BitmapMetadataHandler::Tiff ( $ filename ) [static]

This doesn't do much yet, but eventually I plan to add XMP support for Tiff.

(PHP's exif support already extracts but needs some further processing because PHP's exif support is stupid...)

Todo:: Add XMP support, so this function actually makes sense to put here.

The various exceptions this throws are caught later.

Parameters:

string $filename

Exceptions:

MWException

Returns:: array The metadata.

Definition at line 267 of file BitmapMetadataHandler.php.

Referenced by TiffHandler\getMetadata().

Member Data Documentation

string BitmapMetadataHandler::$iptcType = 'iptc-no-hash' [private]

*

Definition at line 48 of file BitmapMetadataHandler.php.

array BitmapMetadataHandler::$metadata = array() [private]

*

Definition at line 35 of file BitmapMetadataHandler.php.

array BitmapMetadataHandler::$metaPriority [private]

Initial value:

 array(
        20 => array( 'other' ),
        40 => array( 'native' ),
        60 => array( 'iptc-good-hash', 'iptc-no-hash' ),
        70 => array( 'xmp-deprecated' ),
        80 => array( 'xmp-general' ),
        90 => array( 'xmp-exif' ),
        100 => array( 'iptc-bad-hash' ),
        120 => array( 'exif' ),
    )

Metadata priority *.

Definition at line 37 of file BitmapMetadataHandler.php.

The documentation for this class was generated from the following file:

includes/media/BitmapMetadataHandler.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation