PHP Class Xpressengine\Skin\SkinEntity

SkinaHandler는 등록된 스킨들의 정보를 처리할 때, SkinEntity로 생성하여 사용한다.
Author: XE Developers ([email protected])
Inheritance: implements Illuminate\Contracts\Support\Arrayable, implements Illuminate\Contracts\Support\Jsonable
Show file Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property Type Description
$class class name of skin
$id skin id
$object object of skin

Public Methods

Method Description
__call ( string $method, array $arguments ) : mixed SkinEntity에서 제공하지 않는 메소드일 경우 이 entity가 저장하고 있는 skin의 method를 호출한다.
__construct ( string $id, string $class, array $config = null ) SkinEntity constructor.
getClass ( ) : string get class name of skin
getDescription ( ) : string get skin's description
getId ( ) : string get skin id
getObject ( ) : AbstractSkin get object of skin
getScreenshot ( ) : mixed get screenshot of skin
getSettingView ( array $config = [] ) : string | Illuminate\Contracts\Support\Renderable get skin setting view
getTitle ( ) : mixed get skin title
renderSetting ( array $args = [] ) : string | Illuminate\Contracts\Support\Renderable get skin setting view
resolveSetting ( array $config ) : array updateConfig
setting ( array $config = null ) : null get and set config
supportDesktop ( ) : boolean 스킨이 desktop 버전을 지원하는지 조사한다.
supportDesktopOnly ( ) : boolean 스킨이 desktop 버전만을 지원하는지 조사한다.
supportMobile ( ) : boolean 스킨이 mobile 버전을 지원하는지 조사한다.
supportMobileOnly ( ) : boolean 스킨이 mobile 버전만을 지원하는지 조사한다.
toArray ( ) : array Get the instance as an array.
toJson ( integer $options ) : string Convert the object to its JSON representation.

Method Details

__call() public method

SkinEntity에서 제공하지 않는 메소드일 경우 이 entity가 저장하고 있는 skin의 method를 호출한다.
public __call ( string $method, array $arguments ) : mixed
$method string method name
$arguments array argument list
return mixed

__construct() public method

SkinEntity constructor.
public __construct ( string $id, string $class, array $config = null )
$id string skin id
$class string skin class name
$config array skin config data

getClass() public method

get class name of skin
public getClass ( ) : string
return string

getDescription() public method

get skin's description
public getDescription ( ) : string
return string

getId() public method

get skin id
public getId ( ) : string
return string

getObject() public method

get object of skin
public getObject ( ) : AbstractSkin
return AbstractSkin

getScreenshot() public method

get screenshot of skin
public getScreenshot ( ) : mixed
return mixed

getSettingView() public method

get skin setting view
Deprecation: use renderSetting instead
public getSettingView ( array $config = [] ) : string | Illuminate\Contracts\Support\Renderable
$config array skin config
return string | Illuminate\Contracts\Support\Renderable

getTitle() public method

get skin title
public getTitle ( ) : mixed
return mixed

renderSetting() public method

get skin setting view
public renderSetting ( array $args = [] ) : string | Illuminate\Contracts\Support\Renderable
$args array skin config
return string | Illuminate\Contracts\Support\Renderable

resolveSetting() public method

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

setting() public method

get and set config
public setting ( array $config = null ) : null
$config array config data
return null

supportDesktop() public method

스킨이 desktop 버전을 지원하는지 조사한다.
public supportDesktop ( ) : boolean
return boolean desktop 버전을 지원할 경우 true

supportDesktopOnly() public method

스킨이 desktop 버전만을 지원하는지 조사한다.
public supportDesktopOnly ( ) : boolean
return boolean desktop 버전만을 지원할 경우 true

supportMobile() public method

스킨이 mobile 버전을 지원하는지 조사한다.
public supportMobile ( ) : boolean
return boolean mobile 버전을 지원할 경우 true

supportMobileOnly() public method

스킨이 mobile 버전만을 지원하는지 조사한다.
public supportMobileOnly ( ) : boolean
return boolean mobile 버전만을 지원할 경우 true

toArray() public method

Get the instance as an array.
public toArray ( ) : array
return array

toJson() public method

Convert the object to its JSON representation.
public toJson ( integer $options ) : string
$options integer json_encode option
return string

Property Details

$class protected property

class name of skin
protected $class

$id protected property

skin id
protected $id

$object protected property

object of skin
protected $object