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.
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.
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().
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.
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().
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.
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.
This module's callbacks. This is a pipe (|) delimited string containing
one or more of the following values: getSiteAdminViews getItemAdminViews getUserAdminViews getSystemLinks getItemLinks getItemSummaries registerEventListeners (deprecated)
Allow this module to autoconfigure itself. It should only autoconfigure if it is
marked as needing configuration (see GalleryModule::needsConfiguration) and it should do its best to choose a reasonable configuration. Return true upon success, even if nothing has to be done to get a successful configuration. This method should accept all the module's defaults wherever possible.
API Tags:
Return:
GalleryStatus a status code boolean was module able to autoconfigure
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().
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.
Returns a set of short URL rules. Array structure:
$rule['match'] An array of view => viewName, subView => subViewName to match when generating the short URLs. $rule['pattern'] Proposed short URL style (ie 'v/%path%'). $rule['keywords'] Pattern keywords should have the same name as its coresponding url parameter key. This is an array of additional keywords defined keyword => array(pattern => regex, ignored => 1). If ignored is set, the this keyword wont be appended to the queryString. $rule['queryString'] Additional queryString parameters to append. $rule['locked'] If this is set, the user may not change the pattern. $rule['comment'] This should be a localized comment. return array($rule, ...);
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().
API Tags:
Return:
GalleryStatus a status code array( array('name' => name, 'view' => view, [optional: 'group' => group, 'groupLabel' => localized label]), ...)
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.
It may be one that is also listed in getSiteAdminViews(). As with getSiteAdminViews(), the view title text must be localized.
API Tags:
Return:
GalleryStatus a status code array(string linkId => array('text' => 'localized text', 'params' => array(key => value, key => value)) ...)
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.
Perform the module installation or upgrade, whatever is required.
It will do the following:
Get the current version of the module (if its already installed)
Request that the storage subsystem install this module's database
tables (which will also upgrade any tables that require it)
Let the module perform any necessary upgrade tasks.
Set the new module version and api requirements into the database
Modules should not need to override this method. Instead they should override the upgrade method and put all their module specific logic there.Parameters:
(optional) attempt to translate post-sprintf string using this value. This allows specific translation of strings like "Edit Album" or "Edit Photo" with a fallback to translation of "Edit %s" for other %s values. Currently only input string with single % token is supported.
