PHP Class BlockPlugin, pkp-lib

Inheritance: extends Gdn_Plugin
Exibir arquivo Open project: pkp/pkp-lib Class Usage Examples

Public Methods

Method Description
__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.

Method Details

__construct() public method

Constructor
public __construct ( )

_getContextSpecificHomepageHook() public method

The application specific context home page hook name.
public _getContextSpecificHomepageHook ( ) : string
return string

callback() public method

Callback that renders the block.
public callback ( $hookName, $args ) : string
$hookName string
$args array
return string

getBlockContext() public method

..) for this block.
public getBlockContext ( $contextId = null ) : integer
$contextId int Context ID (journal/press)
return integer

getBlockTemplateFilename() public method

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
return string

getContents() public method

Get the HTML contents for this block.
public getContents ( $templateMgr, $request = null ) : string
$templateMgr object
$request PKPRequest (Optional for legacy plugins)
return string

getContextMap() public method

Get an associative array linking block context to hook name.
public getContextMap ( ) : array
return array

getEnabled() public method

Determine whether or not this plugin is currently enabled.
public getEnabled ( $contextId = null ) : boolean
$contextId int Context ID (journal/press)
return boolean

getSeq() public method

See also: 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() public method

..) for this block.
public getSupportedContexts ( ) : array
return array

register() public method

See also: Plugin::register()
public register ( $category, $path )

setBlockContext() public method

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

setEnabled() public method

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

setSeq() public method

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)