CmsBlockPlugin Class Reference
[Plugins_generic_cms]
CMS plugin class, block component.
More...
Public Member Functions | |
| & | getCmsPlugin () |
| getContents (&$templateMgr) | |
| getDescription () | |
| getDisplayName () | |
| getEnabled () | |
| getName () | |
| getPluginPath () | |
| getSupportedContexts () | |
| getTemplatePath () | |
Detailed Description
CMS plugin class, block component.Definition at line 20 of file CmsBlockPlugin.inc.php.
Member Function Documentation
| & CmsBlockPlugin.getCmsPlugin | ( | ) |
Get the actual CMS plugin
- Returns:
- object
Definition at line 97 of file CmsBlockPlugin.inc.php.
References PluginRegistry.getPlugin().
Referenced by getContents(), getDescription(), getEnabled(), getPluginPath(), and getTemplatePath().
| CmsBlockPlugin.getContents | ( | &$ | templateMgr | ) |
Get the contents of the CMS plugin TOC.
- Parameters:
-
$templateMgr object
- Returns:
- string
Reimplemented from BlockPlugin.
Definition at line 80 of file CmsBlockPlugin.inc.php.
References getCmsPlugin(), and Request.getJournal().
| CmsBlockPlugin.getDescription | ( | ) |
Get the description of this plugin
- Returns:
- string
Reimplemented from BlockPlugin.
Definition at line 41 of file CmsBlockPlugin.inc.php.
References getCmsPlugin(), and Locale.translate().
| CmsBlockPlugin.getDisplayName | ( | ) |
Get the display name of this plugin
- Returns:
- string
Reimplemented from BlockPlugin.
Definition at line 33 of file CmsBlockPlugin.inc.php.
References Locale.translate().
| CmsBlockPlugin.getEnabled | ( | ) |
Determine whether or not this plugin is enabled.
- Returns:
- boolean
Reimplemented from BlockPlugin.
Definition at line 106 of file CmsBlockPlugin.inc.php.
References getCmsPlugin().
| CmsBlockPlugin.getName | ( | ) |
Get the symbolic name of this plugin
- Returns:
- string
Reimplemented from BlockPlugin.
Definition at line 25 of file CmsBlockPlugin.inc.php.
| CmsBlockPlugin.getPluginPath | ( | ) |
Override the builtin to get the correct plugin path.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 53 of file CmsBlockPlugin.inc.php.
References getCmsPlugin().
| CmsBlockPlugin.getSupportedContexts | ( | ) |
Get the supported contexts (e.g. BLOCK_CONTEXT_...) for this block.
- Returns:
- array
Reimplemented from BlockPlugin.
Definition at line 71 of file CmsBlockPlugin.inc.php.
| CmsBlockPlugin.getTemplatePath | ( | ) |
Override the builtin to get the correct template path.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 62 of file CmsBlockPlugin.inc.php.
References getCmsPlugin().
The documentation for this class was generated from the following file:
- plugins/generic/cms/CmsBlockPlugin.inc.php
