PHP Класс Xpressengine\Skin\AbstractSkin

См. ссылку: http://www.xpressengine.com
Автор: XE Team (developers) ([email protected])
Наследование: implements Xpressengine\Plugin\ComponentInterface, implements Illuminate\Contracts\Support\Renderable, use trait Xpressengine\Plugin\ComponentTrait, use trait Xpressengine\Support\MobileSupportTrait
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$config array | null
$data array
$view string

Открытые методы

Метод Описание
__construct ( array $config = null ) AbstractSkin constructor.
getDescription ( ) : string get description of skin
getScreenshot ( ) : string get screenshot url of skin
getSettingView ( array $config = [] ) : string | Illuminate\Contracts\Support\Renderable
getTitle ( ) : string get title of skin
render ( ) : Illuminate\Contracts\Support\Renderable | string 만약 view 이름과 동일한 메소드명이 존재하면 그 메소드를 호출한다.
renderSetting ( array $args = [] ) : mixed 스킨 설정을 위한 화면에 출력될 html 반환
resolveSetting ( array $inputs = [] ) : array 스킨 설정 페이지에서 입력된 설정값이 저장되기 전 필요한 처리한다.
setData ( mixed $data ) 스킨을 출력할 때 필요한 데이터를 지정한다. 이 메소드는 chaining 방식으로 호출 가능하도록 $this를 반환한다.
setView ( string $view ) 스킨을 출력할 때 필요한 view id를 지정한다. 이 스킨을 사용하는 곳에서는 스킨 출력시 어떤 view를 출력할지 지정해야 한다.
setting ( array $config = null ) : array | void set or get config info
updateSetting ( array $config ) : array

Описание методов

__construct() публичный Метод

AbstractSkin constructor.
public __construct ( array $config = null )
$config array configuration data

getDescription() публичный статический Метод

get description of skin
public static getDescription ( ) : string
Результат string

getScreenshot() публичный статический Метод

get screenshot url of skin
public static getScreenshot ( ) : string
Результат string

getSettingView() публичный Метод

Устаревший: use renderSetting instead
public getSettingView ( array $config = [] ) : string | Illuminate\Contracts\Support\Renderable
$config array skin config
Результат string | Illuminate\Contracts\Support\Renderable

getTitle() публичный статический Метод

get title of skin
public static getTitle ( ) : string
Результат string

render() публичный Метод

만약 view 이름과 동일한 메소드명이 존재하면 그 메소드를 호출한다.
public render ( ) : Illuminate\Contracts\Support\Renderable | string
Результат Illuminate\Contracts\Support\Renderable | string

renderSetting() публичный Метод

스킨 설정을 위한 화면에 출력될 html 반환
public renderSetting ( array $args = [] ) : mixed
$args array 설정 데이터
Результат mixed

resolveSetting() публичный Метод

사이트관리자가 스킨 설정 페이지에서 저장 요청을 할 경우, 스킨핸들러가 설정값을 저장하기 전에 이 메소드가 실행된다. 설정값을 보완할 필요가 있을 경우 이 메소드에서 보완하여 다시 반환하면 된다.
public resolveSetting ( array $inputs = [] ) : array
$inputs array 설정값
Результат array

setData() публичный Метод

스킨을 출력할 때 필요한 데이터를 지정한다. 이 메소드는 chaining 방식으로 호출 가능하도록 $this를 반환한다.
public setData ( mixed $data )
$data mixed 지정할 데이터

setView() публичный Метод

이 메소드는 chaining 방식으로 호출 가능하도록 $this를 반환한다.
public setView ( string $view )
$view string 스킨 출력(render)시 사용할 view 지정

setting() публичный Метод

set or get config info
public setting ( array $config = null ) : array | void
$config array config data
Результат array | void

updateSetting() публичный Метод

Устаревший: use resolveSetting instead
public updateSetting ( array $config ) : array
$config array 설정값
Результат array

Описание свойств

$config защищенное свойство

protected array|null $config
Результат array | null

$data защищенное свойство

protected array $data
Результат array

$view защищенное свойство

protected string $view
Результат string