Class: GalleryRemoteController

Source Location: /modules/remote/GalleryRemote.inc

Class GalleryRemoteController

Class Overview

This controller fields requests from Gallery Remote and performs any required changes to the data model.

Located in /modules/remote/GalleryRemote.inc [line 36]

GalleryController
   |
   --GalleryRemoteController

Properties

$_optionInstances

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryController

GalleryController::assertIsGenuineRequest()

Verifies the genuineness of the request

GalleryController::getItem()

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

GalleryController::handleRequest()

Take the appropriate action based on the user input provided.

GalleryController::isAllowedInEmbedOnly()

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

GalleryController::isAllowedInMaintenance()

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

GalleryController::loadController()

Load a controller

GalleryController::omitAuthTokenCheck()

Whether the controller opts-out from the framework's auth token check.

GalleryController::permissionCheck()

GalleryController::shouldSaveSession()

Should session be saved and session cookie sent when this controller is used?

[ Top ]

Property Summary

array

$_optionInstances

ItemAddOption instances to use when handling this request. Only used by test code.

[ Top ]

Method Summary

GalleryStatus	addDataItem()	Add a data item to Gallery
GalleryStatus	albumProperties()	Album properties
GalleryStatus	fetchAlbumImages()	Fetch album images
GalleryStatus	fetchAlbums()	Load the album list into our response object
void	handleRequest()
GalleryStatus	imageProperties()	Image properties
GalleryStatus	incrementViewCount()	Increment view count
void	isAllowedInEmbedOnly()
void	loadParentsToRoot()
GalleryStatus	login()	Log into Gallery
GalleryStatus	newAlbum()	Create a new album
void	omitAuthTokenCheck()
void	setOptionInstances()	Tests can use this method to hardwire a specific set of option instances to use.
GalleryStatus	_assertHasViewPermission()	Assert that the active user can view the specified item.

[ Top ]

Properties

array $_optionInstances [line 42]

ItemAddOption instances to use when handling this request. Only used by test code.

API Tags:

Access:

private

[ Top ]

Methods

addDataItem [line 495]

GalleryStatus addDataItem(
array
$form, 
&$response, GalleryRemoteProperties
$response 
)

Add a data item to Gallery

Parameters:

array	$form:	key/value pairs from Gallery Remote
GalleryRemoteProperties	$response:	a reference to our response object
	&$response:

API Tags:

Return:

a status code

[ Top ]

albumProperties [line 971]

GalleryStatus albumProperties(
array
$form, 
&$response, GalleryRemoteProperties
$response 
)

Album properties

Parameters:

array	$form:	key/value pairs from Gallery Remote
GalleryRemoteProperties	$response:	a reference to our response object
	&$response:

API Tags:

Return:

a status code

[ Top ]

fetchAlbumImages [line 700]

GalleryStatus fetchAlbumImages(
array
$form, 
&$response, GalleryRemoteProperties
$response 
)

Fetch album images

Parameters:

array	$form:	key/value pairs from Gallery Remote
GalleryRemoteProperties	$response:	a reference to our response object
	&$response:

API Tags:

Return:

a status code

[ Top ]

fetchAlbums [line 325]

GalleryStatus fetchAlbums(
boolean
$prune, array
$form, 
&$response, GalleryRemoteProperties
$response 
)

Load the album list into our response object

Parameters:

boolean	$prune:	prune albums where user can't upload to or create sub-albums
array	$form:	key/value pairs from Gallery Remote
GalleryRemoteProperties	$response:	a reference to our response object
	&$response:

API Tags:

Return:

a status code

[ Top ]

handleRequest [line 72]

void handleRequest(

$form 
)

Parameters:

$form:

API Tags:

See:

GalleryController::handleRequest

Redefinition of:

GalleryController::handleRequest(): Take the appropriate action based on the user input provided.

[ Top ]

imageProperties [line 1104]

GalleryStatus imageProperties(
array
$form, 
&$response, GalleryRemoteProperties
$response 
)

Image properties

Parameters:

array	$form:	key/value pairs from Gallery Remote
GalleryRemoteProperties	$response:	a reference to our response object
	&$response:

API Tags:

Return:

a status code

[ Top ]

incrementViewCount [line 1068]

GalleryStatus incrementViewCount(
array
$form, 
&$response, GalleryRemoteProperties
$response 
)

Increment view count

Parameters:

array	$form:	key/value pairs from Gallery Remote
GalleryRemoteProperties	$response:	a reference to our response object
	&$response:

API Tags:

Return:

a status code

[ Top ]

isAllowedInEmbedOnly [line 58]

void isAllowedInEmbedOnly(
)

API Tags:

See:

GalleryController::isAllowedInEmbedOnly

Redefinition of:

GalleryController::isAllowedInEmbedOnly(): Does this controller allow direct access even in embed-only mode?

[ Top ]

loadParentsToRoot [line 459]

void loadParentsToRoot(

$rootId, 
$albumIds, 
$albumsLoaded, 
$albumsToLoad 
)

Parameters:

	$rootId:
	$albumIds:
	$albumsLoaded:
	$albumsToLoad:

[ Top ]

GalleryStatus login(
array
$form, 
&$response, GalleryRemoteProperties
$response 
)

Log into Gallery

Parameters:

array	$form:	key/value pairs from Gallery Remote
GalleryRemoteProperties	$response:	a reference to our response object
	&$response:

API Tags:

Return:

a status code

[ Top ]

newAlbum [line 655]

GalleryStatus newAlbum(
array
$form, 
&$response, GalleryRemoteProperties
$response 
)

Create a new album

Parameters:

array	$form:	key/value pairs from Gallery Remote
GalleryRemoteProperties	$response:	a reference to our response object
	&$response:

API Tags:

Return:

a status code

[ Top ]

omitAuthTokenCheck [line 65]

void omitAuthTokenCheck(
)

API Tags:

See:

GalleryController::omitAuthTokenCheck

Redefinition of:

GalleryController::omitAuthTokenCheck(): Whether the controller opts-out from the framework's auth token check.

[ Top ]

setOptionInstances [line 51]

void setOptionInstances(
array
$optionInstances 
)

Tests can use this method to hardwire a specific set of option instances to use.

This avoids situations where some of the option instances will do unpredictable things and derail the tests.

Parameters:

array

$optionInstances:

(optionId => ItemAddOption, ...)

[ Top ]

_assertHasViewPermission [line 1223]

GalleryStatus _assertHasViewPermission(
int
$itemId 
)

Assert that the active user can view the specified item.

Otherwize, avoid information disclosure by acting as if the item didn't exist.

Parameters:

int

$itemId:

[ Top ]

Documentation generated on Sat, 21 Nov 2009 04:48:50 -0800 by phpDocumentor 1.3.0RC6

	Remote

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