PHP Class Xpressengine\Widget\AbstractWidget

Widget 를 Xpressengine 에 등록하려면 이 추상 클래스를 상속받은 클래스를 작성하여야 한다.
See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: implements Xpressengine\Plugin\ComponentInterface, implements Illuminate\Contracts\Support\Renderable, use trait Xpressengine\Plugin\ComponentTrait
Show file Open project: xpressengine/xpressengine

Public Properties

Property Type Description
$ratingWhiteList array

Protected Properties

Property Type Description
$config
$data

Public Methods

Method Description
__construct ( array | null $config = null ) AbstractWidget constructor.
getDescription ( ) : string 위젯의 설명을 반환한다.
getTitle ( ) : string 위젯의 이름을 반환한다.
renderSetting ( array $args = [] ) : string 위젯 설정 페이지에 출력할 폼을 출력한다.
renderSkin ( array $data ) : string 지정된 스킨을 통해 widget을 출력한다.
resolveSetting ( array $inputs = [] ) : array 사용자가 위젯 설정 페이지에 입력한 설정값을 저장하기 전에 전처리 한다.
setting ( array $config = null ) : array | void 현재 위젯에 지정된 설정값을 조회하거나, 저장한다.

Protected Methods

Method Description
init ( ) : void 위젯을 생성할 때 필요한 초기화 작업을 여기에 작성하세요.

Method Details

__construct() public method

AbstractWidget constructor.
public __construct ( array | null $config = null )
$config array | null widget config data

getDescription() public static method

위젯의 설명을 반환한다.
public static getDescription ( ) : string
return string

getTitle() public static method

위젯의 이름을 반환한다.
public static getTitle ( ) : string
return string

init() protected method

위젯을 생성할 때 필요한 초기화 작업을 여기에 작성하세요.
protected init ( ) : void
return void

renderSetting() public method

위젯 설정 페이지에 출력할 폼을 출력한다.
public renderSetting ( array $args = [] ) : string
$args array 설정값
return string

renderSkin() public method

지정된 스킨을 통해 widget을 출력한다.
public renderSkin ( array $data ) : string
$data array 스킨에 전달할 데이터
return string

resolveSetting() public method

사용자가 위젯 설정 페이지에 입력한 설정값을 저장하기 전에 전처리 한다.
public resolveSetting ( array $inputs = [] ) : array
$inputs array 사용자가 입력한 설정값
return array

setting() public method

현재 위젯에 지정된 설정값을 조회하거나, 저장한다.
public setting ( array $config = null ) : array | void
$config array 저장할 설정값, null일 경우 이 메소드는 저장된 설정값을 반환한다.
return array | void

Property Details

$config protected property

protected $config

$data protected property

protected $data

$ratingWhiteList public static property

public static array $ratingWhiteList
return array