Docs For Class Getid3Helper

Methods

getGetid3Keys [line 476]

array getGetid3Keys(
)

Return the Getid3 keys that we know about (from Getid3).

The resulting array is of the form:

logical getid3 property => (physical getid3 property, internationalized title, group) logical getid3 property => (physical getid3 property, internationalized title, group)

The logical getid3 properties are unique and have some correlation to the physical property, but have been changed for our convenience. The physical getid3 property is the actual getid3 property name (as reported by Getid3). The group is an internationalized name of a group like "General Properties", etc.

API Tags:

Return:

getID3() keys

[ Top ]

getId3ArchiveData [line 158]

void getId3ArchiveData(

$path, 
$viewMode 
)

Parameters:

	$path:
	$viewMode:

[ Top ]

getId3ArchiveRecurse [line 127]

void getId3ArchiveRecurse(

$results, 
$fileArray, [
$nameprefix = ''] 
)

Parameters:

	$results:
	$fileArray:
	$nameprefix:

[ Top ]

getId3ArchiveTar [line 147]

void getId3ArchiveTar(

$fileDetails 
)

Parameters:

$fileDetails:

[ Top ]

getId3Data [line 193]

array getId3Data(
string
$path, int
$viewMode 
)

Return the Getid3 data for a specific view and file

Parameters:

string	$path:	the path to the file
int	$viewMode:

API Tags:

Return:

GalleryStatus a status code array title/value pairs

[ Top ]

getOriginationTimestamp [line 349]

int getOriginationTimestamp(
string
$path 
)

Return the timestamp when the item was taken, as recorded in exif, id3, or other meta tag

Parameters:

string

$path:

the path to the file

API Tags:

Return:

an unix timestamp

[ Top ]

getProperties [line 418]

array getProperties(
int
$viewMode 
)

Return the target properties for the given view mode

Parameters:

int

$viewMode:

the view mode (GETID3_SUMMARY, etc)

API Tags:

Return:

GalleryStatus a status code array logical exif property names

[ Top ]

getTimeDowMDHMSY [line 231]

int getTimeDowMDHMSY(
string
$value 
)

Return the timestamp of a time string in Day of week, Month, Day, Hour, Minute, Second, Year format.

Parameters:

string

$value:

time string

API Tags:

Return:

an unix timestamp, null if not parsed

[ Top ]

getTimeInt [line 282]

int getTimeInt(
string
$value 
)

Return the timestamp of a time string already a time stamp.

Parameters:

string

$value:

time string

API Tags:

Return:

an unix timestamp, null if not parsed

[ Top ]

getTimeYMDHMS [line 263]

int getTimeYMDHMS(
string
$value 
)

Return the timestamp of a time string in Year, Month, Day, Hour, Minute, Second format.

Parameters:

string

$value:

time string

API Tags:

Return:

an unix timestamp, null if not parsed

[ Top ]

postProcessValue [line 303]

string postProcessValue(
string
$property, string
$value 
)

Sometimes the values that are returned aren't quite as we'd like to present them, so do a little post processing on the text

Parameters:

string	$property:	the property name (eg. "ShutterSpeedValue")
string	$value:	the value (eg. "25/10000 sec")

API Tags:

Return:

the result (eg. "1/400 sec")

Information Tags:

Todo:

(donw) Implement postProcessValue

[ Top ]

setDefaultProperties [line 64]

GalleryStatus setDefaultProperties(
int
$viewMode 
)

Reset the given view mode back to its default settings

Parameters:

int

$viewMode:

API Tags:

Return:

a status code

[ Top ]

setProperties [line 441]

GalleryStatus setProperties(
int
$viewMode, array
$properties 
)

Set the target properties for the given view mode

Parameters:

int	$viewMode:	the view mode (GETID3_SUMMARY, etc)
array	$properties:	logical property key/value pairs

API Tags:

Return:

a status code

[ Top ]

_fetchRawGetid3Data [line 113]

void _fetchRawGetid3Data(
string
$path, 
&$rawGetid3Data, array
$rawGetid3Data 
)

Return the raw data as returned by Getid3

Parameters:

string	$path:	the path to the file
array	$rawGetid3Data:	reference to an array where to store the results as returned by getid3()
	&$rawGetid3Data:

API Tags:

Access:

private

[ Top ]

_getValue [line 398]

array _getValue(

&$source, array
$keyPath, array
$source 
)

Retrieve a single value by path from a nested associative array.

The data source is an array like this:

foo => bar => (a => 1, b => 2, c => 3) baz => (d => 4, e => 5, f => 6)

the key path is an array like this:

(foo, bar, d)

the resulting value would be "4"

Parameters:

array	$source:	the data source
array	$keyPath:
	&$source:

API Tags:

Return:	GalleryStatus a status code string value
Access:	private

[ Top ]

	Getid3 Classes

[ class tree: Getid3 ] [ index: Getid3 ] [ all elements ]

Class: Getid3Helper

Class Getid3Helper