PHP 클래스 Horde_Core_Block, horde

저자: Mike Cochrane ([email protected])

저자: Jan Schneider ([email protected])

저자: Michael Slusarz ([email protected])

공개 프로퍼티들

프로퍼티	타입	설명
$autoUpdateMethod	string	The method to use to render the block when Horde_Ajax_Application_Handler#blockAutoUpdate is called instead of the default of Horde_Core_Block#getContent By default, we call _content()
$enabled	boolean	Is this block enabled?
$updateable	boolean	Whether this block has changing content.

보호된 프로퍼티들

프로퍼티	타입	설명
$_app	string	Application that this block originated from.
$_name	string	Block name. Should be set in the constructor.
$_params	array	Block specific parameters.

공개 메소드들

메소드	설명
__construct ( string $app, array \| boolean $params = [] )	Constructor.
getAjaxUpdate ( Horde_Variables $vars ) : string	The data to send on an AJAX update request.
getApp ( ) : string	Returns the application that this block belongs to.
getContent ( ) : string	Returns the content for this block.
getName ( ) : string	Return the block name.
getParamValues ( ) : array	Returns a hash of block parameters and their configured values.
getParams ( ) : array	Returns any settable parameters for this block.
getTitle ( ) : string	Returns the text to go in the title of this block.
refreshContent ( Horde_Variables $vars ) : string	Returns the content for this block in response to a user requested update from within the block.

보호된 메소드들

메소드	설명
_ajaxUpdate ( Horde_Variables $vars ) : string	Returns this block's content for AJAX updates.
_ajaxUpdateUrl ( ) : Horde_Url	Return the URL to use for AJAX update requests.
_call ( string $name, mixed $default, mixed $args = null ) : mixed	Calls the application driver in the proper context.
_content ( ) : string	Returns this block's content.
_params ( ) : array	Returns the parameters needed by block.
_refreshContent ( Horde_Variables $vars ) : string	Stub to be overridden by concrete block that supports user-initiated updating of content via ajax.
_title ( ) : string	Returns the title to go in this block.

메소드 상세

__construct() 공개 메소드

Constructor.

public __construct ( string $app, array \| boolean $params = [] )
$app	string	The application name.
$params	array \| boolean	Any parameters the block needs. If false, the default parameter will be used.

_ajaxUpdate() 보호된 메소드

Returns this block's content for AJAX updates.

protected _ajaxUpdate ( Horde_Variables $vars ) : string
$vars	Horde_Variables	The form variables for the request.
리턴	string	The update content.

_ajaxUpdateUrl() 보호된 메소드

Return the URL to use for AJAX update requests.

protected _ajaxUpdateUrl ( ) : Horde_Url
리턴	Horde_Url	The update URL.

_call() 보호된 메소드

Calls the application driver in the proper context.

protected _call ( string $name, mixed $default, mixed $args = null ) : mixed
$name	string	string
$default	mixed
$args	mixed
리턴	mixed

_content() 추상적인 보호된 메소드

Returns this block's content.

abstract protected _content ( ) : string
리턴	string	The block's content.

_params() 보호된 메소드

Returns the parameters needed by block.

protected _params ( ) : array
리턴	array	The block's parameters.

_refreshContent() 보호된 메소드

Stub to be overridden by concrete block that supports user-initiated updating of content via ajax.

protected _refreshContent ( Horde_Variables $vars ) : string
$vars	Horde_Variables
리턴	string

_title() 보호된 메소드

Returns the title to go in this block.

protected _title ( ) : string
리턴	string	The block title.

getAjaxUpdate() 공개 메소드

The data to send on an AJAX update request.

public getAjaxUpdate ( Horde_Variables $vars ) : string
$vars	Horde_Variables	The form variables for the request.
리턴	string	Update data.

getApp() 공개 메소드

Returns the application that this block belongs to.

public getApp ( ) : string
리턴	string	The application name.

getContent() 공개 메소드

This function handles the changing of current application as needed so code is executed in the scope of the application the block originated from.

public getContent ( ) : string
리턴	string	The block's content.

getName() 공개 메소드

Return the block name.

public getName ( ) : string
리턴	string	The block name.

getParamValues() 공개 메소드

Returns a hash of block parameters and their configured values.

public getParamValues ( ) : array
리턴	array	Parameter values.

getParams() 공개 메소드

It does *not* reference $this->_params; that is for runtime parameters (the choices made from these options).

public getParams ( ) : array
리턴	array	The block's configurable parameters.

getTitle() 공개 메소드

This function handles the changing of current application as needed so code is executed in the scope of the application the block originated from.

public getTitle ( ) : string
리턴	string	The block's title.

refreshContent() 공개 메소드

This function handles the changing of current application as needed so code is executed in the scope of the application the block originated from.

public refreshContent ( Horde_Variables $vars ) : string
$vars	Horde_Variables
리턴	string	The block's content.

프로퍼티 상세

$_app 보호되어 있는 프로퍼티

Application that this block originated from.

protected string $_app
리턴	string

$_name 보호되어 있는 프로퍼티

Block name. Should be set in the constructor.

protected string $_name
리턴	string

$_params 보호되어 있는 프로퍼티

Block specific parameters.

protected array $_params
리턴	array

$autoUpdateMethod 공개적으로 프로퍼티

The method to use to render the block when Horde_Ajax_Application_Handler#blockAutoUpdate is called instead of the default of Horde_Core_Block#getContent By default, we call _content()

부터: 2.12.0

public string $autoUpdateMethod
리턴	string

$enabled 공개적으로 프로퍼티

Is this block enabled?

public bool $enabled
리턴	boolean

$updateable 공개적으로 프로퍼티

Whether this block has changing content.

public bool $updateable
리턴	boolean