Class: PluginCallbackView

Source Location: /modules/core/PluginCallback.inc

Class PluginCallbackView

Class Overview

This view lets you make very simple callbacks to the framework to get very specific data.

Eventually this will probably get refactored into a much more sophisticated framework.

Located in /modules/core/PluginCallback.inc [line 37]

GalleryView
   |
   --PluginCallbackView

Methods

[ Top ]

Direct descendents

Child Class	Description
PluginCallbackWithFakeHandler

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryView

GalleryView::$_l10Domain

Inherited From GalleryView

GalleryView::autoCacheControl()

Method to opt-in to managed HTTP cache control

GalleryView::doLoadTemplate()

Prepare all the various things that a view requires in order to load up the template properly (like the theme, the form variables, the status variables, etc. then call the view's loadTemplate() method and pass in the given template.

GalleryView::getItem()

Return the current item, as specified in the itemId request variable.

GalleryView::getL10Domain()

Get the localization domain for this view.

GalleryView::getViewDescription()

This should return a description of the current view.

GalleryView::getViewType()

Type of view.

GalleryView::init()

Initialize the view.

GalleryView::isAllowedInEmbedOnly()

Does this view allow direct access even in embed-only mode?

GalleryView::isAllowedInMaintenance()

Does this view allow access to non-admins when site is in maintenance mode?

GalleryView::isControllerLike()

Does this view change any data? Only controllers should change data, but AJAX and some immediate views are handled in views in Gallery.

GalleryView::isImmediate()

Is this an immediate or a buffered view?

GalleryView::loadTemplate()

Load the template with data from this view.

GalleryView::loadThemeAndParameters()

Load theme, theme parameters and item to use for this view.

GalleryView::loadThemeForItem()

Get the theme for this item by finding the theme id for the nearest album.

GalleryView::loadView()

Load a view.

GalleryView::renderImmediate()

Print out the immediate output for this view. This will bypass any global templating. This style of view should be reserved for binary data.

GalleryView::setCacheControl()

Set cache headers for sensitive pages

GalleryView::setStandardTemplateVariables()

Set standard user information available for every view.

GalleryView::shouldSaveSession()

Should session be saved and session cookie sent when this view is accessed?

GalleryView::_getItem()

Return the current item, as specified in the itemId request variable.

GalleryView::_getThemeAndParametersByEvent()

Let non-core code override the theme and its parameters for this request.

GalleryView::_loadTheme()

Load the given theme if it's active.

GalleryView::_permissionCheck()

Process possible permission errors when accessing a view.

[ Top ]

Method Summary

static array	calculateStateChanges()	Given two sets of states, figure out what's changed from before to after.
static array	getPluginState()	Get the state ('active', 'inactive', 'uninstalled', etc) of a given module
static array	getPluginStates()	Get the state ('active', 'inactive', 'uninstalled', etc) of all modules
static GalleryStatus	handleCallback()	Handle the specific callback, and store its result in the given output array.
void	isControllerLike()
void	isImmediate()
void	renderImmediate()

[ Top ]

Properties

Methods

static method calculateStateChanges [line 122]

static array calculateStateChanges(
array
$beforeStates, array
$afterStates 
)

Given two sets of states, figure out what's changed from before to after.

Parameters:

array	$beforeStates:	(moduleId => state, ...)
array	$afterStates:	(moduleId => state, ...)

API Tags:

Return:

changed states (moduleId => state, ...)

Redefined in descendants as:

PluginCallbackWithFakeHandler::calculateStateChanges()

[ Top ]

static method getPluginState [line 389]

static array getPluginState(
string
$type, GalleryPlugin
$plugin, array
$status 
)

Get the state ('active', 'inactive', 'uninstalled', etc) of a given module

Parameters:

string	$type:	('module' or 'theme')
GalleryPlugin	$plugin:
array	$status:	status of the plugin (from GalleryCoreApi::fetchPluginStatus)

API Tags:

Return:

GalleryStatus a status code string a state

[ Top ]

static method getPluginStates [line 354]

static array getPluginStates(
)

Get the state ('active', 'inactive', 'uninstalled', etc) of all modules

API Tags:

Return:

GalleryStatus a status code array(moduleId => state, ...)

Redefined in descendants as:

PluginCallbackWithFakeHandler::getPluginStates()

[ Top ]

static method handleCallback [line 145]

static GalleryStatus handleCallback(
string
$command, 
&$result, array
$result 
)

Handle the specific callback, and store its result in the given output array.

Parameters:

string	$command:	(eg. "installModule")
array	$result:	the location for result data to be sent back to the browser
	&$result:

API Tags:

Return:

a status code

Redefined in descendants as:

PluginCallbackWithFakeHandler::handleCallback()

[ Top ]

isControllerLike [line 48]

void isControllerLike(
)

API Tags:

See:

GalleryView::isControllerLike

Redefinition of:

GalleryView::isControllerLike(): Does this view change any data? Only controllers should change data, but AJAX and some immediate views are handled in views in Gallery.

[ Top ]

isImmediate [line 41]

void isImmediate(
)

API Tags:

See:

GalleryView::isImmediate

Redefinition of:

GalleryView::isImmediate(): Is this an immediate or a buffered view?

[ Top ]

renderImmediate [line 55]

void renderImmediate(

$status, 
$error 
)

Parameters:

	$status:
	$error:

API Tags:

See:

GalleryView::renderImmediate

Redefinition of:

GalleryView::renderImmediate(): Print out the immediate output for this view. This will bypass any global templating. This style of view should be reserved for binary data.

[ Top ]

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

	GalleryCore UserInterface

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