MediaWiki  master
BitmapMetadataHandler Class Reference

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

Public Member Functions

 addMetadata ( $metaArray, $type='other')
 Add misc metadata. More...
 
 getExif ( $filename, $byteOrder)
 Get exif info using exif class. More...
 
 getMetadataArray ()
 Merge together the various types of metadata the different types have different priorites, and are merged in order. More...
 

Static Public Member Functions

static getTiffByteOrder ( $filename)
 Read the first 2 bytes of a tiff file to figure out Little Endian or Big Endian. More...
 
static GIF ( $filename)
 function for gif images. More...
 
static Jpeg ( $filename)
 Main entry point for jpeg's. More...
 
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. More...
 
static Tiff ( $filename)
 This doesn't do much yet, but eventually I plan to add XMP support for Tiff. More...
 

Private Member Functions

 doApp13 ( $app13)
 This does the photoshop image resource app13 block of interest, IPTC-IIM metadata is stored here. More...
 

Private Attributes

string $iptcType = 'iptc-no-hash'
 
array $metadata = []
 
array $metaPriority
 Metadata priority. More...
 

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. @newable
Note
marked as newable in 1.35 for lack of a better alternative, but should become a stateless service, or a handler managed registry for metadata handlers for different file types.

Definition at line 41 of file BitmapMetadataHandler.php.

Member Function Documentation

◆ addMetadata()

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$metaArrayArray of metadata values
string$typeType. defaults to other. if two things have the same type they're merged

Definition at line 110 of file BitmapMetadataHandler.php.

References $type.

Referenced by doApp13(), and getExif().

◆ doApp13()

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$app13String containing app13 block from jpeg file

Definition at line 68 of file BitmapMetadataHandler.php.

References addMetadata(), JpegMetadataExtractor\doPSIR(), IPTC\parse(), and wfDebug().

◆ getExif()

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 93 of file BitmapMetadataHandler.php.

References $wgShowEXIF, and addMetadata().

◆ getMetadataArray()

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 128 of file BitmapMetadataHandler.php.

References $type.

◆ getTiffByteOrder()

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
Returns
string 'BE' or 'LE' or false

Definition at line 303 of file BitmapMetadataHandler.php.

Referenced by Tiff().

◆ GIF()

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$filenameFull path to file
Returns
array Metadata array

Definition at line 237 of file BitmapMetadataHandler.php.

References $type, GIFMetadataExtractor\getMetadata(), and GIFMetadataExtractor\VERSION.

Referenced by GIFHandler\getMetadata().

◆ Jpeg()

static BitmapMetadataHandler::Jpeg (   $filename)
static

Main entry point for jpeg's.

Parameters
string$filenameFilename (with full path)
Returns
array Metadata result array.
Exceptions
MWExceptionOn invalid file.

Definition at line 163 of file BitmapMetadataHandler.php.

References $res, $type, and JpegMetadataExtractor\segmentSplitter().

Referenced by JpegHandler\getMetadata().

◆ PNG()

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$filenameFull path to file
Returns
array Array for storage in img_metadata.

Definition at line 205 of file BitmapMetadataHandler.php.

References $type, PNGMetadataExtractor\getMetadata(), and PNGMetadataExtractor\VERSION.

Referenced by PNGHandler\getMetadata().

◆ Tiff()

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 276 of file BitmapMetadataHandler.php.

References getTiffByteOrder(), and Exif\version().

Referenced by TiffHandler\getMetadata().

Member Data Documentation

◆ $iptcType

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

Definition at line 58 of file BitmapMetadataHandler.php.

◆ $metadata

array BitmapMetadataHandler::$metadata = []
private

Definition at line 43 of file BitmapMetadataHandler.php.

◆ $metaPriority

array BitmapMetadataHandler::$metaPriority
private
Initial value:
= [
20 => [ 'other' ],
40 => [ 'native' ],
60 => [ 'iptc-good-hash', 'iptc-no-hash' ],
70 => [ 'xmp-deprecated' ],
80 => [ 'xmp-general' ],
90 => [ 'xmp-exif' ],
100 => [ 'iptc-bad-hash' ],
120 => [ 'exif' ],
]

Metadata priority.

Definition at line 46 of file BitmapMetadataHandler.php.


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