PHP 클래스 BlockPlugin, pkp-lib

상속: extends Gdn_Plugin
파일 보기 프로젝트 열기: pkp/pkp-lib 1 사용 예제들

공개 메소드들

메소드 설명
__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.

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)