Docs For Class GalleryPluginHelper

Class GalleryPluginHelper_medium

Methods

activate [line 40]

void activate(

$pluginType, 
$pluginId 
)

Parameters:

	$pluginType:
	$pluginId:

API Tags:

See:

GalleryCoreApi::activatePlugin

[ Top ]

deactivate [line 63]

void deactivate(

$pluginType, 
$pluginId 
)

Parameters:

	$pluginType:
	$pluginId:

API Tags:

See:

GalleryCoreApi::deactivatePlugin

[ Top ]

getAllPluginIds [line 116]

void getAllPluginIds(

$pluginType 
)

Parameters:

$pluginType:

API Tags:

See:

GalleryCoreApi::getAllPluginIds

[ Top ]

removeAllParameters [line 255]

void removeAllParameters(

$pluginType, 
$pluginId 
)

Parameters:

	$pluginType:
	$pluginId:

API Tags:

See:

GalleryCoreApi::removeAllPluginParameters

[ Top ]

removeParameter [line 186]

void removeParameter(

$pluginType, 
$pluginId, 
$parameterName, [
$itemIds = 0] 
)

Parameters:

	$pluginType:
	$pluginId:
	$parameterName:
	$itemIds:

API Tags:

See:

GalleryCoreApi::removePluginParameter

[ Top ]

removeParameterByValue [line 225]

void removeParameterByValue(

$pluginType, 
$pluginId, 
$parameterName, 
$parameterValue 
)

Parameters:

	$pluginType:
	$pluginId:
	$parameterName:
	$parameterValue:

API Tags:

See:

GalleryCoreApi::removePluginParameterByValue

[ Top ]

removeParametersForItemId [line 159]

void removeParametersForItemId(

$itemId 
)

Parameters:

$itemId:

API Tags:

See:

GalleryCoreApi::removePluginParametersForItemId

[ Top ]

removePlugin [line 86]

void removePlugin(

$pluginType, 
$pluginId 
)

Parameters:

	$pluginType:
	$pluginId:

API Tags:

See:

GalleryCoreApi::removePlugin

[ Top ]

setParameter [line 281]

void setParameter(

$pluginType, 
$pluginId, 
$parameterName, 
$parameterValue, [
$itemId = 0] 
)

Parameters:

	$pluginType:
	$pluginId:
	$parameterName:
	$parameterValue:
	$itemId:

API Tags:

See:

GalleryCoreApi::setPluginParameter

[ Top ]

setPluginInstance [line 428]

void setPluginInstance(
string
$pluginType, string
$pluginId, 
&$instance, GalleryPlugin
$instance 
)

Set a given plugin instance in the plugin cache.

This should only be used by unit tests that want to force a specific dummy plugin to exist.

Parameters:

string	$pluginType:	plugin type
string	$pluginId:	plugin id
GalleryPlugin	$instance:
	&$instance:

API Tags:

Access:

protected

[ Top ]

_addParameter [line 354]

GalleryStatus _addParameter(
string
$pluginType, string
$pluginId, string
$parameterName, string
$parameterValue, [int
$itemId = 0] 
)

Add a new parameter for this plugin

Parameters:

string	$pluginType:	the type of the plugin
string	$pluginId:	the id of the plugin
string	$parameterName:	the name of the parameter
string	$parameterValue:	the value of the parameter
int	$itemId:	the id of item (or null for a global setting)

API Tags:

Return:	a status code
Access:	private

[ Top ]

_updateParameter [line 392]

GalleryStatus _updateParameter(
string
$pluginType, string
$pluginId, string
$parameterName, string
$parameterValue, [int
$itemId = 0] 
)

Update an existing parameter for this plugin

Parameters:

string	$pluginType:	the type of the plugin
string	$pluginId:	the id of the plugin
string	$parameterName:	the name of the parameter
string	$parameterValue:	the value of the parameter
int	$itemId:	the id of item (or null for a global setting)

API Tags:

Return:	a status code
Access:	private

[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:02:44 -0700 by phpDocumentor 1.3.0RC6

	GalleryCore Helpers

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

Class: GalleryPluginHelper_medium

Class GalleryPluginHelper_medium