PHP Class Xpressengine\Theme\AbstractTheme

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, use trait Xpressengine\Support\MobileSupportTrait
显示文件 Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property Type Description
$config Xpressengine\Config\ConfigEntity
$handler ThemeHandler

Public Methods

Method Description
getDescription ( ) : string 테마의 설명을 반환한다.
getEditFiles ( ) : array 테마 편집 페이지에서 편집할 수 있는 파일의 목록을 반환한다.
getScreenshot ( ) : mixed 테마의 스크린샷을 반환한다.
getSettingView ( ConfigEntity $config = null ) : string 테마 설정 페이지에 출력할 html 텍스트를 출력한다.
getTitle ( ) : string 테마의 이름을 반환한다.
hasSetting ( ) : boolean 이 테마가 설정페이지를 제공하는 테마인지 조회한다.
renderSetting ( ConfigEntity $config = null ) : string 테마 설정 페이지에 출력할 html 텍스트를 출력한다.
resolveSetting ( array $config ) : array 테마 설정 페이지에서 입력된 설정값이 저장되기 전 필요한 처리한다.
setHandler ( ThemeHandler $handler ) : void 테마 핸들러를 지정한다.
setting ( ConfigEntity $config = null ) : ConfigEntity | void set or get config info
updateSetting ( array $config ) : array 테마 설정 페이지에서 입력된 설정값이 저장되기 전 필요한 처리한다.

Method Details

getDescription() public static method

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

getEditFiles() public method

테마 편집 페이지에서 편집할 수 있는 파일의 목록을 반환한다.
public getEditFiles ( ) : array
return array

getScreenshot() public static method

테마의 스크린샷을 반환한다.
public static getScreenshot ( ) : mixed
return mixed

getSettingView() public method

설정폼은 자동으로 생성되며 설정폼 내부에 출력할 html만 반환하면 된다.
Deprecation: use renderSetting instead
public getSettingView ( ConfigEntity $config = null ) : string
$config Xpressengine\Config\ConfigEntity 기존에 설정된 설정값
return string

getTitle() public static method

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

hasSetting() public static method

이 테마가 설정페이지를 제공하는 테마인지 조회한다.
public static hasSetting ( ) : boolean
return boolean

renderSetting() public method

설정폼은 자동으로 생성되며 설정폼 내부에 출력할 html만 반환하면 된다.
public renderSetting ( ConfigEntity $config = null ) : string
$config Xpressengine\Config\ConfigEntity 기존에 설정된 설정값
return string

resolveSetting() public method

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

setHandler() public static method

테마 핸들러를 지정한다.
public static setHandler ( ThemeHandler $handler ) : void
$handler ThemeHandler 테마 핸들러
return void

setting() public method

set or get config info
public setting ( ConfigEntity $config = null ) : ConfigEntity | void
$config Xpressengine\Config\ConfigEntity config data
return Xpressengine\Config\ConfigEntity | void

updateSetting() public method

사이트관리자가 테마 설정 페이지에서 저장 요청을 할 경우, 테마핸들러가 설정값을 저장하기 전에 이 메소드가 실행된다. 설정값을 보완할 필요가 있을 경우 이 메소드에서 보완하여 다시 반환하면 된다.
Deprecation: use resolveSetting instead
public updateSetting ( array $config ) : array
$config array pure config data
return array

Property Details

$config protected_oe property

protected ConfigEntity,Xpressengine\Config $config
return Xpressengine\Config\ConfigEntity

$handler protected_oe static_oe property

protected static ThemeHandler,Xpressengine\Theme $handler
return ThemeHandler