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

Class: GalleryView

Source Location: /modules/core/classes/GalleryView.class

Class GalleryView

Direct descendents
Child Class Description
AdminSelfRegistrationView Settings for Registration
ConfirmRegistrationView This view shows a confirmation that the users account was activated
SelfRegistrationSuccessView This view will show a registration confirmation for the user
UserSelfRegistrationView This view will prompt for data to create a new user
AdminNetPbmView Settings for NetPbm
ShowTreeView This view will show a tree of elements starting with the current item
UploadAppletSiteAdminView Settings for Upload Applet
AdminMembersView Settings for Members
MembersProfileView This view will allow users to view a members profile
MembersItemsView This view will allow users to view a members uploaded items
MembersListView This view will allow users to view the member list
ExternalCSSView Generate CSS when no frames are selected
ExternalView Render image block for use in external pages.
ImageBlockSiteAdminView Settings for Image Block
SampleView Show sample of all image frames
CSSView Display CSS needed to render image frames.
AdminImageMagickView Settings for ImageMagick
UserAlbumSiteAdminView Settings for User Albums
SlideshowView Display the slideshow
SlideshowMediaRssView Display the slideshow
AdminSlideshowView Settings for Slideshow
DownloadPicLensView Download PicLens code
AdminSitemapView Information about Google Sitemap
SitemapView Create an appropriate Google Sitemap for this site.
SearchScanView Perform a search
SearchShowAllView Perform a search; show all results from a particular search provider
ActivationWarningView Post-activation message about URL rewrite
PermalinksSiteAdminView Settings for Permalinks
NewDirectoryView This view implements the Nokia Image Uploader API's 'New Directory' command.
LoginView This view implements the Nokia Image Uploader API's 'Login' command.
ConfigureView Initial setup for NokiaUpload
RemoteStorageCapabilitiesView This view implements the Nokia Image Uploader API's 'Remote Storage Capabilities' query.
DirectoryListingView This view implements the Nokia Image Uploader API's 'Retrieve Directory Listing' command.
UploadView This view implements the Nokia Image Uploader API's 'Upload' command.
AdminEcardView Settings for eCards
ConfirmationView Confirmation page
SendEcardView This view will show an eCard form
ItemCreateReplicaSingleView This view lets you choose where you want to put the new replica
ItemCreateReplicaView This view lets you choose where you want to put the new replicas
AdminRewriteView Settings for URL Rewrite
DownloadItemView Provides downloading of binary items
FileNotFoundView View for 404 Not Found
SetupRewriteView Initial setup for URL Rewrite
AdminGdView Settings for GD
NewItemsSiteAdminView Settings for New Items
SwitchDetailModeView This view provides raw html for the exif block, used in ajax calls to switch mode.
AdminExifView Settings for Exif
MultiLangSiteAdminView Settings for MultiLang
CantActivateView A view to display when there's no toolkit support for this module.
UserWatermarksView Manage user watermarks
ConfirmDeleteView Confirm delete of a watermark
WatermarkSiteAdminView Manage watermarks available for all users
UserWatermarkEditView Edit default placement and settings for a watermark image
WatermarkSiteAdminEditView Edit default placement and settings for a watermark image
ConfigureMultirootView Multiroot setup assistant
ConfirmPicasaImportView Confirm selections before performing import
ImportResultsView Migration results
SelectPicasaExportPathView First step of import process
PasswordEntryView View that shows user a password entry box, allowing them to the enter the password for an item.
AdminFfmpegView Settings for ffmpeg
EditFeedView This view will show a form to generate an URL to an RSS feed.
FeedListView This view will show a list of feeds.
RenderView Render the Feed
RssSiteAdminView Settings for RSS
ItemAddSiteAdminView Settings for Item Add
FulfillmentErrorView This view is for letting the user know that there was an error with photo fulfilment
IconsSiteAdminView Settings for Icons
ZipCartAdminView Settings for Zip Cart
DownloadView This view sends the zip file and deletes the temp file.
ThumbnailSiteAdminView Thumbnail manager
RatingSiteAdminView Settings for Ratings
RatingAlbumView Dynamic album view to show highly rated items.
RatingCallbackView This view handles calls from the javascript (AJAX) side and returns data by printing results.
ViewTestConfigView
ViewTestAdminView
ViewTestItemView
ViewTestNoAutoCacheControlItemView
FooView
MainTest_FakeView Fake view that returns a bogus body template path so that it seems like a real view.
MainTestImmediateView
MainTestImmediateItemView
MainTestImmediateItemNoAutoCacheView
ThemeTestView Test view
ItemMakeHighlightView This view will prompt for which ancestor album to set the highlight
ShowItemErrorView This view will show an error message when an item cannot be displayed
AdminEditGroupView This view will show options available to groups
SiteAdminView This view will show the availiable site-admin options
ItemDeleteView This view will prompt for selecting items to delete
AdminCoreView This view will prompt for general Gallery settings
SimpleCallbackView This view lets you make very simple callbacks to the framework to get very specific data.
UserAdminView This view will present the available options to administer a user
UserRecoverPasswordConfirmView This view shows information about password recovery
ItemAddView This view will show the selected plugin for adding items to the gallery
AdminDeleteUserView This view will prompt for confirmation to delete a user
PluginCallbackView This view lets you make very simple callbacks to the framework to get very specific data.
ItemReorderView This view will prompt for how to change the order of items in the album
ItemMoveView This view will prompt for which items to move and where is the destination.
UserRecoverPasswordDownloadView This view sends the administrator login key for password recovery
UserLoginView This view prompts for login information
MaintenanceModeView View to display message when site is down for maintenance.
ItemAddAlbumView This view will prompt for the data for a new album to be created
ItemDeleteJsView Generate JavaScript for deleting item
AdminMaintenanceView This view will show available maintenance tasks
AdminEditGroupUsersView This view will show the possibilities of user-group mappings for a specified group.
UserRecoverPasswordAdminView This view shows information about password recovery
UserPreferencesView This view will show a form to change user options
ItemEditView This view will show options to edit an item
ItemEditCaptionsView This view will allow the user to edit many item captions at once.
UserChangePasswordView This view will show a form to change a password
AdminUsersView This view will show available options to administer the users of Gallery
ItemAddConfirmationView This view will show confirmation of newly added items
UserRecoverPasswordView This view shows information about password recovery
AdminRepositoryView This view will show all repository-related features.
ProgressBarView This is a null view that we use to indicate to the theme that it should render a progress bar.
AdminCreateGroupView This view will prompt for data to create a new group
AdminPluginsView This view will show administration options for available plugins
AdminEditUserView This view will show a form to change user options
AdminThemesView This view will show administration options for available themes
ShowItemView Handle the rendering of an album or item.
AdminGroupsView This view will show available options to administer the groups of Gallery
AdminCreateUserView This view will prompt for data to create a new user
ItemAdminView This view will present the available options to administrate an item/album
AdminPerformanceView Update performance settings
AdminDeleteGroupView This view will prompt for confirmation to delete a group
ErrorPageView This view prepares all the information the theme requires to render an error page.
ItemMoveSingleView This view will prompt for the destination of moving this item
ItemPermissionsView This view will prompt for permission settings of an item
AdminToolkitPriorityView This view will show toolkits and their relative priorities
AdminRepositoryDownloadView This view will show all repository-related features.
RepositoryCallbackView This view lets you make very simple callbacks to the framework to get very specific data.
AdminEventLogViewerView This view will let Site Admins browse the event log.
AdminEventLogViewerCallbackView This immediate view provides the backend for callbacks made by the AJAX AdminEventLogViewerView.
CombinedJavascriptView Pack many Javascript files together and download them all at once.
AdminLanguageManagerView This view will show all repository-related features.
ChooseObjectsView Form to prepare G1 migration
ConfirmImportView Confirm selections before performing G1 migration
SelectGalleryView First step of migration process
RedirectView View returns .htaccess file
ViewCartView View cart contents and available cart actions
AdminDcrawView Settings for dcraw
RearrangeItemsView This view will display an interface to reorder all album items at once.
SlideshowAppletView Show the slideshow applet
SlideshowAppletSiteAdminView Settings for Slideshow Applet
PrintPhotosView This view creates a form to send data to shutterfly.com
LinkItemSiteAdminView Settings for Link Items
FotokastenSiteAdminView Settings for Fotokasten
UploadedItemView Empty view used when the photo is successfully uploaded.
NewAlbumView View to create a new album for the photos.
OptionsView View to set options on how photos are uploaded.
DownloadRegistryFileView Generates the Windows registry file for web publishing.
SelectAlbumView View to select the album to add photos to.
UploadItemsView View to process the uploading of photos from Windows XP.
PublishXpLoginView View to initialize the process of publishing photos.
AdminGetid3View Settings for getid3
ArchiveUploadSiteAdminView Settings for Archive Upload
MimeAdminView Settings for Mime types
MimeEditView Edit settings for a mime type
RemoteSiteAdminView Settings for Remote
GalleryRemoteView This is an immediate view that emits well formed Gallery Remote protocol 2 output
GalleryRemoteWebStartView Generate a WebStart jnpl file to kick off Gallery Remote
WebCamSiteAdminView Settings for Webcam images
PanoramaSiteAdminView Settings for Panorama
PanoramaView Show image in panorama viewer
SquareThumbSiteAdminView Settings for square thumbnails
AlbumSelectSiteAdminView Settings for Album Select
ShowAllCommentsView This view will show all comments stored in the Gallery
EditCommentView This view shows a form to edit a comment
AddCommentView This view will show a form to add a new comment to an item
DeleteCommentView This view will ask for a confirmation to delete a comment
ShowCommentsView This view will show the comments stored for an item
CommentChangeConfirmationView Confirm a change to a comment
CommentSiteAdminView Settings for comments
CommentCallbackView This view handles Ajax calls.
AdminModerateSpamView This view will show all comments stored in the Gallery
CaptchaConfigAdminView Show the user which required GD functions are missing. They can't install the module, and there's nothing we can do about it.
CaptchaSiteAdminView Settings for Captcha
CaptchaImageView Display the current captcha image for this session
RandomHighlightSiteAdminView Settings for Random Highlight
KeywordAlbumView Dynamic album view using a query on keywords
KeywordAlbumSiteAdminView Settings for Keyword Albums
AdminDigibugView Settings for Digibug
DigibugPrintPhotosView This view creates a form to send data to digibug.com
AdminEditUserQuotaView This view will show options available to user quotas
AdminDeleteUserQuotaView This view will prompt for confirmation to delete a user quota
AdminQuotasView This view will show available options to add/remove/edit User/Group Quotas
AdminEditGroupQuotaView This view will show options available to group quotas
AdminCreateUserQuotaView This view will prompt for data to create a new user
AdminCreateGroupQuotaView This view will prompt for data to create a new group
AdminDeleteGroupQuotaView This view will prompt for confirmation to delete a group quota
CustomFieldSiteAdminView Settings for custom fields
UpdatesAlbumView Dynamic album view of recent additions
DynamicAlbumSiteAdminView Settings for Dynamic Albums
HttpAuthSiteAdminView Show configuration warnings and settings to site admins.
HttpAuthWorksView Reflect the HTTP authtype, username, and password so we can check that Gallery can access them.
FinishLogoutView Check that logout was successful and warn the user to close the browser window if not.
TryLogoutView Try to clear the browser's authentication cache by as many tricks as possible and redirect to a
WebDavView The WebDAV view generates WebDAV responses.
WebDavMountView Show WebDAV mount instructions.
WebDavSiteAdminView Show configuration warnings and settings to site admins.
DownloadDavMountView Mount WebDAV resource using mime type. RFC4609.
WebDavWorksView Check that Gallery handles WebDAV request methods.
AdminJpegtranView Settings for Jpegtran
AdminSnapGalaxyView Settings for SnapGalaxy
NotificationItemAdminView This view shows all event / method preferences for the user on a per-item basis.
NotificationUserAdminView This view shows all event / method settings on a per-user basis.
NotificationSiteAdminView This view shows all the event / method settings on a site-wide basis.
ItemEditOptionTestImmediateStatusView Test ImmediateStatusView implementation

[ Top ]
Property Summary
string   $_l10Domain   The localization domain for this view.

[ Top ]
Method Summary
static array   loadView()   Load a view.
static GalleryStatus   setStandardTemplateVariables()   Set standard user information available for every view.
static array   _loadTheme()   Load the given theme if it's active.
bool   autoCacheControl()   Method to opt-in to managed HTTP cache control
array   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.
array   getItem()   Return the current item, as specified in the itemId request variable.
string   getL10Domain()   Get the localization domain for this view.
array   getViewDescription()   This should return a description of the current view.
view   getViewType()   Type of view.
void   init()   Initialize the view.
boolean   isAllowedInEmbedOnly()   Does this view allow direct access even in embed-only mode?
boolean   isAllowedInMaintenance()   Does this view allow access to non-admins when site is in maintenance mode?
bool   isControllerLike()   Does this view change any data? Only controllers should change data, but AJAX and some immediate views are handled in views in Gallery.
boolean   isImmediate()   Is this an immediate or a buffered view?
array   loadTemplate()   Load the template with data from this view.
array   loadThemeAndParameters()   Load theme, theme parameters and item to use for this view.
array   loadThemeForItem()   Get the theme for this item by finding the theme id for the nearest album.
GalleryStatus   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.
GalleryStatus   setCacheControl()   Set cache headers for sensitive pages
boolean   shouldSaveSession()   Should session be saved and session cookie sent when this view is accessed?
array   _getItem()   Return the current item, as specified in the itemId request variable.
array   _getThemeAndParametersByEvent()   Let non-core code override the theme and its parameters for this request.
array   _permissionCheck()   Process possible permission errors when accessing a view.

[ Top ]
Properties
string   $_l10Domain [line 48]

The localization domain for this view.

API Tags:
Access:  private


[ Top ]
Methods
static method loadView  [line 149]

  static array loadView( string $viewName  )

Load a view.

Be very security conscious about checking the inputs for possible misuse. The view name is in the format <module>.<classname>, where

  • <module> is the module the view belongs to
  • <classname> is the name of the .inc-file to be loaded. The class that is loaded is the <classname>View, that must extend GalleryView class

Parameters:
string   $viewName:  a view name in the format <module>.<classname> (eg 'core.ShowItem')

API Tags:
Return:  GalleryStatus a status code GalleryView a view


[ Top ]
static method setStandardTemplateVariables  [line 664]

  static GalleryStatus setStandardTemplateVariables( &$template, GalleryTemplate $template  )

Set standard user information available for every view.

Parameters:
GalleryTemplate   $template: 
   &$template: 


[ Top ]
static method _loadTheme  [line 557]

  static array _loadTheme( string $themeId  )

Load the given theme if it's active.

Parameters:
string   $themeId: 

API Tags:
Return:  GalleryStatus a status code GalleryTheme theme or null
Access:  private


[ Top ]
autoCacheControl  [line 585]

  bool autoCacheControl( )

Method to opt-in to managed HTTP cache control

Override this method in a view to opt-out from the managed cache control and to set the cache headers yourself. (Like isImmediate() and similar methods)


API Tags:
Return:  (default true) to opt-in to itemId oriented cache control


Redefined in descendants as:

[ Top ]
doLoadTemplate  [line 229]

  array doLoadTemplate( &$template  )

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.

Parameters:
   &$template: 

API Tags:
Return:  GalleryStatus a status code array ('body' => string template or 'redirect' => array or 'returnUrl' => string redirection URL) GalleryTheme the current theme


[ Top ]
getItem  [line 350]

  array getItem( [bool $checkPermissions = true]  )

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

If not itemId is specified as request variable the default album is returned.

Parameters:
bool   $checkPermissions:  (optional) Default true. Whether to enforce the required (view) permission.

API Tags:
Return:  GalleryStatus a status code GalleryItem an item boolean true if item was specified, false if default was used


Redefined in descendants as:

[ Top ]
getL10Domain  [line 335]

  string getL10Domain( )

Get the localization domain for this view.



[ Top ]
getViewDescription  [line 327]

  array getViewDescription( )

This should return a description of the current view.

It might return a static description or generate a dynamic description using the current request status


API Tags:
Return:  GalleryStatus string localized description


Redefined in descendants as:

[ Top ]
init  [line 56]

  void init( string $moduleId  )

Initialize the view.

Parameters:
string   $moduleId:  the name of the module


[ Top ]
isAllowedInMaintenance  [line 98]

  boolean isAllowedInMaintenance( )

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



Redefined in descendants as:

[ Top ]
isControllerLike  [line 115]

  bool isControllerLike( )

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


API Tags:
Return:  true if the view changes data


Redefined in descendants as:

[ Top ]
loadTemplate  [line 90]

  array loadTemplate( &$template, &$form, GalleryTemplate $template, array $form  )

Load the template with data from this view.

Parameters:
GalleryTemplate   $template: 
array   $form:  the form values
   &$template: 
   &$form: 

API Tags:
Return:  GalleryStatus a status code array ('body' => string template or 'redirect' => array)


Redefined in descendants as:

[ Top ]
loadThemeAndParameters  [line 404]

  array loadThemeAndParameters( )

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


API Tags:
Return:  GalleryStatus a status code GalleryTheme a theme instance, or null on loadPlugin failure array theme parameters GalleryItem item context


Redefined in descendants as:

[ Top ]
loadThemeForItem  [line 450]

  array loadThemeForItem( [GalleryItem $item = null]  )

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

Parameters:
GalleryItem   $item:  (optional) omit or pass null to load default theme

API Tags:
Return:  GalleryStatus a status code GalleryTheme a theme instance (can be null) array theme parameters (only set if loaded via event)


[ Top ]
renderImmediate  [line 78]

  GalleryStatus renderImmediate( array $status, array $error  )

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

Parameters:
array   $status:  any status information from a delegating controller
array   $error:  any error information from a delegating controller

API Tags:
Return:  a status code


Redefined in descendants as:

[ Top ]
setCacheControl  [line 595]

  GalleryStatus setCacheControl( &$template, [string $access = null], GalleryTemplate $template  )

Set cache headers for sensitive pages

Parameters:
GalleryTemplate   $template:  (optional) Adding HTML cache headers to this template
string   $access:  (optional) no-cache
   &$template: 


[ Top ]
shouldSaveSession  [line 123]

  boolean shouldSaveSession( )

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



Redefined in descendants as:

[ Top ]
_getItem  [line 392]

  array _getItem( )

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


API Tags:
Return:  GalleryStatus a status code GalleryItem an item boolean true if item was specified, false if default was used
Deprecated:  Please use getItem() instead.


[ Top ]
_getThemeAndParametersByEvent  [line 502]

  array _getThemeAndParametersByEvent( GalleryItem $item  )

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

Parameters:
GalleryItem   $item:  The item defining the context of the request.

API Tags:
Return:  GalleryStatus A status code, GalleryTheme|null The theme to be used for this request, array Theme parameters, see GalleryTheme::fetchParameters()
Access:  private


[ Top ]
_permissionCheck  [line 703]

  array _permissionCheck( GalleryStatus $ret  )

Process possible permission errors when accessing a view.

If the given status indicates permission denied or missing object and this is a guest user, redirect to the login view. Otherwise return given status to be shown by the error handler. Missing object is treated like permission denied to avoid information disclosure by trying URLs with different ids.

Parameters:
GalleryStatus   $ret:  or null

API Tags:
Return:  for return from GalleryView::loadTemplate or null
Access:  protected


[ Top ]

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