Skip to content

XConfig

  • Full name: \Zotlabs\Lib\XConfig

Methods

Load

public static Load(string $xchan): void|false
  • This method is static.

Parameters:

Parameter Type Description
$xchan string
The observer's hash

Return Value:

Returns false if xchan is not set

Get

public static Get(string $xchan, string $family, string $key, bool $default = false): mixed
  • This method is static.

Parameters:

Parameter Type Description
$xchan string
The observer's hash
$family string
The category of the configuration value
$key string
The configuration key to query
$default bool (optional) default false

Return Value:

Stored $value or false if it does not exist

Set

public static Set(string $xchan, string $family, string $key, string $value): mixed
  • This method is static.

Parameters:

Parameter Type Description
$xchan string
The observer's hash
$family string
The category of the configuration value
$key string
The configuration key to set
$value string
The value to store

Return Value:

Stored $value or false

Delete

public static Delete(string $xchan, string $family, string $key): mixed
  • This method is static.

Parameters:

Parameter Type Description
$xchan string
The observer's hash
$family string
The category of the configuration value
$key string
The configuration key to delete

Automatically generated on 2025-03-19