Heratio Framework API Reference

SettingService
in package

Setting Service - Replaces QubitSetting (316 uses)

Table of Contents

Methods

clearCache()  : void
delete()  : bool
getAll()  : Collection
getByName()  : SettingWrapper|null
getByNameAndScope()  : SettingWrapper|null
getByScope()  : Collection
getValue()  : string|null
set()  : bool

Methods

delete()

public static delete(string $name[, string|null $scope = null ]) : bool
Parameters
$name : string
$scope : string|null = null
Return values
bool

getAll()

public static getAll([string|null $culture = null ]) : Collection
Parameters
$culture : string|null = null
Return values
Collection

getByNameAndScope()

public static getByNameAndScope(string $name, string $scope[, string|null $culture = null ]) : SettingWrapper|null
Parameters
$name : string
$scope : string
$culture : string|null = null
Return values
SettingWrapper|null

getByScope()

public static getByScope(string $scope[, string|null $culture = null ]) : Collection
Parameters
$scope : string
$culture : string|null = null
Return values
Collection

getValue()

public static getValue(string $name[, string|null $culture = null ]) : string|null
Parameters
$name : string
$culture : string|null = null
Return values
string|null

set()

public static set(string $name, string|null $value[, string|null $scope = null ][, string|null $culture = null ]) : bool
Parameters
$name : string
$value : string|null
$scope : string|null = null
$culture : string|null = null
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results