1. class
  2. Xpressengine
  3. Theme
  4. GenericTheme

GenericTheme

abstract class GenericTheme extends AbstractTheme

이 클래스는 Xpressengine에서 테마를 간편하게 구현할 수 있도록 제공하는 클래스이다. 특정 디렉토리에 지정된 형식에 맞게 테마에 필요한 파일들을 구성한 후, 이 클래스의 $path에 디렉토리의 경로를 지정하여 사용한다.

Traits

Xpressengine\Plugin\ComponentTrait
ComponentInterface를 구현한 Trait
Xpressengine\Support\MobileSupportTrait
Theme나 skin과 같이 html을 출력하는 컴포넌트에서 사용할 수 있는 Trait으로서, 컴포넌트가 mobile 버전, desktop 버전을 지원하는지에 대한 정보를 제공한다.

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 protected bool $supportDesktop from MobileSupportTrait
static protected bool $supportMobile from MobileSupportTrait
static protected ThemeHandler $handler from AbstractTheme
protected ConfigEntity $config from AbstractTheme
static protected string $path
static protected string $viewsDir
static protected array $info

Methods

static string
getId()

component의 id를 반환한다.

from ComponentTrait
static void
setId(string $id)

component의 id를 지정한다.

from ComponentTrait
static mixed
getComponentInfo(string $key = null)

information을 검색한다.

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

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

from ComponentTrait
static void
boot()

boot

from ComponentTrait
static null|string
getSettingsURI()

return settings manage uri

from ComponentTrait
static bool
supportDesktop()

desktop 버전 지원 여부를 조사한다.

static bool
supportMobile()

mobile 버전 지원 여부를 조사한다.

static bool
support(string $version)

지정된 버전을 지원하는지 조사한다.

from MobileSupportTrait
static void
setHandler(ThemeHandler $handler)

테마 핸들러를 지정한다.

from AbstractTheme
static string
getTitle()

테마의 이름을 반환한다.

from AbstractTheme
static string
getDescription()

테마의 설명을 반환한다.

from AbstractTheme
static mixed
getScreenshot()

테마의 스크린샷을 반환한다.

from AbstractTheme
static bool
hasSetting()

이 테마가 설정페이지를 제공하는 테마인지 조회한다.

array
getEditFiles()

테마 편집 페이지에서 편집할 수 있는 파일의 목록을 반환한다.

string
getSettingView(ConfigEntity $config = null)

테마 설정 페이지에 출력할 html 텍스트를 출력한다.

from AbstractTheme
View|void
renderSetting(ConfigEntity $config = null)

테마 설정 페이지에 출력할 html 텍스트를 출력한다.

array
resolveSetting(array $config)

테마 설정 페이지에서 입력된 설정값이 저장되기 전 필요한 작업을 처리한다.

void
deleteSetting(ConfigEntity $config)

생성된 테마 설정을 삭제하기 전 필요한 작업을 처리한다.

ConfigEntity
setting(ConfigEntity $config = null)

set or get config info

static mixed
getPath()

get path, example: 'plugins/myplugin/theme'

static array
info(string $key = null, mixed $default = null)

retrieve theme info from info.php file

string
render()

Get the evaluated contents of the object.

array
saveFile(string $configId, string $key, UploadedFile $file)

setting 과정에서 upload되는 파일을 저장한다.

array
removeFile(string $key)

setting 과정에서 upload되는 파일을 저장한다.

string
makeConfigView(array $info, ConfigEntity $old)

info.php에 등록돼 있는 setting 폼 리스트를 가져와 form을 생성하여 반환한다.

static string
asset(string $path, string $secure = null)

테마의 asset 파일 주소(url)를 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.

static string
view(string $view)

view name을 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.

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 53
static bool supportDesktop()

desktop 버전 지원 여부를 조사한다.

Return Value

bool desktop 버전을 지원할 경우 true

at line 63
static bool supportMobile()

mobile 버전 지원 여부를 조사한다.

Return Value

bool mobile 버전을 지원할 경우 true

in MobileSupportTrait at line 64
static bool support(string $version)

지정된 버전을 지원하는지 조사한다.

Parameters

string $version version

Return Value

bool

in AbstractTheme at line 56
static void setHandler(ThemeHandler $handler)

테마 핸들러를 지정한다.

Parameters

ThemeHandler $handler 테마 핸들러

Return Value

void

in AbstractTheme at line 66
static string getTitle()

테마의 이름을 반환한다.

Return Value

string

in AbstractTheme at line 76
static string getDescription()

테마의 설명을 반환한다.

Return Value

string

in AbstractTheme at line 86
static mixed getScreenshot()

테마의 스크린샷을 반환한다.

Return Value

mixed

at line 103
static bool hasSetting()

이 테마가 설정페이지를 제공하는 테마인지 조회한다.

Return Value

bool

at line 130
array getEditFiles()

테마 편집 페이지에서 편집할 수 있는 파일의 목록을 반환한다.

Return Value

array

in AbstractTheme at line 124
string getSettingView(ConfigEntity $config = null)

테마 설정 페이지에 출력할 html 텍스트를 출력한다.

설정폼은 자동으로 생성되며 설정폼 내부에 출력할 html만 반환하면 된다.

Parameters

ConfigEntity $config 기존에 설정된 설정값

Return Value

string

at line 149
View|void renderSetting(ConfigEntity $config = null)

테마 설정 페이지에 출력할 html 텍스트를 출력한다.

설정폼은 자동으로 생성되며 설정폼 내부에 출력할 html만 반환하면 된다.

Parameters

ConfigEntity $config config data

Return Value

View|void

at line 186
array resolveSetting(array $config)

테마 설정 페이지에서 입력된 설정값이 저장되기 전 필요한 작업을 처리한다.

사이트관리자가 테마 설정 페이지에서 저장 요청을 할 경우, 테마핸들러가 설정값을 저장하기 전에 이 메소드가 실행된다. 설정값을 보완할 필요가 있을 경우 이 메소드에서 보완하여 다시 반환하면 된다.

Parameters

array $config pure config data

Return Value

array

at line 277
void deleteSetting(ConfigEntity $config)

생성된 테마 설정을 삭제하기 전 필요한 작업을 처리한다.

사이트 관리자가 테마 설정 페이지에서 삭제 요청을 할 경우, 테마핸들러가 설정값을 삭제하기 전에 이 메소드가 실행된다.

Parameters

ConfigEntity $config config data

Return Value

void

at line 309
ConfigEntity setting(ConfigEntity $config = null)

set or get config info

Parameters

ConfigEntity $config config data

Return Value

ConfigEntity

at line 73
static mixed getPath()

get path, example: 'plugins/myplugin/theme'

Return Value

mixed

at line 86
static array info(string $key = null, mixed $default = null)

retrieve theme info from info.php file

Parameters

string $key info field
mixed $default default value

Return Value

array

at line 113
string render()

Get the evaluated contents of the object.

Return Value

string

at line 213
protected array saveFile(string $configId, string $key, UploadedFile $file)

setting 과정에서 upload되는 파일을 저장한다.

Parameters

string $configId config id
string $key config field key
UploadedFile $file file

Return Value

array

at line 256
protected array removeFile(string $key)

setting 과정에서 upload되는 파일을 저장한다.

Parameters

string $key config field key

Return Value

array

at line 296
protected string makeConfigView(array $info, ConfigEntity $old)

info.php에 등록돼 있는 setting 폼 리스트를 가져와 form을 생성하여 반환한다.

Parameters

array $info setting form info
ConfigEntity $old old config data

Return Value

string

at line 325
static string asset(string $path, string $secure = null)

테마의 asset 파일 주소(url)를 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.

Parameters

string $path path가 주어질 경우 주어진 파일의 URL을 반환한다. path는 테마의 assets 디렉토리 내에서의 상대 경로이어야 한다.
string $secure https 여부

Return Value

string

at line 338
static string view(string $view)

view name을 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.

Parameters

string $view view name

Return Value

string