Docs For Class NetPbmToolkitHelper

Class NetPbmToolkitHelper

Method Summary

GalleryStatus	getOperationsAndProperties()	Figure out what operations and properties are supported by the NetPbmToolkit and return them.
GalleryStatus	saveParameters()	Save module parameters based on test results.
array	testBinaries()	Test if the given path has a working set of NetPbm binaries.
array	testJhead()	Test if the given path has a working jhead binary.

[ Top ]

Methods

getOperationsAndProperties [line 45]

GalleryStatus getOperationsAndProperties(
[boolean
$saveParameters = false] 
)

Figure out what operations and properties are supported by the NetPbmToolkit and return them.

Parameters:

boolean

$saveParameters:

(optional) true to save module parameters

API Tags:

Return:

a status code array('operations' => ..., 'properties' => ...)

[ Top ]

saveParameters [line 310]

GalleryStatus saveParameters(
array
$tests 
)

Save module parameters based on test results.

Parameters:

array

$tests:

testBinaries test results

API Tags:

Return:

a status code

[ Top ]

testBinaries [line 226]

array testBinaries(
string
$netPbmPath 
)

Test if the given path has a working set of NetPbm binaries.

This is done by calling all the binaries with the --version flag and making sure they run properly.

Parameters:

string

$netPbmPath:

path to the NetPbm we are testing

API Tags:

Return:

GalleryStatus general status of tests array ('name' => string: the name of the binary, 'success' => boolean: test successful? 'message' => string: the error message ) array of string mime types

[ Top ]

testJhead [line 182]

array testJhead(
string
$jheadPath 
)

Test if the given path has a working jhead binary.

This is done by calling jhead with the -V flag

Parameters:

string

$jheadPath:

path to the jhead binary

API Tags:

Return:

GalleryStatus general status of tests array ('name' => string: the name of the binary, 'success' => boolean: test successful? 'message' => string: the error message ) array hash map of mime types

[ Top ]

Documentation generated on Fri, 03 Oct 2008 05:50:39 -0700 by phpDocumentor 1.3.0RC6

	NetPbm Classes

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

Class: NetPbmToolkitHelper

Class NetPbmToolkitHelper