PHP Трейт skeeks\cms\traits\HasComponentDbSettingsTrait

Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$autoSettingsIdPrefix the prefix to the automatically generated widget IDs.
$counterSettings a counter used to generate [[id]] for widgets.
$namespace

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

Метод Описание
fetchDefaultSettings ( ) : array Настройки по умолчанию
fetchDefaultSettingsBySiteCode ( (string) $site_code ) : array Настройки для сайта
fetchDefaultSettingsByUserId ( $user_id ) : array Настройки для пользователя
getCacheKey ( )
getCallableData ( ) : array
getCallableEditUrl ( ) : UrlHelper
getCallableId ( ) : string
getEditUrl ( ) : UrlHelper
getSettings ( ) : array
getSettingsId ( boolean $autoGenerate = true ) : string Returns the ID of the widget.
initSettings ( ) Загрузка настроек по умолчанию
invalidateCache ( )
loadDefaultSettings ( )
loadSettingsBySite ( CmsSite $site )
loadSettingsByUser ( $user )
saveDefaultSettings ( ) : boolean
saveDefaultSettingsBySiteCode ( $site_code ) : boolean
saveDefaultSettingsByUserId ( $user_id ) : boolean
setSettingsId ( string $value ) Sets the ID of the widget.

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

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

Настройки по умолчанию
public fetchDefaultSettings ( ) : array
Результат array

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

Настройки для сайта
public fetchDefaultSettingsBySiteCode ( (string) $site_code ) : array
$site_code (string)
Результат array

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

Настройки для пользователя
public fetchDefaultSettingsByUserId ( $user_id ) : array
Результат array

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

public getCacheKey ( )

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

public getCallableData ( ) : array
Результат array

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

public getCallableEditUrl ( ) : UrlHelper
Результат skeeks\cms\helpers\UrlHelper

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

public getCallableId ( ) : string
Результат string

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

public getEditUrl ( ) : UrlHelper
Результат skeeks\cms\helpers\UrlHelper

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

public getSettings ( ) : array
Результат array

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

Returns the ID of the widget.
public getSettingsId ( boolean $autoGenerate = true ) : string
$autoGenerate boolean whether to generate an ID if it is not set previously
Результат string ID of the widget.

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

Загрузка настроек по умолчанию
public initSettings ( )

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

public invalidateCache ( )

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

public loadDefaultSettings ( )

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

public loadSettingsBySite ( CmsSite $site )
$site skeeks\cms\models\CmsSite

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

public loadSettingsByUser ( $user )

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

public saveDefaultSettings ( ) : boolean
Результат boolean

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

public saveDefaultSettingsBySiteCode ( $site_code ) : boolean
Результат boolean

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

public saveDefaultSettingsByUserId ( $user_id ) : boolean
Результат boolean

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

Sets the ID of the widget.
public setSettingsId ( string $value )
$value string id of the widget.

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

$autoSettingsIdPrefix публичное статическое свойство

the prefix to the automatically generated widget IDs.
См. также: getId()
public static $autoSettingsIdPrefix

$counterSettings публичное статическое свойство

a counter used to generate [[id]] for widgets.
public static $counterSettings

$namespace публичное свойство

public $namespace