PHP 클래스 RainLab\Builder\Classes\ControlLibrary

저자: Alexey Bobkov, Samuel Georges
상속: use trait October\Rain\Support\Traits\Singleton
파일 보기 프로젝트 열기: rainlab/builder-plugin 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$controls
$groupedControls

공개 메소드들

메소드 설명
getControlInfo ( string $code ) : array Returns information about a control by its code.
getStandardProperties ( $excludeProperties = [], $addProperties = [] )
listControls ( boolean $returnGrouped = true ) : array Returns a list of all known form controls grouped by control groups.
registerControl ( string $code, string $name, string $description, string | integer $controlGroup, string $icon, array $properties, string $designTimeProviderClass ) Registers a control.

보호된 메소드들

메소드 설명
resolveControlGroupName ( $group )

메소드 상세

getControlInfo() 공개 메소드

Returns information about a control by its code.
public getControlInfo ( string $code ) : array
$code string Specifies the control code.
리턴 array Returns an associative array or null if the control is not registered.

getStandardProperties() 공개 메소드

public getStandardProperties ( $excludeProperties = [], $addProperties = [] )

listControls() 공개 메소드

Returns a list of all known form controls grouped by control groups.
public listControls ( boolean $returnGrouped = true ) : array
$returnGrouped boolean Indicates whether controls should be grouped in the result.
리턴 array

registerControl() 공개 메소드

Registers a control.
또한 보기: http://octobercms.com/docs/ui/icon
public registerControl ( string $code, string $name, string $description, string | integer $controlGroup, string $icon, array $properties, string $designTimeProviderClass )
$code string Specifies the control code, for example "codeeditor".
$name string Specifies the control name, for example "Code editor".
$description string Specifies the control descritpion, can be empty.
$controlGroup string | integer Specifies the control group. Control groups are used to create tabs in the Control Palette in Form Builder. The group could one of the ControlLibrary::GROUP_ constants or a string.
$icon string Specifies the control icon for the Control Palette.
$properties array Specifies the control properties. The property definitions should be compatible with Inspector properties, similarly to the Component properties: http://octobercms.com/docs/plugin/components#component-properties Use the getStandardProperties() of the ControlLibrary to get the standard control properties.
$designTimeProviderClass string Specifies the control design-time provider class name. The class should extend RainLab\Builder\Classes\ControlDesignTimeProviderBase. If the class is not provided, the default control design and design settings will be used.

resolveControlGroupName() 보호된 메소드

protected resolveControlGroupName ( $group )

프로퍼티 상세

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

protected $controls

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

protected $groupedControls