Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
BlockPlugin Class Reference
Inheritance diagram for BlockPlugin:
AnnouncementFeedBlockPlugin AuthorBiosBlockPlugin CustomBlockPlugin DevelopedByBlockPlugin DonationBlockPlugin ExternalFeedBlockPlugin FontSizeBlockPlugin HelpBlockPlugin InformationBlockPlugin KeywordCloudBlockPlugin LanguageToggleBlockPlugin LuceneFacetsBlockPlugin NavigationBlockPlugin NotificationBlockPlugin OpenAdsBlockPlugin ReadingToolsBlockPlugin RelatedItemsBlockPlugin RoleBlockPlugin SubscriptionBlockPlugin ThesisFeedBlockPlugin UserBlockPlugin WebFeedBlockPlugin

Public Member Functions

 _getContextSpecificHomepageHook ()
 
 BlockPlugin ()
 
 callback ($hookName, $args)
 
 getBlockContext ()
 
 getBlockTemplateFilename ()
 
 getContents (&$templateMgr, $request=null)
 
getContextMap ()
 
 getSeq ()
 
 getSupportedContexts ()
 
 register ($category, $path)
 
 setBlockContext ($context)
 
 setSeq ($seq)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

Abstract class for block plugins.

Definition at line 22 of file BlockPlugin.inc.php.

Member Function Documentation

BlockPlugin::_getContextSpecificHomepageHook ( )

The application specific context home page hook name.

Returns
string

Definition at line 173 of file BlockPlugin.inc.php.

References PKPApplication\getApplication().

Referenced by getContextMap().

BlockPlugin::BlockPlugin ( )

Constructor

Definition at line 26 of file BlockPlugin.inc.php.

BlockPlugin::callback (   $hookName,
  $args 
)

Callback that renders the block.

Parameters
$hookNamestring
$argsarray
Returns
string

Definition at line 157 of file BlockPlugin.inc.php.

References getContents(), and PKPApplication\getRequest().

BlockPlugin::getBlockContext ( )

Get the block context (e.g. BLOCK_CONTEXT_...) for this block.

Returns
int

Definition at line 82 of file BlockPlugin.inc.php.

References PKPPlugin\getContextSpecificSetting(), and PKPPlugin\getSettingMainContext().

Referenced by register().

BlockPlugin::getBlockTemplateFilename ( )

Get the filename of the template block. (Default behavior may be overridden through some combination of this function and the getContents function.) Returning null from this function results in an empty display.

Returns
string

Definition at line 133 of file BlockPlugin.inc.php.

Referenced by getContents().

BlockPlugin::getContents ( $templateMgr,
  $request = null 
)

Get the HTML contents for this block.

Parameters
$templateMgrobject
$requestPKPRequest (Optional for legacy plugins)
Returns
string

Definition at line 144 of file BlockPlugin.inc.php.

References getBlockTemplateFilename(), and PKPPlugin\getTemplatePath().

Referenced by callback().

& BlockPlugin::getContextMap ( )

Get an associative array linking block context to hook name.

Returns
array

Definition at line 112 of file BlockPlugin.inc.php.

References _getContextSpecificHomepageHook(), and HookRegistry\call().

Referenced by register().

BlockPlugin::getSeq ( )
See Also
PKPPlugin::getSeq()

NB: In the case of block plugins, higher numbers move plugins down the page compared to other blocks.

Definition at line 58 of file BlockPlugin.inc.php.

References PKPPlugin\getContextSpecificSetting(), and PKPPlugin\getSettingMainContext().

BlockPlugin::getSupportedContexts ( )

Get the supported contexts (e.g. BLOCK_CONTEXT_...) for this block.

Returns
array

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

Referenced by LuceneFacetsBlockPlugin\getBlockContext().

BlockPlugin::register (   $category,
  $path 
)
BlockPlugin::setBlockContext (   $context)

Set the block context (e.g. BLOCK_CONTEXT_...) for this block.

Parameters
$contextint

Definition at line 91 of file BlockPlugin.inc.php.

References PKPPlugin\getSettingMainContext(), and PKPPlugin\updateContextSpecificSetting().

BlockPlugin::setSeq (   $seq)

Set the sequence information for this plugin.

NB: In the case of block plugins, higher numbers move plugins down the page compared to other blocks.

Parameters
$seqint

Definition at line 73 of file BlockPlugin.inc.php.

References PKPPlugin\getSettingMainContext(), and PKPPlugin\updateContextSpecificSetting().


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