Heratio Framework API Reference

QubitSetting
in package

Table of Contents

Constants

NAME  = 'name'

Properties

$deleteable  : mixed
$editable  : mixed
$id  : mixed
$name  : mixed
$scope  : mixed
$source_culture  : mixed
$value  : mixed

Methods

createNewSetting()  : self
Create new setting.
delete()  : bool
Delete setting.
findAndSave()  : self
Find and save setting.
getById()  : self|null
Get setting by ID.
getByName()  : self|null
Get setting by name.
getByNameAndScope()  : self|null
Get setting by name and scope.
getByScope()  : array<string|int, mixed>
Get settings by scope.
getSettingsArray()  : array<string|int, mixed>
Get all settings as sfConfig-compatible array.
getValue()  : string|null
Get value with options.
save()  : bool
Save setting.
setValue()  : self
Set value.

Constants

Properties

Methods

createNewSetting()

Create new setting.

public static createNewSetting(string $name, string|null $value[, array<string|int, mixed> $options = [] ]) : self
Parameters
$name : string
$value : string|null
$options : array<string|int, mixed> = []
Return values
self

delete()

Delete setting.

public delete() : bool
Return values
bool

findAndSave()

Find and save setting.

public static findAndSave(string $name, string|null $value[, array<string|int, mixed> $options = [] ]) : self
Parameters
$name : string
$value : string|null
$options : array<string|int, mixed> = []
Return values
self

getById()

Get setting by ID.

public static getById(int $id) : self|null
Parameters
$id : int
Return values
self|null

getByName()

Get setting by name.

public static getByName(string $name) : self|null
Parameters
$name : string
Return values
self|null

getByNameAndScope()

Get setting by name and scope.

public static getByNameAndScope(string $name, string $scope) : self|null
Parameters
$name : string
$scope : string
Return values
self|null

getByScope()

Get settings by scope.

public static getByScope(string $scope) : array<string|int, mixed>
Parameters
$scope : string
Return values
array<string|int, mixed>

getSettingsArray()

Get all settings as sfConfig-compatible array.

public static getSettingsArray() : array<string|int, mixed>

Called by arBaseTask::execute() via sfConfig::add(QubitSetting::getSettingsArray()).

Return values
array<string|int, mixed>

getValue()

Get value with options.

public getValue([array<string|int, mixed> $options = [] ]) : string|null
Parameters
$options : array<string|int, mixed> = []
Return values
string|null

save()

Save setting.

public save() : bool
Return values
bool

setValue()

Set value.

public setValue(string $value) : self
Parameters
$value : string
Return values
self

        
On this page

Search results