PHP Class Xpressengine\Theme\GenericTheme

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: extends AbstractTheme
显示文件 Open project: xpressengine/xpressengine

Protected Properties

Property Type Description
$info array
$path 테마를 정의한 디렉토리 경로, 플러그인디렉토리명을 포함한 디렉토리 경로를 지정해야 한다. ex) 'myplugin/theme'
$viewsDir 템플릿 파일을 저장하고 있는 디렉토리의 경로, 테마 디렉토리내 상대경로를 지정해야 한다.

Public Methods

Method Description
asset ( string $path, string $secure = null ) : string 테마의 asset 파일 주소(url)를 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.
getEditFiles ( ) : array 각 테마는 편집 페이지에서 편집할 수 있는 템플릿파일(blade)이나 css 파일 목록을 지정한다.
getPath ( ) : mixed get path, example: 'plugins/myplugin/theme'
hasSetting ( ) : boolean 이 테마가 설정페이지를 제공하는 테마인지 조회한다.
info ( string $key = null, mixed $default = null ) : array retrieve theme info from info.php file
render ( ) : string Get the evaluated contents of the object.
renderSetting ( ConfigEntity $config = null ) : Illuminate\Contracts\View\View | void return content of setting page
resolveSetting ( array $config ) : array updateConfig
setting ( ConfigEntity $config = null ) : ConfigEntity get and set config
supportDesktop ( ) : boolean 테마가 desktop 버전을 지원하는지 조사한다.
supportMobile ( ) : boolean 테마가 mobile 버전을 지원하는지 조사한다.
view ( string $view ) : string view name을 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.

Protected Methods

Method Description
makeConfigView ( array $info, ConfigEntity $old ) : string info.php에 등록돼 있는 setting 폼 리스트를 가져와 form을 생성하여 반환한다.
saveFile ( string $configId, string $key, Symfony\Component\HttpFoundation\File\UploadedFile $file ) : array setting 과정에서 upload되는 파일을 저장한다.

Method Details

asset() public static method

테마의 asset 파일 주소(url)를 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.
public static asset ( string $path, string $secure = null ) : string
$path string path가 주어질 경우 주어진 파일의 URL을 반환한다. path는 테마의 assets 디렉토리 내에서의 상대 경로이어야 한다.
$secure string https 여부
return string

getEditFiles() public method

이 메소드는 그 파일 목록을 조회한다.
public getEditFiles ( ) : array
return array

getPath() public static method

get path, example: 'plugins/myplugin/theme'
public static getPath ( ) : mixed
return mixed

hasSetting() public static method

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

info() public static method

retrieve theme info from info.php file
public static info ( string $key = null, mixed $default = null ) : array
$key string info field
$default mixed default value
return array

makeConfigView() protected method

info.php에 등록돼 있는 setting 폼 리스트를 가져와 form을 생성하여 반환한다.
protected makeConfigView ( array $info, ConfigEntity $old ) : string
$info array setting form info
$old Xpressengine\Config\ConfigEntity old config data
return string

render() public method

Get the evaluated contents of the object.
public render ( ) : string
return string

renderSetting() public method

return content of setting page
public renderSetting ( ConfigEntity $config = null ) : Illuminate\Contracts\View\View | void
$config Xpressengine\Config\ConfigEntity config data
return Illuminate\Contracts\View\View | void

resolveSetting() public method

updateConfig
public resolveSetting ( array $config ) : array
$config array pure config data
return array

saveFile() protected method

setting 과정에서 upload되는 파일을 저장한다.
protected saveFile ( string $configId, string $key, Symfony\Component\HttpFoundation\File\UploadedFile $file ) : array
$configId string config id
$key string config field key
$file Symfony\Component\HttpFoundation\File\UploadedFile file
return array

setting() public method

get and set config
public setting ( ConfigEntity $config = null ) : ConfigEntity
$config Xpressengine\Config\ConfigEntity config data
return Xpressengine\Config\ConfigEntity

supportDesktop() public static method

테마가 desktop 버전을 지원하는지 조사한다.
public static supportDesktop ( ) : boolean
return boolean desktop 버전을 지원할 경우 true

supportMobile() public static method

테마가 mobile 버전을 지원하는지 조사한다.
public static supportMobile ( ) : boolean
return boolean mobile 버전을 지원할 경우 true

view() public static method

view name을 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.
public static view ( string $view ) : string
$view string view name
return string

Property Details

$info protected_oe static_oe property

protected static array $info
return array

$path protected_oe static_oe property

테마를 정의한 디렉토리 경로, 플러그인디렉토리명을 포함한 디렉토리 경로를 지정해야 한다. ex) 'myplugin/theme'
protected static $path

$viewsDir protected_oe static_oe property

템플릿 파일을 저장하고 있는 디렉토리의 경로, 테마 디렉토리내 상대경로를 지정해야 한다.
protected static $viewsDir