MediaWiki  master
FormatMetadata Class Reference

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

Inheritance diagram for FormatMetadata:
Collaboration diagram for FormatMetadata:

Public Member Functions

 collapseContactInfo (array $vals)
 Format the contact info field into a single value. More...
 
 fetchExtendedMetadata (File $file)
 Get an array of extended metadata. More...
 
 flattenArrayReal ( $vals, $type='ul', $noHtml=false)
 A function to collapse multivalued tags into a single value. More...
 
 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. More...
 
 setSingleLanguage ( $val)
 Trigger only outputting single language for multilanguage fields. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getActionName ()
 Get the action name for the current web request. More...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Static Public Member Functions

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. More...
 
static getVisibleFields ()
 Get a list of fields that are visible by default. More...
 

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. More...
 
 getExtendedMetadataFromFile (File $file)
 Get file-based metadata in standardized format. More...
 
 getExtendedMetadataFromHook (File $file, array $extendedMetadata, &$maxCacheTime)
 Get additional metadata from hooks in standardized format. More...
 
 getPriorityLanguages ()
 Returns a list of languages (first is best) to use when formatting multilang fields, based on user and site preferences. More...
 
 literal ( $val)
 Convenience function for getFormattedData() More...
 
 resolveMultilangMetadata (&$metadata)
 Takes an array returned by the getExtendedMetadata* functions, and resolves multi-language values in it. More...
 
 resolveMultilangValue ( $value)
 Turns an XMP-style multilang array into a single value. More...
 
 resolveMultivalueValue ( $value)
 Turns an XMP-style multivalue array into a single value by dropping all but the first value. More...
 
 sanitizeArrayForAPI (&$arr)
 Makes sure the given array is a valid API response fragment. More...
 
 sanitizeKeyForAPI ( $key)
 Turns a string into a valid API identifier. More...
 

Protected Attributes

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

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$valsArray 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 1550 of file FormatMetadata.php.

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 1895 of file FormatMetadata.php.

◆ fetchExtendedMetadata()

FormatMetadata::fetchExtendedMetadata ( File  $file)

Get an array of extended metadata.

(See the imageinfo API for format.)

Parameters
File$fileFile to use
Returns
array [<property name> => ['value' =>

]], or [] on error

Since
1.23

Definition at line 1684 of file FormatMetadata.php.

References $cache, $file, File\DELETED_FILE, and wfTimestampNow().

◆ 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$valsArray of values
string$typeType 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$noHtmlIf 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 1114 of file FormatMetadata.php.

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

Referenced by 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$fileFile to use
Returns
array [<property name> => ['value' =>

]], or [] on error

Since
1.23

Definition at line 1734 of file FormatMetadata.php.

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

◆ getExtendedMetadataFromHook()

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

Get additional metadata from hooks in standardized format.

Parameters
File$fileFile to use
array$extendedMetadata
int&$maxCacheTimeHook handlers might use this parameter to override cache time
Returns
array [<property name> => ['value' =>

]], or [] on error

Since
1.23

Definition at line 1783 of file FormatMetadata.php.

References $file, and getContext().

◆ 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$tagsThe 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 1977 of file FormatMetadata.php.

Referenced by flattenArrayReal().

◆ getVisibleFields()

static FormatMetadata::getVisibleFields ( )
static

Get a list of fields that are visible by default.

Returns
string[]
Since
1.23

Definition at line 1663 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 | null$valThe literal value
Returns
string The value, properly escaped as wikitext – with some exceptions to allow auto-linking, etc.

Definition at line 1285 of file FormatMetadata.php.

Referenced by 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$tagsThe 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 1878 of file FormatMetadata.php.

◆ 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 1812 of file FormatMetadata.php.

References $lang.

◆ 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 1853 of file FormatMetadata.php.

◆ sanitizeArrayForAPI()

FormatMetadata::sanitizeArrayForAPI ( $arr)
protected

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

Parameters
array&$arr

Definition at line 1915 of file FormatMetadata.php.

References $keys, and ApiResult\setPreserveKeysList().

◆ sanitizeKeyForAPI()

FormatMetadata::sanitizeKeyForAPI (   $key)
protected

Turns a string into a valid API identifier.

Parameters
string$key
Returns
string
Since
1.23

Definition at line 1953 of file FormatMetadata.php.

◆ 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: