PHP Class BlockPlugin, pkp-lib

Inheritance: extends Gdn_Plugin
Afficher le fichier Open project: pkp/pkp-lib Class Usage Examples

Méthodes publiques

Méthode 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 méthode

Constructor
public __construct ( )

_getContextSpecificHomepageHook() public méthode

The application specific context home page hook name.
public _getContextSpecificHomepageHook ( ) : string
Résultat string

callback() public méthode

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

getBlockContext() public méthode

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

getBlockTemplateFilename() public méthode

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
Résultat string

getContents() public méthode

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

getContextMap() public méthode

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

getEnabled() public méthode

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

getSeq() public méthode

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 méthode

..) for this block.
public getSupportedContexts ( ) : array
Résultat array

register() public méthode

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

setBlockContext() public méthode

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

setEnabled() public méthode

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

setSeq() public méthode

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)