PHP 클래스 Elgg\WidgetDefinition

Helper class for defining a widget
파일 보기 프로젝트 열기: elgg/elgg 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$context In which contexts is the widget available
$description Description of the widget
$id Identifier of the widget
$multiple Can the widget be added multiple times
$name Readable name of the widget

공개 메소드들

메소드 설명
__construct ( string $id ) WidgetDefinition constructor
__get ( string $name ) : mixed Magic getter to return the deprecated attribute 'handler'
factory ( array $options ) : WidgetDefinition Create an WidgetDefinition from an associative array. Required key is id.

메소드 상세

__construct() 공개 메소드

WidgetDefinition constructor
public __construct ( string $id )
$id string Identifier of the widget

__get() 공개 메소드

Magic getter to return the deprecated attribute 'handler'
public __get ( string $name ) : mixed
$name string attribute to get
리턴 mixed

factory() 공개 정적인 메소드

Create an WidgetDefinition from an associative array. Required key is id.
public static factory ( array $options ) : WidgetDefinition
$options array Option array of key value pairs id => STR Widget identifier (required) name => STR Name of the widget description => STR Description of the widget context => ARRAY contexts in which the widget is available multiple => BOOL can the widget be added multiple times
리턴 WidgetDefinition

프로퍼티 상세

$context 공개적으로 프로퍼티

In which contexts is the widget available
public $context

$description 공개적으로 프로퍼티

Description of the widget
public $description

$id 공개적으로 프로퍼티

Identifier of the widget
public $id

$multiple 공개적으로 프로퍼티

Can the widget be added multiple times
public $multiple

$name 공개적으로 프로퍼티

Readable name of the widget
public $name