/craft-assetmetadata

Extracts and stores metadata from your assets.

Primary LanguagePHP

Asset Metadata plugin for Craft

Asset Metadata

The plugin provides a configurable field type to extract and store metadata from an asset on element save into subfields. The subfields are user editable, so it's possible to complete missing data or correct values to your own requirements.

Installation

To install the plugin, copy the assetmetadata/ folder into craft/plugins/. Then go to Settings → Plugins and click the "Install" button next to "Asset Metadata".

Data Structure

When you access the "metadata" variable from the field type or directly use the plugin's getAssetMetadata function in the template, you are dealing with data returned from getID3 by James Heinrich. The complete data structure is documented in its repository on GitHub.

Asset Metadata Field Type

The field type consists of a group of subfields to hold asset metadata. You can attach an Asset Metadata field to an asset source, and it will be available to any assets within that source.

The field gets popoluted with metadata right after uploading the asset and can then be reviewed and edited.

(It's also possible to add a Asset Metadata field to an element that doesn't directly hold an asset. See Metadata Variable settings on how to configure the setup.)

Settings

Metadata Properties

Define the metadata properties that will be available as "sub-fields" to your Assets Metadata field.

  • Name – The name that is displayed in the CP
  • Handle – How you'll refer to this "sub-field" from your templates
  • Default Value – The value that is saved for this property

Default Value is a full Twig template that will be parsed when you save the element the field is attached to. You can access the asset's metadata via a "metadata" variable and the element itself is accessible via an "object" variable.

Example:

{{ metadata.playtime_string is defined ? metadata.playtime_string : '--' }}

More example code to access common metadata properties.

Metadata Variable

By default the field gets the metadata from the asset the field is added to and makes a variable "metadata" available for use in the Default Values configuration column.

If the field is used with another element type, you need to manually set a "metadata" variable. Use the plugin's getAssetMetadata function and pass in the asset model you want to get the data from. Here's how you would get the data from an assets field “myImages”.

{% set metadata = getAssetMetadata(object.myImages.first()) %}

Templating

You can access metadata properties from a Asset Metadata field using the "sub-field" handles:

{{ asset.metadata.playtime }}

Twig function

getAssetMetadata( asset, property )

Returns metadata for an asset. Please consider caching the function together with its output to save resources. Or use the Asset Metadata field type instead.

{% set metadata = getAssetMetadata(asset, 'jpg.exif') %}

<span>{{ metadata.EXIF.FocalLengthIn35mmFilm ~ ' mm' }}</span>
<span>{{ 'f/' ~ metadata.EXIF.FNumber }}</span>

Parameters

asset : The asset model to parse.

property (optional) : String in dot notation that sets the root metadata property (Default value is null).

Twig filters

formatExifGpsCoordinates( gpsSecDecimals, gpsSecDecPoint )

Converts an EXIF GPS point location into sexagesimal format (ISO 6709).

Parameters

gpsSecDecimals (optional) : Number of digits after the decimal point for the seconds value (Default value is 0).

gpsSecDecPoint (optional) : The character used as the decimal point (Default value is .).

formatExifDate

Converts an EXIF date value into a DateTime object.

Planned features

  • Support for remote asset sources.