Open Journal Systems  3.3.0
StaticPagesPlugin Class Reference
Inheritance diagram for StaticPagesPlugin:
GenericPlugin LazyLoadPlugin Plugin

Public Member Functions

 callbackHandleContent ($hookName, $args)
 
 callbackShowWebsiteSettingsTabs ($hookName, $args)
 
 getActions ($request, $actionArgs)
 
 getDescription ()
 
 getDisplayName ()
 
 getInstallSchemaFile ()
 
 getJavaScriptURL ($request)
 
 isTinyMCEInstalled ()
 
 register ($category, $path, $mainContextId=null)
 
 setupGridHandler ($hookName, $params)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ($contextId=null)
 
 getName ()
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getTemplatePath ($inCore=false)
 
 getTemplateResource ($template=null, $inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installControlledVocabs ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($args, $request)
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

Static pages plugin main class

Definition at line 17 of file StaticPagesPlugin.inc.php.

Member Function Documentation

◆ callbackHandleContent()

StaticPagesPlugin::callbackHandleContent (   $hookName,
  $args 
)

Declare the handler function to process the actual page PATH

Parameters
$hookNamestring The name of the invoked hook
$argsarray Hook parameters
Returns
boolean Hook handling status

Definition at line 95 of file StaticPagesPlugin.inc.php.

References $op, Plugin\$request, PKPApplication\get(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), StaticPagesHandler\setPage(), and StaticPagesHandler\setPlugin().

◆ callbackShowWebsiteSettingsTabs()

StaticPagesPlugin::callbackShowWebsiteSettingsTabs (   $hookName,
  $args 
)

Extend the website settings tabs to include static pages

Parameters
$hookNamestring The name of the invoked hook
$argsarray Hook parameters
Returns
boolean Hook handling status

Definition at line 77 of file StaticPagesPlugin.inc.php.

References Plugin\$request, Registry\get(), and Plugin\getTemplateResource().

◆ getActions()

StaticPagesPlugin::getActions (   $request,
  $actionArgs 
)

Get a list of link actions for plugin management.

Parameters
requestPKPRequest
$actionArgsarray The list of action args to be included in request URLs.
Returns
array List of LinkActions

Reimplemented from Plugin.

Definition at line 161 of file StaticPagesPlugin.inc.php.

References Plugin\$request, and Plugin\getEnabled().

◆ getDescription()

StaticPagesPlugin::getDescription ( )

Get a description of this plugin.

Returns
string

Reimplemented from Plugin.

Definition at line 28 of file StaticPagesPlugin.inc.php.

References isTinyMCEInstalled().

◆ getDisplayName()

StaticPagesPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

Definition at line 21 of file StaticPagesPlugin.inc.php.

◆ getInstallSchemaFile()

StaticPagesPlugin::getInstallSchemaFile ( )

Get the filename of the ADODB schema for this plugin.

Returns
string Full path and filename to schema descriptor.

Reimplemented from Plugin.

Definition at line 186 of file StaticPagesPlugin.inc.php.

References Plugin\getPluginPath().

◆ getJavaScriptURL()

StaticPagesPlugin::getJavaScriptURL (   $request)

Get the JavaScript URL for this plugin.

Definition at line 193 of file StaticPagesPlugin.inc.php.

References Plugin\$request, and Plugin\getPluginPath().

◆ isTinyMCEInstalled()

StaticPagesPlugin::isTinyMCEInstalled ( )

Check whether or not the TinyMCE plugin is installed.

Returns
boolean True iff TinyMCE is installed.

Definition at line 39 of file StaticPagesPlugin.inc.php.

References $application, and PKPApplication\get().

Referenced by getDescription().

◆ register()

StaticPagesPlugin::register (   $category,
  $path,
  $mainContextId = null 
)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

Definition at line 48 of file StaticPagesPlugin.inc.php.

References Plugin\getEnabled(), HookRegistry\register(), and DAORegistry\registerDAO().

◆ setupGridHandler()

StaticPagesPlugin::setupGridHandler (   $hookName,
  $params 
)

Permit requests to the static pages grid handler

Parameters
$hookNamestring The name of the hook being invoked
$argsarray The parameters to the invoked hook

Definition at line 147 of file StaticPagesPlugin.inc.php.

References StaticPageGridHandler\setPlugin().


The documentation for this class was generated from the following file: