phpDocumentor Themes
Siriux
[ class tree: Themes ] [ index: Themes ] [ all elements ]

Class: SiriuxTheme

Source Location: /themes/siriux/theme.inc

Class SiriuxTheme

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GalleryTheme

GalleryTheme::$_cacheablePage
GalleryTheme::$_requiredThemeApi
GalleryTheme::$_standardSettings

Inherited From GalleryPlugin

GalleryPlugin::$_description
GalleryPlugin::$_id
GalleryPlugin::$_l10Domain
GalleryPlugin::$_name
GalleryPlugin::$_requiredCoreApi
GalleryPlugin::$_version

Inherited From GalleryTheme

GalleryTheme::GalleryTheme()
Constructor to prevent PHP Notices in upgrader and AdminThemes.inc when old themes with a theme.inc are still in the themes folder. The old themes call $this->GalleryTheme() in their constructor.
GalleryTheme::activate()
GalleryTheme::deactivate()
GalleryTheme::getApiVersion()
Return the major and minor version of the GalleryTheme API.
GalleryTheme::getPageSize()
Return the number of items per page, or 0 if there is no pagination in this theme.
GalleryTheme::getPluginType()
GalleryTheme::getRequiredThemeApi()
GalleryTheme::getSettings()
Return the possible settings that a theme can specify on a global or per item basis. Used for theme with simple settings (@see isAdvancedSettings)
GalleryTheme::getStandardSettings()
GalleryTheme::handleSettingsRequest()
Let the theme handle the incoming request. Used for theme with advanced settings.
GalleryTheme::installOrUpgrade()
Perform the module installation or upgrade, whatever is required. It will do the following:
  1. Get the current version of the theme (if its already installed)
  2. Let the theme perform any necessary upgrade tasks.
GalleryTheme::isAdvancedSettings()
Return whether the theme uses simple or advanced settings. To support simple settings the theme needs to implement getSettings and validateSettings To support advanced settings the theme must implement loadSettingsTemplate and handleSettingsRequest.
GalleryTheme::loadCommonTemplateData()
Load commonly used data into theme template.
GalleryTheme::loadSettingsTemplate()
Load the template with data to define the theme settings. Used for theme with advanced settings.
GalleryTheme::loadTemplate()
Load the template with data from this view.
GalleryTheme::packSetting()
Convert a setting from a string format into a PHP native format. The string format is
GalleryTheme::preloadBlock()
Call preload for given block if the module is active and a preload exists.
GalleryTheme::setRequiredThemeApi()
GalleryTheme::setStandardSettings()
GalleryTheme::showAdminPage()
Load all the necessary template data to render a page for an administrative (or other) view.
GalleryTheme::showAlbumPage()
Load all the necessary template data to render a page for an album.
GalleryTheme::showErrorPage()
Load all the necessary template data to render an error page.
GalleryTheme::showModulePage()
Load all the necessary template data to render a page for a module view (any views that aren't user, site, or item admin eg slideshow or members list).
GalleryTheme::showPhotoPage()
Load all the necessary template data to render a page for a single item.
GalleryTheme::showProgressBarPage()
Load all the necessary template data to render a progress bar page.
GalleryTheme::splitHtml()
Split the HTML content into its various component pieces.
GalleryTheme::uninstall()
Remove this theme from all albums.
GalleryTheme::unpackSetting()
Unpack a packed setting.
GalleryTheme::validateSettings()
Check the values of the settings for legality. If there are errors, return an array of localized error messages to display for each invalid setting. Used for theme with simple settings (@see isAdvancedSettings)
GalleryTheme::_sortItemLinks()
Sort an array of associative arrays on the 'text' key.

Inherited From GalleryPlugin

GalleryPlugin::activate()
Activate this plugin
GalleryPlugin::deactivate()
Deactivate this plugin.
GalleryPlugin::fetchParameters()
Fetch all plugin specific parameters for the given item. The results will contain a mixture of global parameters and item specific parameters, where the item specific ones ones override the global ones.
GalleryPlugin::getDescription()
GalleryPlugin::getId()
GalleryPlugin::getL10Domain()
GalleryPlugin::getName()
GalleryPlugin::getParameter()
Convenience method to get a plugin parameter
GalleryPlugin::getPluginType()
GalleryPlugin::getRequiredCoreApi()
GalleryPlugin::getVersion()
GalleryPlugin::installOrUpgrade()
Perform the plugin installation or upgrade, whatever is required.
GalleryPlugin::isActive()
Is this plugin active?
GalleryPlugin::reactivate()
Reactivate this plugin. The plugin is already active, so call deactivate() and then activate(). Perform the deactivation without sending an event because the activation will immediately follow and we don't want other plugins to sense this deactivation and deactivate themselves. If the plugin isn't currently active, don't do anything.
GalleryPlugin::removeParameter()
Convenience method to remove a plugin parameter
GalleryPlugin::setDescription()
GalleryPlugin::setId()
GalleryPlugin::setName()
GalleryPlugin::setParameter()
Convenience method to set a plugin parameter
GalleryPlugin::setRequiredCoreApi()
GalleryPlugin::setVersion()
GalleryPlugin::translate()
Localize the given content.
GalleryPlugin::uninstall()
Remove this plugin's parameters
GalleryPlugin::upgrade()
Perform any upgrade tasks required at this point. This method is called
GalleryPlugin::_flushPluginCache()
Flush plugin-related caches.
GalleryPlugin::_postDeactivationEvent()
Post a deactivation event for this plugin. Used by deactivate and reactivate.

[ Top ]
Method Summary
SiriuxTheme   SiriuxTheme()  
void   getSettings()  
void   showAdminPage()  
void   showAlbumPage()  
void   showErrorPage()  
void   showModulePage()  
void   showPhotoPage()  
void   showProgressBarPage()  
void   validateSettings()  

[ Top ]
Methods
Constructor SiriuxTheme  [line 35]

  SiriuxTheme SiriuxTheme( )



[ Top ]
getSettings  [line 179]

  void getSettings( [ $itemId = null]  )

Parameters:
   $itemId: 

API Tags:
See:  GalleryTheme::getSettings


Redefinition of:
GalleryTheme::getSettings()
Return the possible settings that a theme can specify on a global or per item basis. Used for theme with simple settings (@see isAdvancedSettings)

[ Top ]
showAdminPage  [line 142]

  void showAdminPage( &$template, $item, $params, $templateFile  )

Parameters:
   &$template: 
   $item: 
   $params: 
   $templateFile: 

API Tags:
See:  GalleryTheme::showAdminPage


Redefinition of:
GalleryTheme::showAdminPage()
Load all the necessary template data to render a page for an administrative (or other) view.

[ Top ]
showAlbumPage  [line 60]

  void showAlbumPage( &$template, $item, $params, $childIds  )

Parameters:
   &$template: 
   $item: 
   $params: 
   $childIds: 

API Tags:
See:  GalleryTheme::showAlbumPage


Redefinition of:
GalleryTheme::showAlbumPage()
Load all the necessary template data to render a page for an album.

[ Top ]
showErrorPage  [line 159]

  void showErrorPage( &$template  )

Parameters:
   &$template: 

API Tags:
See:  GalleryTheme::showErrorPage


Redefinition of:
GalleryTheme::showErrorPage()
Load all the necessary template data to render an error page.

[ Top ]
showModulePage  [line 124]

  void showModulePage( &$template, $item, $params, $templateFile  )

Parameters:
   &$template: 
   $item: 
   $params: 
   $templateFile: 

API Tags:
See:  GalleryTheme::showModulePage


Redefinition of:
GalleryTheme::showModulePage()
Load all the necessary template data to render a page for a module view (any views that aren't user, site, or item admin eg slideshow or members list).

[ Top ]
showPhotoPage  [line 101]

  void showPhotoPage( &$template, $item, $params  )

Parameters:
   &$template: 
   $item: 
   $params: 

API Tags:
See:  GalleryTheme::showPhotoPage


Redefinition of:
GalleryTheme::showPhotoPage()
Load all the necessary template data to render a page for a single item.

[ Top ]
showProgressBarPage  [line 166]

  void showProgressBarPage( &$template, $item, $params  )

Parameters:
   &$template: 
   $item: 
   $params: 

API Tags:
See:  GalleryTheme::showProgressBarPage


Redefinition of:
GalleryTheme::showProgressBarPage()
Load all the necessary template data to render a progress bar page.

[ Top ]
validateSettings  [line 208]

  void validateSettings( $settings  )

Parameters:
   $settings: 

API Tags:
See:  GalleryTheme::validateSettings


Redefinition of:
GalleryTheme::validateSettings()
Check the values of the settings for legality. If there are errors, return an array of localized error messages to display for each invalid setting. Used for theme with simple settings (@see isAdvancedSettings)

[ Top ]

Documentation generated on Fri, 03 Oct 2008 06:16:35 -0700 by phpDocumentor 1.3.0RC6