PHP Класс BlockPlugin, pkp-lib

Наследование: extends Gdn_Plugin
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( ) Constructor
_getContextSpecificHomepageHook ( ) : string The application specific context home page hook name.
callback ( $hookName, $args ) : string Callback that renders the block.
getBlockContext ( $contextId = null ) : integer Get the block context (e.g. BLOCK_CONTEXT_.
getBlockTemplateFilename ( ) : string 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.
getContents ( $templateMgr, $request = null ) : string Get the HTML contents for this block.
getContextMap ( ) : array Get an associative array linking block context to hook name.
getEnabled ( $contextId = null ) : boolean Determine whether or not this plugin is currently enabled.
getSeq ( $contextId = null )
getSupportedContexts ( ) : array Get the supported contexts (e.g. BLOCK_CONTEXT_.
register ( $category, $path )
setBlockContext ( $context, $contextId = null ) Set the block context (e.g. BLOCK_CONTEXT_.
setEnabled ( $enabled, $contextId = null ) Set whether or not this plugin is currently enabled.
setSeq ( $seq, $contextId = null ) Set the sequence information for this plugin.

Описание методов

__construct() публичный Метод

Constructor
public __construct ( )

_getContextSpecificHomepageHook() публичный Метод

The application specific context home page hook name.
public _getContextSpecificHomepageHook ( ) : string
Результат string

callback() публичный Метод

Callback that renders the block.
public callback ( $hookName, $args ) : string
$hookName string
$args array
Результат string

getBlockContext() публичный Метод

..) for this block.
public getBlockContext ( $contextId = null ) : integer
$contextId int Context ID (journal/press)
Результат integer

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.
public getBlockTemplateFilename ( ) : string
Результат string

getContents() публичный Метод

Get the HTML contents for this block.
public getContents ( $templateMgr, $request = null ) : string
$templateMgr object
$request PKPRequest (Optional for legacy plugins)
Результат string

getContextMap() публичный Метод

Get an associative array linking block context to hook name.
public getContextMap ( ) : array
Результат array

getEnabled() публичный Метод

Determine whether or not this plugin is currently enabled.
public getEnabled ( $contextId = null ) : boolean
$contextId int Context ID (journal/press)
Результат boolean

getSeq() публичный Метод

См. также: Plugin::getSeq() NB: In the case of block plugins, higher numbers move plugins down the page compared to other blocks.
public getSeq ( $contextId = null )
$contextId int Context ID (journal/press)

getSupportedContexts() публичный Метод

..) for this block.
public getSupportedContexts ( ) : array
Результат array

register() публичный Метод

См. также: Plugin::register()
public register ( $category, $path )

setBlockContext() публичный Метод

..) for this block.
public setBlockContext ( $context, $contextId = null )
$context int Sidebar context
$contextId int Context ID (journal/press)

setEnabled() публичный Метод

Set whether or not this plugin is currently enabled.
public setEnabled ( $enabled, $contextId = null )
$enabled boolean
$contextId int Context ID (journal/press)

setSeq() публичный Метод

NB: In the case of block plugins, higher numbers move plugins down the page compared to other blocks.
public setSeq ( $seq, $contextId = null )
$seq int
$contextId int Context ID (journal/press)