interface ExifTagMapperInterface in File metadata manager 8.2
Same name and namespace in other branches
- 8 file_mdm_exif/src/ExifTagMapperInterface.php \Drupal\file_mdm_exif\ExifTagMapperInterface
Provides an interface for EXIF metadata ifds and tags mapper.
Hierarchy
- interface \Drupal\file_mdm_exif\ExifTagMapperInterface
Expanded class hierarchy of ExifTagMapperInterface
All classes that implement ExifTagMapperInterface
1 file declares its use of ExifTagMapperInterface
File
- file_mdm_exif/
src/ ExifTagMapperInterface.php, line 8
Namespace
Drupal\file_mdm_exifView source
interface ExifTagMapperInterface {
/**
* Resolves a metadata 'key' to the default EXIF IFD and TAG.
*
* @param string|array $key
* A metadata 'key' as passed in by the file metadata manager. It can be a
* string, in which case the default IFD and TAG are returned. If it is an
* array, then the first and the second array elements define respectively
* the IFD and the TAG requested. IFD and TAG can be strings, in which case
* they are converted to EXIF integer identifiers, or integers, in which
* case they are returned as such.
*
* @return array
* An associative array with the following keys:
* 'ifd' - the IFD EXIF integer identifier.
* 'tag' - the TAG EXIF integer identifier.
*
* @throws \Drupal\file_mdm\FileMetadataException
* When wrong argument is passed, or if the IFD/TAG could not be found.
*/
public function resolveKeyToIfdAndTag($key);
/**
* Returns a list of default metadata 'keys' supported.
*
* @param array $options
* (optional) If specified, restricts the results returned. By default, all
* the available EXIF IFD/TAG combinations for any IFD are returned.
* If $options contains ['ifds' => TRUE], the supported IFDs are returned.
* If $options contains ['ifd' => $value], the IFD/TAG combinations
* supported by the IFD specified by $value are returned.
*
* @return array
* A simple array.
* When returning a list of supported IFDs, each array element is a simple
* array with:
* 0 => the default string identifier of the IFD.
* 1 => the integer identifier of the IFD.
* When returning a list of supported IFD/TAGs, each array element is a
* simple array with:
* 0 => the string identifier of the IFD.
* 1 => the string identifier of the TAG.
*/
public function getSupportedKeys(array $options = NULL);
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ExifTagMapperInterface:: |
public | function | Returns a list of default metadata 'keys' supported. | 1 |
ExifTagMapperInterface:: |
public | function | Resolves a metadata 'key' to the default EXIF IFD and TAG. | 1 |