\FAASetupHandler

Summary

Methods

Properties

Constants

GetConfigFilePath()
GetSettingDataVersion()
GetSettingData()
StoreData()
LoadLocalSettings()
GetFormPreset()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

Methods

GetConfigFilePath()

GetConfigFilePath(string  $file_name,boolean  $new = false): null|string

Get path to configuration file

In old version some configuration files where stored inside of the cfg directory. This changed with 3.20.0 and all local configurations are now part of the config repository.

Supports without .json extension in path as well.

Parameters

string	$file_name	Relative file path to config folder
boolean	$new	When true, the local repository file path is returned

Returns

null|string —

Path to the file

GetSettingDataVersion()

GetSettingDataVersion(string  $file,string  $hash): \FAA\Obj\Result

Fetch settings data from repository

Open a certain version of the settings data in our new config repository. This method is cached. The result contains the settings as parsed object instead of an assoc array.

Parameters

string	$file	The relative file name
string	$hash	The git hash

Returns

\FAA\Obj\Result —

A system result object

GetSettingData()

GetSettingData(string  $file,boolean  $mode = false): \FAA\Obj\Result

Fetch settings data from file

This method is cached. The result contains the settings as parsed object instead of an assoc array.

Parameters

string	$file	The relative file name
boolean	$mode	When set to true return settings as assoc array

Returns

\FAA\Obj\Result —

A system result object

StoreData()

StoreData(string  $file,mixed  $values): \FAA\Obj\Result

Save the changed setup data When a storage target in local.config is used, the file will be stored there and added to git

Parameters

string	$file	The absolute or relative file path
mixed	$values	The content to store in the file as json

Returns

\FAA\Obj\Result —

A system result object

LoadLocalSettings()

LoadLocalSettings(string  $file): \FAA\Obj\Result

Load settings as object to result container.

This method is cached

Parameters

string

$file

Either an absolute path or a file name. Can be without .json extension

Returns

\FAA\Obj\Result —

A system result object

GetFormPreset()

GetFormPreset(  $file)

Parameters

$file