Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
OpenAdsBlockPlugin Class Reference
Inheritance diagram for OpenAdsBlockPlugin:
BlockPlugin

Public Member Functions

 getContents (&$templateMgr)
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getName ()
 
getOpenAdsPlugin ()
 
 getPluginPath ()
 
 getTemplatePath ()
 
- Public Member Functions inherited from BlockPlugin
 _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

OpenAds plugin class, block component.

Definition at line 18 of file OpenAdsBlockPlugin.inc.php.

Member Function Documentation

OpenAdsBlockPlugin::getContents ( $templateMgr)

Get the contents of the CMS plugin TOC.

Parameters
$templateMgrobject
Returns
string

Definition at line 81 of file OpenAdsBlockPlugin.inc.php.

References Request\getJournal(), and getOpenAdsPlugin().

OpenAdsBlockPlugin::getDescription ( )

Get the description of this plugin

Returns
string

Definition at line 54 of file OpenAdsBlockPlugin.inc.php.

OpenAdsBlockPlugin::getDisplayName ( )

Get the display name of this plugin

Returns
string

Definition at line 46 of file OpenAdsBlockPlugin.inc.php.

OpenAdsBlockPlugin::getEnabled ( )

Determine whether or not this plugin is enabled.

Returns
boolean

Definition at line 106 of file OpenAdsBlockPlugin.inc.php.

References getOpenAdsPlugin().

OpenAdsBlockPlugin::getHideManagement ( )

Hide this plugin from the management interface (it's subsidiary)

Definition at line 30 of file OpenAdsBlockPlugin.inc.php.

OpenAdsBlockPlugin::getName ( )

Get the symbolic name of this plugin

Returns
string

Definition at line 38 of file OpenAdsBlockPlugin.inc.php.

& OpenAdsBlockPlugin::getOpenAdsPlugin ( )

Get the actual CMS plugin

Returns
object

Definition at line 97 of file OpenAdsBlockPlugin.inc.php.

References PluginRegistry\getPlugin().

Referenced by getContents(), getEnabled(), getPluginPath(), and getTemplatePath().

OpenAdsBlockPlugin::getPluginPath ( )

Override the builtin to get the correct plugin path.

Returns
string

Definition at line 62 of file OpenAdsBlockPlugin.inc.php.

References getOpenAdsPlugin().

OpenAdsBlockPlugin::getTemplatePath ( )

Override the builtin to get the correct template path.

Returns
string

Definition at line 71 of file OpenAdsBlockPlugin.inc.php.

References getOpenAdsPlugin().


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