Documentation

AdminFacade
in package

Facade providing unified interface to Admin module.

This facade wraps the use cases to provide a similar interface to the original services for gradual migration.

Tags
since
3.0.0

Table of Contents

Properties

$autocompleteConnection  : AutocompleteConnection
$downloadBackup  : DownloadBackup
$downloadOfficialBackup  : DownloadOfficialBackup
$emptyDatabase  : EmptyDatabase
$getAllSettings  : GetAllSettings
$getAvailableThemes  : GetAvailableThemes
$getFrequencyStatistics  : GetFrequencyStatistics
$getIntensityStatistics  : GetIntensityStatistics
$getLanguageCount  : GetLanguageCount
$getServerData  : GetServerData
$getSetting  : GetSetting
$installDemo  : InstallDemo
$loadConnection  : LoadConnection
$resetAllSettings  : ResetAllSettings
$restoreFromUpload  : RestoreFromUpload
$saveAllSettings  : SaveAllSettings
$saveConnection  : SaveConnection
$saveSetting  : SaveSetting
$testConnection  : TestConnection

Methods

__construct()  : mixed
Constructor.
autocompleteConnection()  : DatabaseConnectionDTO
Get autocomplete suggestions for connection.
createConnectionFromForm()  : DatabaseConnectionDTO
Create connection DTO from form data.
createEmptyConnection()  : DatabaseConnectionDTO
Create empty connection DTO.
downloadBackup()  : void
Download LWT backup.
downloadOfficialBackup()  : void
Download official format backup.
emptyDatabase()  : array{success: bool}
Empty the database.
envFileExists()  : bool
Check if .env file exists.
getAllSettings()  : array<string, string>
Get all settings.
getAvailableThemes()  : array<string|int, mixed>
Get available themes.
getDatabaseName()  : string
Get database name.
getEnvPath()  : string
Get path to .env file.
getFrequencyStatistics()  : array{languages: array, totals: array}
Get frequency statistics.
getIntensityStatistics()  : array{languages: array, totals: array}
Get intensity statistics.
getLanguageCount()  : int
Get language count.
getPrefixInfo()  : string
Get prefix info for display (empty now that prefixes are removed).
getServerData()  : array<string|int, mixed>
Get server data.
getSetting()  : string
Get a setting value.
installDemo()  : string
Install demo database.
loadConnection()  : DatabaseConnectionDTO
Load database connection from .env.
resetAllSettings()  : array{success: bool}
Reset all settings to defaults.
restoreFromUpload()  : array{success: bool, error: ?string}
Restore database from uploaded file.
saveAllSettings()  : array{success: bool}
Save all settings from form.
saveAndClearSession()  : void
Save a single setting with optional session clearing.
saveConnectionToEnv()  : bool
Save database connection to .env.
testConnection()  : array{success: bool, error: ?string}
Test database connection.

Properties

Methods

createConnectionFromForm()

Create connection DTO from form data.

public createConnectionFromForm(array<string, mixed> $formData) : DatabaseConnectionDTO
Parameters
$formData : array<string, mixed>

Form input

Return values
DatabaseConnectionDTO —

Connection DTO

downloadBackup()

Download LWT backup.

public downloadBackup() : void
Return values
void —

Outputs file and exits

downloadOfficialBackup()

Download official format backup.

public downloadOfficialBackup() : void
Return values
void —

Outputs file and exits

emptyDatabase()

Empty the database.

public emptyDatabase() : array{success: bool}
Return values
array{success: bool}

envFileExists()

Check if .env file exists.

public envFileExists() : bool
Return values
bool —

True if exists

getAllSettings()

Get all settings.

public getAllSettings() : array<string, string>
Return values
array<string, string> —

All settings

getAvailableThemes()

Get available themes.

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

Theme list

getDatabaseName()

Get database name.

public getDatabaseName() : string
Return values
string —

Database name

getEnvPath()

Get path to .env file.

public getEnvPath() : string
Return values
string —

Path

getFrequencyStatistics()

Get frequency statistics.

public getFrequencyStatistics() : array{languages: array, totals: array}
Return values
array{languages: array, totals: array} —

Statistics data

getIntensityStatistics()

Get intensity statistics.

public getIntensityStatistics() : array{languages: array, totals: array}
Return values
array{languages: array, totals: array} —

Statistics data

getLanguageCount()

Get language count.

public getLanguageCount() : int
Return values
int —

Number of languages

getPrefixInfo()

Get prefix info for display (empty now that prefixes are removed).

public getPrefixInfo() : string
Return values
string —

Prefix info

getServerData()

Get server data.

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

Server information

getSetting()

Get a setting value.

public getSetting(string $key[, string $default = '' ]) : string
Parameters
$key : string

Setting key

$default : string = ''

Default value

Return values
string —

Setting value

installDemo()

Install demo database.

public installDemo() : string
Return values
string —

Status message

resetAllSettings()

Reset all settings to defaults.

public resetAllSettings() : array{success: bool}
Return values
array{success: bool}

restoreFromUpload()

Restore database from uploaded file.

public restoreFromUpload(array{name: string, type: string, tmp_name: string, error: int, size: int}|null $fileData) : array{success: bool, error: ?string}
Parameters
$fileData : array{name: string, type: string, tmp_name: string, error: int, size: int}|null

Validated file data from InputValidator::getUploadedFile()

Return values
array{success: bool, error: ?string}

saveAllSettings()

Save all settings from form.

public saveAllSettings() : array{success: bool}
Return values
array{success: bool}

saveAndClearSession()

Save a single setting with optional session clearing.

public saveAndClearSession(string $key, string $value) : void
Parameters
$key : string

Setting key

$value : string

Setting value


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results