abstract class AbstractWidget implements ComponentInterface, Renderable

이 클래스는 Xpressengine 에서 Widget 구현할 때 필요한 추상클래스이다.

Widget 를 Xpressengine 에 등록하려면 이 추상 클래스를 상속받은 클래스를 작성하여야 한다.

Traits

ComponentInterface를 구현한 Trait

Properties

static private array $id Component id, 만약 이 trait을 사용한 클래스를 상속한 클래스가 id를 지정하지 않았다면, 그 클래스의 id는 이 trait에서 가지고 있는 id에 저장된다. from ComponentTrait
static private array $componentInfo Component Informations, 만약 이 trait을 사용한 클래스를 상속한 클래스가 componentInfo를 지정하지 않았다면, 그 클래스의 infomation은 이 trait에서 가지고 있는 componentInfo에 저장된다. from ComponentTrait
static array $ratingWhiteList
protected $config
protected $data

Methods

static string
getId()

component의 id를 반환한다.

static void
setId(string $id)

component의 id를 지정한다.

static mixed
getComponentInfo(string $key = null)

information을 검색한다.

static void
setComponentInfo(string $key, mixed $value = null)

information을 추가하거나 수정한다.

static void
boot()

boot

static null|string
getSettingsURI()

return settings manage uri

__construct(array|null $config = null)

AbstractWidget constructor.

void
init()

위젯을 생성할 때 필요한 초기화 작업을 여기에 작성하세요.

static string
getTitle()

위젯의 이름을 반환한다.

static string
getDescription()

위젯의 설명을 반환한다.

string
renderSkin(array $data)

지정된 스킨을 통해 widget을 출력한다.

string
renderSetting(array $args = array())

위젯 설정 페이지에 출력할 폼을 출력한다.

array
resolveSetting(array $inputs = array())

사용자가 위젯 설정 페이지에 입력한 설정값을 저장하기 전에 전처리 한다.

array|void
setting(array $config = null)

현재 위젯에 지정된 설정값을 조회하거나, 저장한다.

Details

in ComponentTrait at line 51
static string getId()

component의 id를 반환한다.

Return Value

string

in ComponentTrait at line 67
static void setId(string $id)

component의 id를 지정한다.

Parameters

string $id 지정할 id

Return Value

void

in ComponentTrait at line 83
static mixed getComponentInfo(string $key = null)

information을 검색한다.

Parameters

string $key 검색할 information의 키

Return Value

mixed 검색된 information를 반환함.

in ComponentTrait at line 99
static void setComponentInfo(string $key, mixed $value = null)

information을 추가하거나 수정한다.

Parameters

string $key 추가하거나 수정할 information의 key
mixed $value 추가하거나 수정할 information의 value

Return Value

void

in ComponentTrait at line 119
static void boot()

boot

Return Value

void

in ComponentTrait at line 129
static null|string getSettingsURI()

return settings manage uri

Return Value

null|string

at line 52
__construct(array|null $config = null)

AbstractWidget constructor.

Parameters

array|null $config widget config data

at line 63
protected void init()

위젯을 생성할 때 필요한 초기화 작업을 여기에 작성하세요.

Return Value

void

at line 72
static string getTitle()

위젯의 이름을 반환한다.

Return Value

string

at line 82
static string getDescription()

위젯의 설명을 반환한다.

Return Value

string

at line 94
string renderSkin(array $data)

지정된 스킨을 통해 widget을 출력한다.

Parameters

array $data 스킨에 전달할 데이터

Return Value

string

at line 111
string renderSetting(array $args = array())

위젯 설정 페이지에 출력할 폼을 출력한다.

Parameters

array $args 설정값

Return Value

string

at line 123
array resolveSetting(array $inputs = array())

사용자가 위젯 설정 페이지에 입력한 설정값을 저장하기 전에 전처리 한다.

Parameters

array $inputs 사용자가 입력한 설정값

Return Value

array

at line 135
array|void setting(array $config = null)

현재 위젯에 지정된 설정값을 조회하거나, 저장한다.

Parameters

array $config 저장할 설정값, null일 경우 이 메소드는 저장된 설정값을 반환한다.

Return Value

array|void