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

Procedural File: xmpMetadata.php

Source Location: /zp-extensions/xmpMetadata.php

Page Details

Enable this filter to scan images (or xmp sidecar files) for metadata.

Relevant metadata found will be incorporated into the image (or album object) see “Adobe XMP Specification" http://www.aiim.org/documents/standards/xmpspecification.pdf for xmp metadata description. This plugin attempts to map the xmp metadata to IPTC fields

If a sidecar file exists, it will take precedence (the image file will not be examined.) The sidecar file should reside in the same folder, have the same prefix name as the image (album), and the suffix ".xmp". Thus, the sidecar for <image>.jpg would be named <image>.xmp.

NOTE: dynamic albums have an ".alb" suffix. Append ".xmp" to that name so that the dynamic album sidecar would be named <album>.alb.xmp

There is one option for this plugin--to enable searching within the actual image file for an xmp block. This is disabled by default scanning image files can add considerably to the processing time.

All functions within this plugin are for internal use. The plugin does not present any theme interface.

Author:  Stephen Billard (sbillard)
Classes
Class Description
xmpMetadata_options Plugin option handling class
Includes
require_once (dirname(dirname(__FILE__)).'/exif/exif.php') [line 47]
[ Top ]


Constants
XMP_EXTENSION  [line 105]

XMP_EXTENSION = strtolower(getOption('xmpMetadata_suffix'))

[ Top ]


Functions
extractXMP  [line 296]

Finds and returns xmp metadata

Parameters:
int   $j: 
   $f: 


string extractXMP( $f, int $j  )

[ Top ]
rationalNum  [line 317]

convert a fractional representation to something more user friendly

Parameters:
$element   $element:  string


string rationalNum( $element $element  )

[ Top ]
xmpMetadataBulkActions  [line 569]
Parameters:
   $actions: 


void xmpMetadataBulkActions( $actions  )

[ Top ]
xmpMetadataCreate  [line 563]
Parameters:
   $html: 
   $object: 
   $prefix: 


void xmpMetadataCreate( $html, $object, $prefix  )

[ Top ]
xmpMetadataPublish  [line 463]
Parameters:
   $object: 


void xmpMetadataPublish( $object  )

[ Top ]
xmpMetadataPut  [line 456]
Parameters:
   $object: 
   $prefix: 


void xmpMetadataPut( $object, $prefix  )

[ Top ]
xmpMetadata_album_instantiate  [line 230]

Filter called when an album object is instantiated sets the sidecars to include xmp files

Parameters:
$album   $album:  album object


$object xmpMetadata_album_instantiate( $album $album  )

[ Top ]
xmpMetadata_extract  [line 113]

Parses xmp metadata for interesting tags

Parameters:
string   $xmpdata: 


array xmpMetadata_extract( string $xmpdata  )

[ Top ]
xmpMetadata_image_instantiate  [line 328]
Parameters:
   $image: 


void xmpMetadata_image_instantiate( $image  )

[ Top ]
xmpMetadata_new_album  [line 241]

Filter for handling album objects

Parameters:
object   $album: 


object xmpMetadata_new_album( object $album  )

[ Top ]
xmpMetadata_new_image  [line 339]

Filter for handling image objects

Parameters:
object   $image: 


object xmpMetadata_new_image( object $image  )

[ Top ]
xmpMetadata_sidecars  [line 451]
Parameters:
   $types: 


void xmpMetadata_sidecars( $types  )

[ Top ]
xmpMetadata_to_string  [line 216]

insures that the metadata is a string

Parameters:
mixed   $meta: 


string xmpMetadata_to_string( mixed $meta  )

[ Top ]


Documentation generated on Tue, 20 Dec 2011 16:08:22 +0100 by phpDocumentor 1.4.3