Open Journal Systems  3.3.0
LazyLoadPlugin Class Reference
Inheritance diagram for LazyLoadPlugin:
Plugin BlockPlugin GenericPlugin PaymethodPlugin PKPPubIdPlugin ThemePlugin AnnouncementFeedBlockPlugin BrowseBlockPlugin CustomBlockPlugin DevelopedByBlockPlugin InformationBlockPlugin LanguageToggleBlockPlugin MakeSubmissionBlockPlugin SubscriptionBlockPlugin UsageStatsOptoutBlockPlugin WebFeedBlockPlugin AnnouncementFeedPlugin BrowseBySectionPlugin CitationStyleLanguagePlugin CustomBlockManagerPlugin DefaultTranslationPlugin DRIVERPlugin DublinCoreMetaPlugin GoogleAnalyticsPlugin GoogleScholarPlugin HtmlArticleGalleyPlugin HypothesisPlugin LensGalleyPlugin MarkupPlugin OrcidProfilePlugin PdfJsViewerPlugin PKPAcronPlugin PKPUsageEventPlugin PKPViewableFilePlugin PLNPlugin RecommendByAuthorPlugin RecommendBySimilarityPlugin StaticPagesPlugin SubscriptionSSOPlugin SwordPlugin TexturePlugin TinyMCEPlugin UsageStatsPlugin WebFeedPlugin ManualPaymentPlugin PaypalPaymentPlugin PubIdPlugin BootstrapThreeThemePlugin CriticalTimesThemePlugin DefaultThemePlugin HealthSciencesThemePlugin ImmersionThemePlugin

Public Member Functions

 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ($contextId=null)
 
 getName ()
 
 register ($category, $path, $mainContextId=null)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDirName ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 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

Definition at line 19 of file LazyLoadPlugin.inc.php.

Member Function Documentation

◆ getCanDisable()

LazyLoadPlugin::getCanDisable ( )

Determine whether the plugin can be disabled.

Returns
boolean

Reimplemented from Plugin.

Reimplemented in TinyMCEPlugin.

Definition at line 93 of file LazyLoadPlugin.inc.php.

◆ getCanEnable()

LazyLoadPlugin::getCanEnable ( )

Determine whether the plugin can be enabled.

Returns
boolean

Reimplemented from Plugin.

Definition at line 86 of file LazyLoadPlugin.inc.php.

◆ getCurrentContextId()

LazyLoadPlugin::getCurrentContextId ( )

Get the current context ID or the site-wide context ID (0) if no context can be found.

Definition at line 101 of file LazyLoadPlugin.inc.php.

References PKPApplication\get().

Referenced by BlockPlugin\getEnabled(), getEnabled(), OrcidProfilePlugin\register(), BlockPlugin\setEnabled(), and setEnabled().

◆ getEnabled()

LazyLoadPlugin::getEnabled (   $contextId = null)

Determine whether or not this plugin is currently enabled.

Parameters
$contextIdinteger 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

Reimplemented in CustomBlockPlugin, UsageStatsOptoutBlockPlugin, PKPUsageEventPlugin, and BlockPlugin.

Definition at line 61 of file LazyLoadPlugin.inc.php.

References getCurrentContextId(), Plugin\getSetting(), and Plugin\isSitePlugin().

◆ getName()

◆ register()

LazyLoadPlugin::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 Plugin.

Reimplemented in UsageStatsPlugin, MarkupPlugin, ThemePlugin, PLNPlugin, CitationStyleLanguagePlugin, StaticPagesPlugin, OrcidProfilePlugin, PaypalPaymentPlugin, ManualPaymentPlugin, PKPAcronPlugin, TexturePlugin, WebFeedPlugin, CustomBlockManagerPlugin, DefaultTranslationPlugin, PKPUsageEventPlugin, DRIVERPlugin, RecommendByAuthorPlugin, RecommendBySimilarityPlugin, SwordPlugin, PKPPubIdPlugin, URNPubIdPlugin, BrowseBySectionPlugin, DOIPubIdPlugin, AnnouncementFeedPlugin, DublinCoreMetaPlugin, GoogleAnalyticsPlugin, GoogleScholarPlugin, HtmlArticleGalleyPlugin, LensGalleyPlugin, TinyMCEPlugin, HypothesisPlugin, PdfJsViewerPlugin, and SubscriptionSSOPlugin.

Definition at line 27 of file LazyLoadPlugin.inc.php.

References Plugin\addLocaleData().

◆ setEnabled()

LazyLoadPlugin::setEnabled (   $enabled)

Set whether or not this plugin is currently enabled.

Parameters
$enabledboolean

Definition at line 75 of file LazyLoadPlugin.inc.php.

References getCurrentContextId(), Plugin\isSitePlugin(), and Plugin\updateSetting().


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