frameright/image-metadata-parser

Image metadata parsing library

1.1.2 2024-04-12 08:50 UTC

Requires

• php: >=5.5
• ext-xml: *

Requires (Dev)

• mockery/mockery: ~1.6
• phpcompatibility/php-compatibility: ^9.3.5
• phpunit/phpunit: ^9.5.25

MIT

• Frameright (Coberg Ltd)
• Aurelien Lourot
• Daniel Chesterton

• metadata
• image
• exif
• xmp
• photo
• IPTC
• Image Display Control
• IDC
• Frameright

README

Image metadata parsing library (PHP 5.5+)

➡️ See this document rendered at docs.frameright.io/php

NOTE: this is based on dchesterton/image. Many thanks to dchesterton!

Supported image types:

• JPEG
• PNG
• WEBP

Supported image meta types:

• XMP
• IPTC
• EXIF

NOTE: a TypeScript equivalent of this library is available here.

Installation

Pull the library in your project via Composer with the following composer.json:

{
  "minimum-stability": "dev",
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/Frameright/php-image-metadata-parser.git"
    }
  ],
  "require": {
    "frameright/image-metadata-parser": "dev-master"
  }
}

Dependencies: php-xml

Usage

  ✨ Getting started

  🔧 Contributing

  📝 Tutorial

  📝 Changelog

Get metadata

$image = Image::fromFile($filename);

$headline = $image->getXmp()->getHeadline();
$camera = $image->getExif()->getCamera();
...

Loading specific image type

When file type is known, you can load the file type directly using the file types' fromFile method.

$jpeg = JPEG::fromFile('image.jpg');
$png = PNG::fromFile('image.png');

Instantiate from bytes

If you don't have a file to work with but you do have the image stored in a string (from database, ImageMagick etc.) you can easily instantiate an object from the string.

$data = ...

$jpeg = JPEG::fromString($data);

Instantiate from GD or a stream

You can also create an object from a GD resource or a stream.

$gd = imagecreate(100, 100);
$jpeg = JPEG::fromResource($gd);

$stream = fopen('...', 'r+');
$jpeg = JPEG::fromStream($stream);

Aggregate metadata

When just want a piece of metadata and don't care whether it's from XMP, IPTC or EXIF, you can use the aggregate meta object.

$image = Image::fromFile($filename);
$headline = $image->getAggregate()->getHeadline();

By default it checks XMP first, then IPTC, then EXIF but you can change the priority:

$aggregate = $image->getAggregate();
$aggregate->setPriority(['exif', 'iptc', 'xmp']);

$aggregate->getHeadline(); // will now check EXIF first, then IPTC, then XMP

You can also exclude a metadata type if you do not want to use it:

$aggregate->setPriority(['iptc', 'xmp']);
$aggregate->getHeadline(); // will only check IPTC and XMP

Get GPS data

$image = ...
$gps = $image->getAggregateMeta()->getGPS(); // checks EXIF and XMP
// or $gps = $image->getExif()->getGPS();

$lat = $gps->getLatitude();