Format Image metadata values into a human readable form. More...

Inheritance diagram for FormatMetadata:

[legend]

Collaboration diagram for FormatMetadata:

[legend]

Public Member Functions
	collapseContactInfo (array $vals)
	Format the contact info field into a single value.

	fetchExtendedMetadata (File $file)
	Get an array of extended metadata.

	flattenArrayReal ( $vals, $type='ul', $noHtml=false)
	A function to collapse multivalued tags into a single value.

	makeFormattedData ( $tags)
	Numbers given by Exif user agents are often magical, that is they should be replaced by a detailed explanation depending on their value which most of the time are plain integers.

	setSingleLanguage ( $val)
	Trigger only outputting single language for multilanguage fields.

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getActionName ()
	Get the action name for the current web request.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Static Public Member Functions
static	flattenArrayContentLang ( $vals, $type='ul', $noHtml=false, $context=false)
	Flatten an array, using the content language for any messages.

static	getFormattedData ( $tags, $context=false)
	Numbers given by Exif user agents are often magical, that is they should be replaced by a detailed explanation depending on their value which most of the time are plain integers.

static	getVisibleFields ()
	Get a list of fields that are visible by default.

Protected Member Functions
	discardMultipleValues (&$metadata)
	Takes an array returned by the getExtendedMetadata* functions, and turns all fields into single-valued ones by dropping extra values.

	getExtendedMetadataFromFile (File $file)
	Get file-based metadata in standardized format.

	getExtendedMetadataFromHook (File $file, array $extendedMetadata, &$maxCacheTime)
	Get additional metadata from hooks in standardized format.

	getPriorityLanguages ()
	Returns a list of languages (first is best) to use when formatting multilang fields, based on user and site preferences.

	literal ( $val)
	Convenience function for getFormattedData()

	resolveMultilangMetadata (&$metadata)
	Takes an array returned by the getExtendedMetadata* functions, and resolves multi-language values in it.

	resolveMultilangValue ( $value)
	Turns an XMP-style multilang array into a single value.

	resolveMultivalueValue ( $value)
	Turns an XMP-style multivalue array into a single value by dropping all but the first value.

	sanitizeArrayForAPI (&$arr)
	Makes sure the given array is a valid API response fragment.

	sanitizeKeyForAPI ( $key)
	Turns a string into a valid API identifier.

Protected Attributes
bool	$singleLang = false
	Only output a single language for multi-language fields.

Detailed Description

Format Image metadata values into a human readable form.

Note lots of these messages use the prefix 'exif' even though they may not be exif properties. For example 'exif-ImageDescription' can be the Exif ImageDescription, or it could be the iptc-iim caption property, or it could be the xmp dc:description property. This is because these messages should be independent of how the data is stored, sine the user doesn't care if the description is stored in xmp, exif, etc only that its a description. (Additionally many of these properties are merged together following the MWG standard, such that for example, exif properties override XMP properties that mean the same thing if there is a conflict).

It should perhaps use a prefix like 'metadata' instead, but there is already a large number of messages using the 'exif' prefix.

Since: 1.23 the class extends ContextSource and various formerly-public internal methods are private

Definition at line 54 of file FormatMetadata.php.

Member Function Documentation

◆ collapseContactInfo()

FormatMetadata::collapseContactInfo ( array $vals )

Format the contact info field into a single value.

This function might be called from ExifBitmapHandler::convertMetadataVersion which is why it is public.

Parameters

array $vals Array with fields of the ContactInfo struct defined in the IPTC4XMP spec. Or potentially an array with one element that is a free form text value from the older iptc iim 1:118 prop.

Returns: string HTML-ish looking wikitext

Since: 1.23 no longer static

Definition at line 1584 of file FormatMetadata.php.

References flattenArrayReal(), literal(), and ContextSource\msg().

Referenced by ExifBitmapHandler\convertMetadataVersion(), and makeFormattedData().

◆ discardMultipleValues()

FormatMetadata::discardMultipleValues ( & $metadata )

protected

Takes an array returned by the getExtendedMetadata* functions, and turns all fields into single-valued ones by dropping extra values.

Parameters

array &$metadata

Since: 1.25

Definition at line 1929 of file FormatMetadata.php.

References resolveMultivalueValue().

Referenced by fetchExtendedMetadata().

◆ fetchExtendedMetadata()

FormatMetadata::fetchExtendedMetadata ( File $file )

Get an array of extended metadata.

(See the imageinfo API for format.)

Parameters

File $file File to use

Returns: array [<property name> => ['value' =>

]], or [] on error

Since: 1.23

Definition at line 1718 of file FormatMetadata.php.

References $cache, $file, discardMultipleValues(), getExtendedMetadataFromFile(), getExtendedMetadataFromHook(), ContextSource\getLanguage(), resolveMultilangMetadata(), sanitizeArrayForAPI(), and wfTimestampNow().

◆ flattenArrayContentLang()

static FormatMetadata::flattenArrayContentLang	(	$vals,
		$type = 'ul',
		$noHtml = false,
		$context = false )

static

Flatten an array, using the content language for any messages.

Parameters

array	$vals	Array of values
string	$type	Type of array (either lang, ul, ol). lang = language assoc array with keys being the lang code ul = unordered list, ol = ordered list type can also come from the '_type' member of $vals.
bool \| IContextSource	$noHtml	If to avoid returning anything resembling HTML. (Ugly hack for backwards compatibility with old MediaWiki). Setting this parameter to true is deprecated since 1.36. This parameter can be set to a context, in which case it will be used for $context and $noHtml will default to false.
bool \| IContextSource	$context

Returns: string Single value (in wiki-syntax).

Since: 1.23

Deprecated: since 1.36, appears to have no callers. Hard deprecated since 1.39.

Definition at line 1115 of file FormatMetadata.php.

References $type, ContextSource\setContext(), and wfDeprecated().

◆ flattenArrayReal()

FormatMetadata::flattenArrayReal	(	$vals,
		$type = 'ul',
		$noHtml = false )

A function to collapse multivalued tags into a single value.

This turns an array of (for example) authors into a bulleted list.

This is public on the basis it might be useful outside of this class.

Parameters

array	$vals	Array of values
string	$type	Type of array (either lang, ul, ol). lang = language assoc array with keys being the lang code ul = unordered list, ol = ordered list type can also come from the '_type' member of $vals.
bool	$noHtml	If to avoid returning anything resembling HTML. (Ugly hack for backwards compatibility with old mediawiki).

Returns: string Single value (in wiki-syntax).

Since: 1.23

Access: internal

Definition at line 1152 of file FormatMetadata.php.

References $content, $lang, $type, getPriorityLanguages(), wfDebug(), and wfLogWarning().

Referenced by collapseContactInfo(), and makeFormattedData().

◆ getExtendedMetadataFromFile()

FormatMetadata::getExtendedMetadataFromFile ( File $file )

protected

Get file-based metadata in standardized format.

Note that for a remote file, this might return metadata supplied by extensions.

Parameters

File $file File to use

Returns: array [<property name> => ['value' =>

]], or [] on error

Since: 1.23

Definition at line 1768 of file FormatMetadata.php.

References $file, $title, and wfTimestamp().

Referenced by fetchExtendedMetadata().

◆ getExtendedMetadataFromHook()

FormatMetadata::getExtendedMetadataFromHook	(	File	$file,
		array	$extendedMetadata,
		&	$maxCacheTime )

protected

Get additional metadata from hooks in standardized format.

Parameters

File	$file	File to use
array	$extendedMetadata
int	&$maxCacheTime	Hook handlers might use this parameter to override cache time

Returns: array [<property name> => ['value' =>

]], or [] on error

Since: 1.23

Definition at line 1817 of file FormatMetadata.php.

References $file, and ContextSource\getContext().

Referenced by fetchExtendedMetadata().

◆ getFormattedData()

static FormatMetadata::getFormattedData	(		$tags,
			$context = false )

static

Numbers given by Exif user agents are often magical, that is they should be replaced by a detailed explanation depending on their value which most of the time are plain integers.

This function formats Exif (and other metadata) values into human readable form.

This is the usual entry point for this class.

Parameters

array	$tags	The Exif data to format ( as returned by Exif::getFilteredData() or BitmapMetadataHandler )
IContextSource \| false	$context

Returns: array

Definition at line 87 of file FormatMetadata.php.

References ContextSource\setContext().

Referenced by MediaHandler\formatMetadataHelper().

◆ getPriorityLanguages()

FormatMetadata::getPriorityLanguages ( )

protected

Returns a list of languages (first is best) to use when formatting multilang fields, based on user and site preferences.

Returns: array

Since: 1.23

Definition at line 2011 of file FormatMetadata.php.

References ContextSource\getLanguage().

Referenced by flattenArrayReal(), and resolveMultilangValue().

◆ getVisibleFields()

static FormatMetadata::getVisibleFields ( )

static

Get a list of fields that are visible by default.

Returns: string[]

Since: 1.23

Definition at line 1697 of file FormatMetadata.php.

References $line, $lines, $matches, and wfMessage().

Referenced by MediaHandler\visibleMetadataFields().

◆ literal()

FormatMetadata::literal ( $val )

protected

Convenience function for getFormattedData()

Parameters

string | int $val The literal value

Returns: string The value, properly escaped as wikitext – with some exceptions to allow auto-linking, etc.

Definition at line 1323 of file FormatMetadata.php.

Referenced by collapseContactInfo(), and makeFormattedData().

◆ makeFormattedData()

FormatMetadata::makeFormattedData ( $tags )

Numbers given by Exif user agents are often magical, that is they should be replaced by a detailed explanation depending on their value which most of the time are plain integers.

This function formats Exif (and other metadata) values into human readable form.

Parameters

array $tags The Exif data to format ( as returned by Exif::getFilteredData() or BitmapMetadataHandler )

Returns: array

Since: 1.23

Definition at line 107 of file FormatMetadata.php.

References $lang, $s, $type, collapseContactInfo(), flattenArrayReal(), ContextSource\getLanguage(), literal(), ContextSource\msg(), and wfTimestamp().

◆ resolveMultilangMetadata()

FormatMetadata::resolveMultilangMetadata ( & $metadata )

protected

Takes an array returned by the getExtendedMetadata* functions, and resolves multi-language values in it.

Parameters

array &$metadata

Since: 1.23

Definition at line 1912 of file FormatMetadata.php.

References resolveMultilangValue().

Referenced by fetchExtendedMetadata().

◆ resolveMultilangValue()

FormatMetadata::resolveMultilangValue ( $value )

protected

Turns an XMP-style multilang array into a single value.

If the value is not a multilang array, it is returned unchanged. See mediawiki.org/wiki/Manual:File_metadata_handling::Multi-language_array_format

Parameters

mixed $value

Returns: mixed Value in best language, null if there were no languages at all

Since: 1.23

Definition at line 1846 of file FormatMetadata.php.

References $lang, and getPriorityLanguages().

Referenced by resolveMultilangMetadata().

◆ resolveMultivalueValue()

FormatMetadata::resolveMultivalueValue ( $value )

protected

Turns an XMP-style multivalue array into a single value by dropping all but the first value.

If the value is not a multivalue array (or a multivalue array inside a multilang array), it is returned unchanged. See mediawiki.org/wiki/Manual:File_metadata_handling::Multi-language_array_format

Parameters

mixed $value

Returns: mixed The value, or the first value if there were multiple ones

Since: 1.25

Definition at line 1887 of file FormatMetadata.php.

References resolveMultivalueValue().

Referenced by discardMultipleValues(), and resolveMultivalueValue().

◆ sanitizeArrayForAPI()

FormatMetadata::sanitizeArrayForAPI ( & $arr )

protected

Makes sure the given array is a valid API response fragment.

Parameters

array &$arr

Definition at line 1949 of file FormatMetadata.php.

References $keys, sanitizeArrayForAPI(), and sanitizeKeyForAPI().

Referenced by fetchExtendedMetadata(), and sanitizeArrayForAPI().

◆ sanitizeKeyForAPI()

FormatMetadata::sanitizeKeyForAPI ( $key )

protected

Turns a string into a valid API identifier.

Parameters

string $key

Returns: string

Since: 1.23

Definition at line 1987 of file FormatMetadata.php.

Referenced by sanitizeArrayForAPI().

◆ setSingleLanguage()

FormatMetadata::setSingleLanguage ( $val )

Trigger only outputting single language for multilanguage fields.

Parameters

bool $val

Since: 1.23

Definition at line 70 of file FormatMetadata.php.

Referenced by ApiQueryImageInfo\getInfo().

Member Data Documentation

◆ $singleLang

bool FormatMetadata::$singleLang = false

protected

Only output a single language for multi-language fields.

Since: 1.23

Definition at line 62 of file FormatMetadata.php.

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

includes/media/FormatMetadata.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ collapseContactInfo()

◆ discardMultipleValues()

◆ fetchExtendedMetadata()

◆ flattenArrayContentLang()

◆ flattenArrayReal()

◆ getExtendedMetadataFromFile()

◆ getExtendedMetadataFromHook()

◆ getFormattedData()

◆ getPriorityLanguages()

◆ getVisibleFields()

◆ literal()

◆ makeFormattedData()

◆ resolveMultilangMetadata()

◆ resolveMultilangValue()

◆ resolveMultivalueValue()

◆ sanitizeArrayForAPI()

◆ sanitizeKeyForAPI()

◆ setSingleLanguage()

Member Data Documentation

◆ $singleLang