GalleryCore

Packages:

Gallery
AlbumSelect
ArchiveUpload
Captcha
Cart
ColorPack
Comment
CustomField
Dcraw
Debug
Digibug
DynamicAlbum
Ecard
Exif
Ffmpeg
FlashVideo
Fotokasten
GalleryCore
Gd
Getid3
Hidden
HttpAuth
Icons
ImageBlock
ImageFrame
ImageMagick
Install
ItemAdd
Jpegtran
KeyAlbum
LinkItem
Members
Migrate
Mime
MP3Audio
MultiLang
Multiroot
NetPbm
NewItems
NokiaUpload
Notification
Panorama
Password
Permalinks
PhotoAccess
Picasa
PublishXp
Quotas
RandomHighlight
Rating
Rearrange
Registration
Remote
Replica
Reupload
Rewrite
Rss
Search
Shutterfly
Sitemap
SizeLimit
Slideshow
SlideshowApplet
SnapGalaxy
SquareThumb
Themes
Thumbnail
ThumbPage
Tools
Upgrade
UploadApplet
UserAlbum
Watermark
WebCam
WebDav
ZipCart

Files:

Callbacks.inc
CoreModuleExtras.inc
module.inc

Classes
BuildDerivativesTask.class
ConvertDatabaseToUtf8Task.class
CoreCaptchaAdminOption.class
DatabaseBackupTask.class
DatabaseLockSystem.class
DeleteSessionsTask.class
FlockLockSystem.class
FlushDatabaseCacheTask.class
FlushTemplatesTask.class
Gallery.class
GalleryAlbumItem.class
GalleryAnimationItem.class
GalleryAuthPlugin.class
GalleryCapabilities.class
GalleryChildEntity.class
GalleryConstants.class
GalleryController.class
GalleryCoreApi.class
GalleryCoreSearch.class
GalleryDataCache.class
GalleryDataItem.class
GalleryDerivative.class
GalleryDerivativeImage.class
GalleryDynamicAlbum.class
GalleryEmbed.class
GalleryEntity.class
GalleryEvent.class
GalleryEventListener.class
GalleryFileSystemEntity.class
GalleryGroup.class
GalleryItem.class
GalleryLockSystem.class
GalleryModule.class
GalleryMovieItem.class
GalleryPersistent.class
GalleryPhotoItem.class
GalleryPhpVm.class
GalleryPlatform.class
GalleryPlugin.class
GalleryRenderer.class
GalleryRepository.class
GalleryRepositoryIndex.class
GalleryRepositoryUtilities.class
GallerySession.class
GallerySmarty.class
GallerySortInterface_1_2.class
GalleryStatus.class
GalleryStorage.class
GalleryTemplate.class
GalleryTemplateAdapter.class
GalleryTheme.class
GalleryToolkit.class
GalleryTranslator.class
GalleryUnknownItem.class
GalleryUrlGenerator.class
GalleryUser.class
GalleryUtilities.class
GalleryValidationPlugin.class
GalleryView.class
OptimizeDatabaseTask.class
ResetViewCountsTask.class
SetOriginationTimestampTask.class
SystemInfoTask.class

Platform
UnixPlatform.class
WinNtPlatform.class

Storage
Db2Storage.class
GalleryDatabaseExport.class
GalleryDatabaseImport.class
GalleryStorageExtras.class
MSSqlStorage.class
OracleStorage.class
PostgreSqlStorage.class
SQLiteStorage.class

UserInterface
AdminCore.inc
AdminCreateGroup.inc
AdminCreateUser.inc
AdminDeleteGroup.inc
AdminDeleteUser.inc
AdminEditGroup.inc
AdminEditGroupUsers.inc
AdminEditUser.inc
AdminEventLogViewer.inc
AdminEventLogViewerCallback.inc
AdminGroups.inc
AdminLanguageManager.inc
AdminMaintenance.inc
AdminPerformance.inc
AdminPlugins.inc
AdminRepository.inc
AdminRepositoryDownload.inc
AdminRepositoryDownloadAndInstallController.class
AdminThemes.inc
AdminToolkitPriority.inc
AdminUsers.inc
ChangeLanguage.inc
CombinedJavascript.inc
CreateThumbnailOption.inc
DownloadItem.inc
ErrorPage.inc
ItemAdd.inc
ItemAddAlbum.inc
ItemAddConfirmation.inc
ItemAddFromBrowser.inc
ItemAdmin.inc
ItemDelete.inc
ItemDeleteJs.inc
ItemDeleteSingle.inc
ItemEdit.inc
ItemEditAlbum.inc
ItemEditAnimation.inc
ItemEditCaptions.inc
ItemEditItem.inc
ItemEditMovie.inc
ItemEditPhoto.inc
ItemEditPhotoThumbnail.inc
ItemEditRotateAndScalePhoto.inc
ItemEditTheme.inc
ItemMakeHighlight.inc
ItemMove.inc
ItemMoveSingle.inc
ItemPermissions.inc
ItemReorder.inc
Logout.inc
MaintenanceMode.inc
PluginCallback.inc
ProgressBar.inc
RepositoryCallback.inc
ShowItem.inc
ShowItemError.inc
SimpleCallback.inc
SiteAdmin.inc
UserAdmin.inc
UserChangePassword.inc
UserLogin.inc
UserPreferences.inc
UserRecoverPassword.inc
UserRecoverPasswordAdmin.inc
UserRecoverPasswordConfirm.inc
UserRecoverPasswordDownload.inc

Classes:

UserInterface
AdminCoreController
AdminCoreView
AdminCreateGroupController
AdminCreateGroupView
AdminCreateUserController
AdminCreateUserView
AdminDeleteGroupController
AdminDeleteGroupView
AdminDeleteUserController
AdminDeleteUserView
AdminEditGroupController
AdminEditGroupUsersController
AdminEditGroupUsersView
AdminEditGroupView
AdminEditUserController
AdminEditUserView
AdminEventLogViewerCallbackView
AdminEventLogViewerView
AdminGroupsController
AdminGroupsView
AdminLanguageManagerController
AdminLanguageManagerView
AdminMaintenanceController
AdminMaintenanceView
AdminPerformanceController
AdminPerformanceView
AdminPluginsView
AdminRepositoryController
AdminRepositoryDownloadAndInstallController
AdminRepositoryDownloadController
AdminRepositoryDownloadView
AdminRepositoryView
AdminThemesController
AdminThemesView
AdminToolkitPriorityController
AdminToolkitPriorityView
AdminUsersController
AdminUsersView
ChangeLanguageController
CombinedJavascriptView
CreateThumbnailOption
DownloadItemView
ErrorPageView
ItemAddAlbumController
ItemAddAlbumView
ItemAddConfirmationView
ItemAddController
ItemAddFromBrowser
ItemAddOption
ItemAddPlugin
ItemAddView
ItemAdminView
ItemDeleteController
ItemDeleteJsView
ItemDeleteSingleController
ItemDeleteView
ItemEditAlbum
ItemEditAnimation
ItemEditCaptionsController
ItemEditCaptionsView
ItemEditController
ItemEditItem
ItemEditMovie
ItemEditOption
ItemEditPhoto
ItemEditPhotoThumbnail
ItemEditPlugin
ItemEditRotateAndScalePhoto
ItemEditTheme
ItemEditView
ItemMakeHighlightController
ItemMakeHighlightView
ItemMoveController
ItemMoveSingleController
ItemMoveSingleView
ItemMoveView
ItemPermissionsController
ItemPermissionsView
ItemReorderController
ItemReorderView
LogoutController
MaintenanceModeView
MaintenanceTask
PluginCallbackView
ProgressBarView
RepositoryCallbackView
ShowItemController
ShowItemErrorView
ShowItemView
SimpleCallbackView
SiteAdminView
UserAdminView
UserChangePasswordController
UserChangePasswordView
UserLoginController
UserLoginView
UserPreferencesController
UserPreferencesView
UserRecoverPasswordAdminController
UserRecoverPasswordAdminView
UserRecoverPasswordConfirmController
UserRecoverPasswordConfirmView
UserRecoverPasswordController
UserRecoverPasswordDownloadView
UserRecoverPasswordView

Classes
BuildDerivativesTask
ConvertDatabaseToUtf8Task
CoreCaptchaAdminOption
CoreModule
DatabaseBackupTask
DatabaseLockSystem
DeleteSessionsTask
FlockLockSystem
FlushDatabaseCacheTask
FlushTemplatesTask
Gallery
GalleryAlbumItem
GalleryAnimationItem
GalleryAuthPlugin
GalleryCapabilities
GalleryChildEntity
GalleryController
GalleryCoreApi
GalleryCoreSearch
GalleryDataCache
GalleryDataItem
GalleryDerivative
GalleryDerivativeImage
GalleryDynamicAlbum
GalleryEmbed
GalleryEntity
GalleryEvent
GalleryEventListener
GalleryFileSystemEntity
GalleryGroup
GalleryItem
GalleryLockSystem
GalleryModule
GalleryMovieItem
GalleryPersistent
GalleryPhotoItem
GalleryPhpVm
GalleryPlatform
GalleryPlugin
GalleryRenderer
GalleryRepository
GalleryRepositoryIndex
GalleryRepositoryUtilities
GallerySession
GallerySmarty
GallerySortInterface_1_2
GalleryStatus
GalleryStorage
GalleryTemplate
GalleryTemplateAdapter
GalleryTheme
GalleryToolkit
GalleryTranslator
GalleryUnknownItem
GalleryUrlGenerator
GalleryUser
GalleryUtilities
GalleryValidationPlugin
GalleryView
MockStatusMonitor
OptimizeDatabaseTask
ResetViewCountsTask
SessionAuthPlugin
SetOriginationTimestampTask
SystemInfoTask

CoreCallbacks
CoreModuleExtras

Storage
Db2Storage
GalleryDatabaseExport
GalleryDatabaseImport
GallerySearchResults
GallerySqlFragment
GalleryStorageExtras
GalleryXmlProcessor
MSSqlStorage
MySqlStorage
OracleStorage
PostgreSqlStorage
SQLiteStorage

Platform
UnixPlatform
WinNtPlatform

Class: ItemEditOption

Source Location: /modules/core/ItemEdit.inc

Class ItemEditOption

Class Overview

Interface for options to the ItemEdit view and controller.

Options allow us to provide extra UI in the views and extra processing in the controller so that we can add new functionality to various ItemEditPlugins

Located in /modules/core/ItemEdit.inc [line 473]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
HiddenItemOption	ItemEditOption for hiding an item
ImageBlockOption	This option selects whether an album may be included in image blocks
PermalinksOption	This edit option allows you to create Permalinks for your item
SizeLimitOption	This ItemEditOption allows the user to set size limits for an album.
PasswordOption	ItemEditOption for adding password protection to an item or album
CustomThumbnailOption	ItemEditOption for uploading a custom thumbnail for an item
RatingItemEdit	This ItemEdit option will handle storing rating options for Gallery albums
ItemEditControllerTestOption	Test ItemEditOption that returns warnings and errors and doesn't require a progress bar.
ItemEditControllerTestOptionWithProgressBar	Test ItemEditOption that returns warnings and errors and requires a progress bar.
ReuploadPhotoOption	This ItemEditOption will handle the reupload of a photo
LinkItemOption	ItemEditOption for editing the target of a LinkItem
PanoramaOption	This ItemEditOption will handle adding/removing the Panorama renderer
RandomHighlightOption	This ItemEditOption allows the user to activate random highlight for an album.

[ Top ]

Method Summary

static array	getAllOptions()	Return all the available option plugins
array	handleRequestAfterEdit()	Let the plugin handle the incoming request. We expect the $item to be locked.
array	isAppropriate()	Is this option appropriate at this time?
array	loadTemplate()	Load the template with data from this plugin
boolean	requiresProgressBar()	Will this task run so long that it requires a progress bar?

[ Top ]

Methods

static method getAllOptions [line 485]

static array getAllOptions(
string
$editPlugin, GalleryItem
$item, GalleryDerivative
$thumbnail 
)

Return all the available option plugins

Parameters:

string	$editPlugin:	name of ItemEditPlugin
GalleryItem	$item:
GalleryDerivative	$thumbnail:

API Tags:

Return:

GalleryStatus a status code array ItemEditOption instances

[ Top ]

handleRequestAfterEdit [line 539]

array handleRequestAfterEdit(
array
$form, 
&$item, 
&$preferred, GalleryItem
$item, GalleryDerivative
$preferred 
)

Let the plugin handle the incoming request. We expect the $item to be locked.

Parameters:

array	$form:	the form values
GalleryItem	$item:	reference to the item
GalleryDerivative	$preferred:	reference to preferred derivative
	&$item:
	&$preferred:

API Tags:

Return:	GalleryStatus a status code array error messages array localized warning messages
See:	GalleryController::handleRequest

Redefined in descendants as:

[ Top ]

isAppropriate [line 551]

array isAppropriate(
GalleryItem
$item, GalleryDerivative
$thumbnail 
)

Is this option appropriate at this time?

Parameters:

GalleryItem	$item:
GalleryDerivative	$thumbnail:

API Tags:

Return:

GalleryStatus a status code boolean true or false

Redefined in descendants as:

[ Top ]

loadTemplate [line 524]

array loadTemplate(

&$template, 
&$form, GalleryItem
$item, 
$thumbnail, GalleryTemplate
$template, array
$form 
)

Load the template with data from this plugin

Parameters:

GalleryTemplate	$template:
array	$form:	the form values
GalleryItem	$item:
	&$template:
	&$form:
	$thumbnail:

API Tags:

Return:	GalleryStatus a status code string the path to a template file to include string localization domain for the template file
See:	GalleryView::loadTemplate

Redefined in descendants as:

[ Top ]

requiresProgressBar [line 561]

boolean requiresProgressBar(
array
$form 
)

Will this task run so long that it requires a progress bar?

Parameters:

array

$form:

the state of the current form

Redefined in descendants as:

[ Top ]

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

	GalleryCore UserInterface

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