Class: CoreModule

Source Location: /modules/core/module.inc

Class CoreModule

Class Overview

Gallery core module.

Located in /modules/core/module.inc [line 31]

GalleryPlugin
   |
   --GalleryModule
      |
      --CoreModule

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryModule

GalleryModule::$_callbacks

GalleryModule::$_group

GalleryModule::$_requiredModuleApi

GalleryModule::$_templateVersion

Inherited From GalleryPlugin

GalleryPlugin::$_description

GalleryPlugin::$_id

GalleryPlugin::$_l10Domain

GalleryPlugin::$_name

GalleryPlugin::$_requiredCoreApi

GalleryPlugin::$_version

Inherited From GalleryModule

GalleryModule::activate()

GalleryModule::autoConfigure()

Allow this module to autoconfigure itself. It should only autoconfigure if it is

GalleryModule::deactivate()

GalleryModule::getApiVersion()

Return the major and minor version of the GalleryModule API.

GalleryModule::getCallbacks()

GalleryModule::getConfigurationView()

Get the name of the GalleryView containing the administration view specifically for configuring this module. It may be one that is also listed in getSiteAdminViews().

GalleryModule::getGroup()

GalleryModule::getItemAdminViews()

Get the list of GalleryViews containing the various item administration views for this module. The module should check permissions and item type to determine which views are applicable for the authenticated user. As with getSiteAdminViews(), the view title text must be localized.

GalleryModule::getItemLinks()

Return 0 or more item-specific links to an arbitrary module view.

GalleryModule::getItemSummaries()

Return module-specific summary content about the item

GalleryModule::getModuleEntityTypes()

Get names of all GalleryEntity types this module may register.

GalleryModule::getOnLoadHandlerIds()

Get ids of all onLoadHandlers this module may register.

GalleryModule::getPluginType()

GalleryModule::getRequiredModuleApi()

GalleryModule::getRewriteRules()

Returns a set of short URL rules. Array structure:

GalleryModule::getSiteAdminViews()

Get the name of the GalleryView containing the various site administration views for this module. Note that the text value is localized since they will be displayed directly to the user. Include group/groupLabel in data to override the values from getGroup().

GalleryModule::getSystemLinks()

Return 0 or more system-specific links to an arbitrary module view. Get the name of the GalleryView containing the administration view specifically for configuring this module.

GalleryModule::getTemplateVersion()

GalleryModule::getUserAdminViews()

Get the list of GalleryViews containing the various user administration views for this module. The module should check permissions and item type to determine which views are applicable for the authenticated user. As with getSiteAdminViews(), the view title text must be localized.

GalleryModule::installOrUpgrade()

Perform the module installation or upgrade, whatever is required.

GalleryModule::needsConfiguration()

Does this module require configuration before it can be activated?

GalleryModule::performFactoryRegistrations()

Register any factory implementations. This is called at module activation time.

GalleryModule::registerEventListeners()

Register any event listeners that this module requires. Each module will get a chance to register its event listeners before any events are posted.

GalleryModule::setCallbacks()

GalleryModule::setGroup()

GalleryModule::setRequiredModuleApi()

GalleryModule::setTemplateVersion()

GalleryModule::uninstall()

Remove this module's plugin parameters and all of its database tables.

GalleryModule::_deleteModuleEntities()

Delete all entities with a type registered by this module.

GalleryModule::_removeObsoleteThemeBlocks()

Remove obsolete blocks from existing themes (bug #1636339).

GalleryModule::_translate()

Translate string. Results are cached.

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

static array	getInstalledVersions()	Get the version of the core module and of Gallery itself. We store this on disk to avoid having to load up the database (which can be problematic if we're doing an upgrade and don't want to count a specific database schema). If the versions.dat file indicates that Gallery is in maintenance mode, then set the configuration value to indicate this.
CoreModule	CoreModule()
void	getGalleryVersion()	Get the current version of Gallery.
void	getItemAdminViews()
void	getItemLinks()
void	getSiteAdminViews()
void	getSystemLinks()
void	getUserAdminViews()
void	performFactoryRegistrations()
void	setGalleryVersion()	Set the current version of Gallery.
void	upgrade()	We pushed all this code into its own file since we need it very rarely so it doesn't make sense to load it every single time.

[ Top ]

Properties

Methods

static method getInstalledVersions [line 520]

static array getInstalledVersions(
)

Get the version of the core module and of Gallery itself. We store this on disk to avoid having to load up the database (which can be problematic if we're doing an upgrade and don't want to count a specific database schema). If the versions.dat file indicates that Gallery is in maintenance mode, then set the configuration value to indicate this.

API Tags:

Return:

'core' => core module version, 'gallery' => gallery version

[ Top ]

Constructor CoreModule [line 33]

CoreModule CoreModule(
)

[ Top ]

getGalleryVersion [line 507]

void getGalleryVersion(
)

Get the current version of Gallery.

[ Top ]

getItemAdminViews [line 371]

void getItemAdminViews(

$item 
)

Parameters:

$item:

API Tags:

See:

GalleryModule::getItemAdminViews

Redefinition of:

GalleryModule::getItemAdminViews(): Get the list of GalleryViews containing the various item administration views for this module. The module should check permissions and item type to determine which views are applicable for the authenticated user. As with getSiteAdminViews(), the view title text must be localized.

[ Top ]

getItemLinks [line 55]

void getItemLinks(

$items, 
$wantsDetailedLinks, 
$permissions, 
$userId 
)

Parameters:

	$items:
	$wantsDetailedLinks:
	$permissions:
	$userId:

API Tags:

See:

GalleryModule::getItemLinks

Redefinition of:

GalleryModule::getItemLinks(): Return 0 or more item-specific links to an arbitrary module view.

[ Top ]

getSiteAdminViews [line 304]

void getSiteAdminViews(
)

API Tags:

See:

GalleryModule::getSiteAdminViews

Redefinition of:

GalleryModule::getSiteAdminViews(): Get the name of the GalleryView containing the various site administration views for this module. Note that the text value is localized since they will be displayed directly to the user. Include group/groupLabel in data to override the values from getGroup().

[ Top ]

getSystemLinks [line 256]

void getSystemLinks(
)

API Tags:

See:

GalleryModule::getSystemLinks

Redefinition of:

GalleryModule::getSystemLinks(): Return 0 or more system-specific links to an arbitrary module view. Get the name of the GalleryView containing the administration view specifically for configuring this module.

[ Top ]

getUserAdminViews [line 342]

void getUserAdminViews(

$user 
)

Parameters:

$user:

API Tags:

See:

GalleryModule::getUserAdminViews

Redefinition of:

GalleryModule::getUserAdminViews(): Get the list of GalleryViews containing the various user administration views for this module. The module should check permissions and item type to determine which views are applicable for the authenticated user. As with getSiteAdminViews(), the view title text must be localized.

[ Top ]

performFactoryRegistrations [line 558]

void performFactoryRegistrations(
)

API Tags:

See:

GalleryModule::performFactoryRegistrations

Redefinition of:

GalleryModule::performFactoryRegistrations(): Register any factory implementations. This is called at module activation time.

[ Top ]

setGalleryVersion [line 500]

void setGalleryVersion(

$version 
)

Set the current version of Gallery.

Parameters:

$version:

[ Top ]

upgrade [line 488]

void upgrade(

$currentVersion, 
$statusMonitor 
)

We pushed all this code into its own file since we need it very rarely so it doesn't make sense to load it every single time.

Parameters:

	$currentVersion:
	$statusMonitor:

API Tags:

See:

GalleryModule::install

Redefinition of:

GalleryPlugin::upgrade(): Perform any upgrade tasks required at this point. This method is called

[ Top ]

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

	GalleryCore Classes

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