OpenAdsBlockPlugin Class Reference
[Plugins_generic_openAds]
OpenAds plugin class, block component.
More...
Public Member Functions | |
| getContents (&$templateMgr) | |
| getDescription () | |
| getDisplayName () | |
| getEnabled () | |
| getName () | |
| & | getOpenAdsPlugin () |
| getPluginPath () | |
| getSupportedContexts () | |
| getTemplatePath () | |
Detailed Description
OpenAds plugin class, block component.Definition at line 20 of file OpenAdsBlockPlugin.inc.php.
Member Function Documentation
| OpenAdsBlockPlugin.getContents | ( | &$ | templateMgr | ) |
Get the contents of the CMS plugin TOC.
- Parameters:
-
$templateMgr object
- Returns:
- string
Reimplemented from BlockPlugin.
Definition at line 76 of file OpenAdsBlockPlugin.inc.php.
References Request.getJournal(), and getOpenAdsPlugin().
| OpenAdsBlockPlugin.getDescription | ( | ) |
Get the description of this plugin
- Returns:
- string
Reimplemented from BlockPlugin.
Definition at line 41 of file OpenAdsBlockPlugin.inc.php.
References Locale.translate().
| OpenAdsBlockPlugin.getDisplayName | ( | ) |
Get the display name of this plugin
- Returns:
- string
Reimplemented from BlockPlugin.
Definition at line 33 of file OpenAdsBlockPlugin.inc.php.
References Locale.translate().
| OpenAdsBlockPlugin.getEnabled | ( | ) |
Determine whether or not this plugin is enabled.
- Returns:
- boolean
Reimplemented from BlockPlugin.
Definition at line 101 of file OpenAdsBlockPlugin.inc.php.
References getOpenAdsPlugin().
| OpenAdsBlockPlugin.getName | ( | ) |
Get the symbolic name of this plugin
- Returns:
- string
Reimplemented from BlockPlugin.
Definition at line 25 of file OpenAdsBlockPlugin.inc.php.
| & OpenAdsBlockPlugin.getOpenAdsPlugin | ( | ) |
Get the actual CMS plugin
- Returns:
- object
Definition at line 92 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
Reimplemented from Plugin.
Definition at line 49 of file OpenAdsBlockPlugin.inc.php.
References getOpenAdsPlugin().
| OpenAdsBlockPlugin.getSupportedContexts | ( | ) |
Get the supported contexts (e.g. BLOCK_CONTEXT_...) for this block.
- Returns:
- array
Reimplemented from BlockPlugin.
Definition at line 67 of file OpenAdsBlockPlugin.inc.php.
| OpenAdsBlockPlugin.getTemplatePath | ( | ) |
Override the builtin to get the correct template path.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 58 of file OpenAdsBlockPlugin.inc.php.
References getOpenAdsPlugin().
The documentation for this class was generated from the following file:
- plugins/generic/openAds/OpenAdsBlockPlugin.inc.php
