Heratio Framework API Reference

BackupSettingsService
in package

Table of Contents

Methods

__construct()  : mixed
all()  : array<string|int, mixed>
Alias for getAllSettings() - for template compatibility
clearCache()  : void
get()  : mixed
getAllSettings()  : array<string|int, mixed>
getAllWithMeta()  : array<string|int, mixed>
Get all settings with metadata (type, description)
getAtomRoot()  : string
Detect AtoM root path dynamically
getConfigFilePath()  : string
Get path to AtoM config file
getDbConfigFromFile()  : array<string|int, mixed>
Get DB config from AtoM config.php (for display purposes)
saveAll()  : bool
saveMultiple()  : bool
Save multiple settings at once (alias for saveAll)
set()  : bool

Methods

all()

Alias for getAllSettings() - for template compatibility

public all() : array<string|int, mixed>
Return values
array<string|int, mixed>

get()

public get(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

getAllSettings()

public getAllSettings() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAllWithMeta()

Get all settings with metadata (type, description)

public getAllWithMeta() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAtomRoot()

Detect AtoM root path dynamically

public static getAtomRoot() : string
Return values
string

getConfigFilePath()

Get path to AtoM config file

public getConfigFilePath() : string
Return values
string

getDbConfigFromFile()

Get DB config from AtoM config.php (for display purposes)

public getDbConfigFromFile() : array<string|int, mixed>
Return values
array<string|int, mixed>

saveAll()

public saveAll(array<string|int, mixed> $settings) : bool
Parameters
$settings : array<string|int, mixed>
Return values
bool

saveMultiple()

Save multiple settings at once (alias for saveAll)

public saveMultiple(array<string|int, mixed> $settings) : bool
Parameters
$settings : array<string|int, mixed>
Return values
bool

set()

public set(string $key, mixed $value) : bool
Parameters
$key : string
$value : mixed
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results