SRFSlideShowApi Class Reference

Inheritance diagram for SRFSlideShowApi:

Collaboration diagram for SRFSlideShowApi:

Public Member Functions
	execute ()
	getHelpUrls ()
	getVersion ()

Protected Member Functions
	getDescription ()
	getExamples ()
	getAllowedParams ()
	getParamDescription ()

Detailed Description

API module to retrieve formatted results for a given page, printouts and template.

Author

Stephan Gambke

Member Function Documentation

execute()

SRFSlideShowApi::execute

(

)

Evaluates the parameters, performs the query, and sets up the result.

The result data is stored in the ApiResult object available through getResult().

getAllowedParams()

SRFSlideShowApi::getAllowedParams ( )

protected

Returns an array of allowed parameters

Returns

array|bool

getDescription()

SRFSlideShowApi::getDescription ( )

protected

Returns the description string for this module

Returns

mixed string or array of strings

getExamples()

SRFSlideShowApi::getExamples ( )

protected

Returns usage examples for this module. Return false if no examples are available.

Returns

bool|string|array

getParamDescription()

SRFSlideShowApi::getParamDescription ( )

protected

Returns an array of parameter descriptions. Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns

array|bool False on no parameter descriptions

getVersion()

SRFSlideShowApi::getVersion

(

)

Returns a string that identifies the version of the extending class. Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns

string

---

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

• SRF_SlideShowApi.php