MediaWiki  1.23.8
XMPValidate Class Reference

This contains some static methods for validating XMP properties. More...

Static Public Member Functions

static validateBoolean ( $info, &$val, $standalone)
 Function to validate boolean properties ( True or False ) More...
 
static validateClosed ( $info, &$val, $standalone)
 function to validate properties with a fixed number of allowed choices. More...
 
static validateDate ( $info, &$val, $standalone)
 function to validate date properties, and convert to (partial) Exif format. More...
 
static validateFlash ( $info, &$val, $standalone)
 function to validate and modify flash structure More...
 
static validateGPS ( $info, &$val, $standalone)
 function to validate, and more importantly translate the XMP DMS form of gps coords to the decimal form we use. More...
 
static validateInteger ( $info, &$val, $standalone)
 function to validate integers More...
 
static validateLangCode ( $info, &$val, $standalone)
 function to validate LangCode properties ( en-GB, etc ) More...
 
static validateRating ( $info, &$val, $standalone)
 function to validate rating properties -1, 0-5 More...
 
static validateRational ( $info, &$val, $standalone)
 function to validate rational properties ( 12/10 ) More...
 

Detailed Description

This contains some static methods for validating XMP properties.

See XMPInfo and XMPReader classes.

Each of these functions take the same parameters

  • an info array which is a subset of the XMPInfo::items array
  • A value (passed as reference) to validate. This can be either a simple value or an array
  • A boolean to determine if this is validating a simple or complex values

It should be noted that when an array is being validated, typically the validation function is called once for each value, and then once at the end for the entire array.

These validation functions can also be used to modify the data. See the gps and flash one's for example.

See also
http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart1.pdf starting at pg 28
http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart2.pdf starting at pg 11

Definition at line 43 of file XMPValidate.php.

Member Function Documentation

◆ validateBoolean()

static XMPValidate::validateBoolean (   $info,
$val,
  $standalone 
)
static

Function to validate boolean properties ( True or False )

Parameters
array$infoInformation about current property
mixed&$valCurrent value to validate
bool$standaloneIf this is a simple property or array

Definition at line 51 of file XMPValidate.php.

References wfDebugLog().

◆ validateClosed()

static XMPValidate::validateClosed (   $info,
$val,
  $standalone 
)
static

function to validate properties with a fixed number of allowed choices.

(closed choice)

Parameters
array$infoInformation about current property
&$valMixed current value to validate
bool$standaloneIf this is a simple property or array

Definition at line 148 of file XMPValidate.php.

References wfDebugLog().

◆ validateDate()

static XMPValidate::validateDate (   $info,
$val,
  $standalone 
)
static

function to validate date properties, and convert to (partial) Exif format.

Dates can be one of the following formats: YYYY YYYY-MM YYYY-MM-DD YYYY-MM-DDThh:mmTZD YYYY-MM-DDThh:mm:ssTZD YYYY-MM-DDThh:mm:ss.sTZD

Parameters
array$infoInformation about current property
mixed&$valCurrent value to validate. Converts to TS_EXIF as a side-effect. in cases where there's only a partial date, it will give things like 2011:04.
bool$standaloneIf this is a simple property or array

Definition at line 241 of file XMPValidate.php.

References $res, array(), TS_EXIF, TS_UNIX, wfDebugLog(), and wfTimestamp().

Referenced by XMPValidateTest\testValidateDate().

◆ validateFlash()

static XMPValidate::validateFlash (   $info,
$val,
  $standalone 
)
static

function to validate and modify flash structure

Parameters
array$infoInformation about current property
&$valMixed current value to validate
bool$standaloneIf this is a simple property or array

Definition at line 178 of file XMPValidate.php.

References wfDebugLog().

◆ validateGPS()

static XMPValidate::validateGPS (   $info,
$val,
  $standalone 
)
static

function to validate, and more importantly translate the XMP DMS form of gps coords to the decimal form we use.

See also
http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart2.pdf section 1.2.7.4 on page 23
Parameters
array$infoUnused (info about prop)
string&$valGPS string in either DDD,MM,SSk or or DDD,MM.mmk form
bool$standaloneIf its a simple prop (should always be true)

Definition at line 342 of file XMPValidate.php.

References array(), and wfDebugLog().

◆ validateInteger()

static XMPValidate::validateInteger (   $info,
$val,
  $standalone 
)
static

function to validate integers

Parameters
array$infoInformation about current property
mixed&$valCurrent value to validate
bool$standaloneIf this is a simple property or array

Definition at line 129 of file XMPValidate.php.

References wfDebugLog().

◆ validateLangCode()

static XMPValidate::validateLangCode (   $info,
$val,
  $standalone 
)
static

function to validate LangCode properties ( en-GB, etc )

This is just a naive check to make sure it somewhat looks like a lang code.

See also
rfc 3066
http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart1.pdf page 30 (section 8.2.2.5)
Parameters
array$infoInformation about current property
&$valMixed current value to validate
bool$standaloneIf this is a simple property or array

Definition at line 212 of file XMPValidate.php.

References wfDebugLog().

◆ validateRating()

static XMPValidate::validateRating (   $info,
$val,
  $standalone 
)
static

function to validate rating properties -1, 0-5

if its outside of range put it into range.

See also
MWG spec
Parameters
array$infoInformation about current property
mixed&$valCurrent value to validate
bool$standaloneIf this is a simple property or array

Definition at line 90 of file XMPValidate.php.

References wfDebugLog().

◆ validateRational()

static XMPValidate::validateRational (   $info,
$val,
  $standalone 
)
static

function to validate rational properties ( 12/10 )

Parameters
array$infoInformation about current property
mixed&$valCurrent value to validate
bool$standaloneIf this is a simple property or array

Definition at line 69 of file XMPValidate.php.

References wfDebugLog().


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