1. class
  2. Andromeda
  3. \
  4. Core
  5. \
  6. Config

Config

class Config extends BaseConfig

The global framework config stored in the database

Constants

IDLength

The length of the ID used to identify the object
RQLOG_DETAILS_BASIC

log basic details params and object IDs
RQLOG_DETAILS_FULL

log more detailed info, and full objects when deleted
RQLOG_DETAILS_TYPES

ERRLOG_ERRORS

show a basic back trace
ERRLOG_DETAILS

show a full back trace, loaded objects, SQL queries
ERRLOG_SENSITIVE

also show input params, function arguments, SQL values
DEBUG_TYPES

METRICS_BASIC

Show basic performance metrics
METRICS_EXTENDED

Show extended performance metrics
METRICS_TYPES

Properties

protected $database

The object's primary reference to the database

 from  BaseObject
protected Scalar> $scalars from  BaseObject
protected ObjectRef> $objects from  BaseObject
protected ObjectRefs> $objectrefs from  BaseObject
private $modified

whether or not this object has been modified

 from  BaseObject
private $deleted

whether or not this object has been deleted

 from  BaseObject
private $dbDeleted

whether or not this object has been deleted by DB

 from  BaseObject
private $deleteLater from  BaseObject
private $created

True if this object has been created and not yet saved to DB

 from  BaseObject
static private $instances from  SingletonObject
private $dryrun

Methods

static array
GetFieldTemplate()

Gets a template array of the object's properties (columns).

static string
GetDBClass()

Returns the name of the class that should be used in the database for the table name (cast down at save)

from  BaseObject
static string
GetObjClass(array $row)

No description

from  BaseObject
static int
CountByQuery(ObjectDatabase $database, QueryBuilder $query)

Counts objects in the DB matching the given query

from  BaseObject
static array
LoadByQuery(ObjectDatabase $database, QueryBuilder $query)

Loads an array of objects from the DB matching the given query

from  BaseObject
static int
DeleteByQuery(ObjectDatabase $database, QueryBuilder $query)

Deletes objects from the DB matching the given query

from  BaseObject
static BaseObject|null
TryLoadUniqueByQuery(ObjectDatabase $database, QueryBuilder $query)

Loads a unique object matching the given query

from  BaseObject
static BaseObject
NotNull(BaseObject|null $obj)

Asserts that the given object is not null

from  BaseObject
static BaseObject|null
TryLoadByID(ObjectDatabase $database, string $id)

Loads a unique object by its ID

from  BaseObject
static void
DeleteByID(ObjectDatabase $database, string $id)

Deletes a unique object by its ID

from  BaseObject
static array
LoadAll(ObjectDatabase $database, int|null $limit = null, int|null $offset = null)

Loads all objects of this type from the database

from  BaseObject
static int
DeleteAll(ObjectDatabase $database)

Deletes all objects of this type from the database

from  BaseObject
static array
LoadByObjectID(ObjectDatabase $database, string $field, string $id, string|null $class = null)

Loads objects from the database with the given object ID as the value of the given field

from  BaseObject
static int
DeleteByObjectID(ObjectDatabase $database, string $field, string $id, string|null $class = null)

Deletes objects from the database with the given object ID as the value of the given field

from  BaseObject
static BaseObject|null
TryLoadUniqueByKey(ObjectDatabase $database, string $field, string $key)

Loads a unique object matching the given field

from  BaseObject
static bool
TryDeleteByUniqueKey(ObjectDatabase $database, string $field, string $key)

Deletes a unique object matching the given field

from  BaseObject
static array
LoadByObject(ObjectDatabase $database, string $field, BaseObject $object, bool $isPoly = false)

Loads objects from the database with the given object referenced by the given field

from  BaseObject
static int
DeleteByObject(ObjectDatabase $database, string $field, BaseObject $object, bool $isPoly = false)

Deletes objects from the database with the given object referenced by the given field

from  BaseObject
static BaseObject|null
TryLoadUniqueByObject(ObjectDatabase $database, string $field, BaseObject $object, bool $isPoly = false)

Loads a unique object from the database with the given object referenced by the given field

from  BaseObject
static bool
TryDeleteByUniqueObject(ObjectDatabase $database, string $field, BaseObject $object, bool $isPoly = false)

Deletes a unique object from the database with the given object referenced by the given field

from  BaseObject
string
ID()

Returns the unique ID of the object

from  BaseObject
string
__toString()

Returns the string "id:class" where id is the object ID and class is its short class name

from  BaseObject
static string|null
toString(BaseObject|null $obj)

Returns the given object's as a string if not null, else null

from  BaseObject
mixed
GetScalar(string $field, bool $allowTemp = true)

Gets a scalar field

from  BaseObject
TryGetScalar(string $field, bool $allowTemp = true)

Same as GetScalar() but returns null instead of throwing exceptions

from  BaseObject
int
GetScalarDelta(string $field)

Returns the delta of the given scalar (non-zero if modified)

from  BaseObject
BaseObject
GetObject(string $field)

Gets a single object reference

from  BaseObject
BaseObject|null
TryGetObject(string $field)

Same as GetObject() but returns null instead of throwing exceptions

from  BaseObject
bool
HasObject(string $field)

Checks if the object reference is not-null without actually loading it (faster)

from  BaseObject
string
GetObjectID(string $field)

Gets the ID of a referenced object without actually loading it (faster)

from  BaseObject
string|null
TryGetObjectID(string $field)

Same as GetObjectID() but returns null instead of throwing exceptions

from  BaseObject
string
GetObjectType(string $field)

Gets the class name of a referenced object without actually loading it (faster)

from  BaseObject
string|null
TryGetObjectType(string $field)

Gets the class name of a referenced object without actually loading it (faster)

from  BaseObject
BaseObject
DeleteObject(string $field)

Deletes the object referenced in the field

from  BaseObject
array
GetObjectRefs(string $field, int|null $limit = null, int|null $offset = null)

Gets an array of objects that reference this object

from  BaseObject
int
CountObjectRefs(string $field)

Gets the counter of objects referencing this object

from  BaseObject
StandardObject
GetJoinObject(string $field, BaseObject $obj)

Loads the object that joins together two classes using a FieldTypes\ObjectJoin

from  BaseObject
StandardObject|null
TryGetJoinObject(string $field, BaseObject $obj)

Same as GetJoinObject() but returns null instead of throwing exceptions

from  BaseObject
BaseObject
DeleteObjects(string $field)

Deletes all objects that reference this object

from  BaseObject
BaseObject
SetScalar(string $field, mixed $value, bool $temp = false)

Sets a scalar field to the given value

from  BaseObject
BaseObject
DeltaCounter(string $name, int $delta = 1, bool $ignoreLimit = false)

Increment a counter by the given value

from  StandardObject
bool
BoolSetObject(string $field, BaseObject|null $object, bool $notification = false)

Sets a field to reference the given object

from  BaseObject
BaseObject
SetObject(string $field, BaseObject|null $object, bool $notification = false)

Same as BoolSetObject() but returns $this

from  BaseObject
bool
AddObjectRef(string $field, BaseObject $object, bool $notification = false)

Adds an object reference, checking for a limit on the number of references

from  StandardObject
bool
RemoveObjectRef(string $field, BaseObject $object, bool $notification = false)

Removes the given object from a collection of referenced objects

from  BaseObject
__construct(ObjectDatabase $database, array $data)

Constructs the object by initializing its field template with values from the database

from  BaseObject
AddField(string $key, Scalar $field)

Adds the given field object to the correct internal array

from  BaseObject
void
SubConstruct()

Function to allow subclasses to do something after being constructed without overriding the constructor

from  BaseObject
BaseObject
Save(bool $onlyMandatory = false)

Collects fields that have changed and saves them to the database

from  BaseObject
bool
isDeleted()

whether or not this object has been, or should be considered, deleted

from  BaseObject
void
NotifyDBDeleted()

Deletes this object without sending to the DB

from  BaseObject
void
Delete()

Deletes this object from the DB

from  BaseObject
void
DeleteLater()

Schedules the object to be deleted when Save() is called

from  BaseObject
bool
isCreated()

True if this object has been created and not yet saved to DB (should not be overriden)

from  BaseObject
static BaseObject
BaseCreate(ObjectDatabase $database)

No description

from  SingletonObject
float
GetDate(string $name)

Returns the timestamp value stored in the given date field

from  StandardObject
float|null
TryGetDate(string $name)

Returns the timestamp value stored in the given date field

from  StandardObject
StandardObject
SetDate(string $name, float|null $value = null)

Sets the value of the given date field to the given value

from  StandardObject
float
GetDateCreated()

Returns the timestamp when this object was created

from  StandardObject
int
GetFeatureInt(string $name, bool $allowTemp = true)

Gets the value of the given feature field as an int (used for config)

from  StandardObject
int|null
TryGetFeatureInt(string $name, bool $allowTemp = true)

Gets the value of the given feature field as an int (used for config)

from  StandardObject
bool
GetFeatureBool(string $name, bool $allowTemp = true)

Gets the value of the given feature field as a bool (used for config)

from  StandardObject
bool|null
TryGetFeatureBool(string $name, bool $allowTemp = true)

Gets the value of the given feature field as a bool (used for config)

from  StandardObject
StandardObject
SetFeatureInt(string $name, int|null $value, bool $temp = false)

Sets the value of the given feature field to the given (?int) value

from  StandardObject
StandardObject
SetFeatureBool(string $name, bool|null $value, bool $temp = false)

Sets the value of the given feature field to the given (?bool) value

from  StandardObject
bool
isFeatureModified(string $name)

Returns true if the given feature has been modified

from  StandardObject
int
GetCounter(string $name)

Gets the value of the given counter field

from  StandardObject
int
GetCounterLimit(string $name)

Gets the value of the given counter limit field

from  StandardObject
int|null
TryGetCounterLimit(string $name)

Gets the value of the given counter limit field

from  StandardObject
StandardObject
SetCounterLimit(string $name, int|null $value, bool $temp = false)

Sets the value of the given counter limit field

from  StandardObject
bool
CheckCounter(string $name, int $delta = 0, bool $except = true)

Checks whether the given counter plus a delta would exceed the limit

from  StandardObject
array
GetAllScalars(string|null $prefix)

Gets an array of the values of all fields matching a prefix

from  StandardObject
static SingletonObject
GetInstance(ObjectDatabase $database)

Gets the instance of the given class, possibly loading it from the DB

from  SingletonObject
string
getVersion()

Returns the database schema version

from  BaseConfig
BaseConfig
setVersion(string $version)

Sets the database schema version to the given value

from  BaseConfig
static Config
Create(ObjectDatabase $database)

Creates a new config singleton with default values

static string
GetSetConfigUsage()

Returns the string detailing the CLI usage for SetConfig

Config
SetConfig(Input $input)

Updates config with the parameters in the given input (see CLI usage)

array
GetApps()

returns the array of registered apps

static array
ListApps()

List all installable app folders that exist in the filesystem

Config
EnableApp(string $app)

Registers the specified app name

Config
DisableApp(string $app)

Unregisters the specified app name

bool
isEnabled()

Returns whether the server is allowed to respond to requests

Config
setEnabled(bool $enable)

Set whether the server is allowed to respond to requests

bool
isDryRun()

Returns true if the server is set to dry-run mode

Config
setDryRun(bool $val = true)

Sets the server to dryrun mode if $val is true

bool
isReadOnly()

Returns true if the server is set to read-only (not dry run)

string|null
GetDataDir()

Returns the configured global data directory path

bool
GetEnableRequestLogDB()

Returns true if request logging to DB is enabled

bool
GetEnableRequestLogFile()

Returns true if request logging to data dir file is enabled

bool
GetEnableRequestLog()

Returns true if request logging is enabled

int
GetRequestLogDetails()

Returns the configured request log details detail level

int
GetDebugLevel()

Returns the current debug level

Config
SetDebugLevel(int $data, bool $temp = true)

Sets the current debug level

bool
GetDebugLog2DB()

Gets whether the server should log errors to the database

bool
GetDebugLog2File()

Gets whether the server should log errors to a log file in the datadir

bool
GetDebugOverHTTP()

Gets whether debug should be allowed over a non-privileged interface

int
GetMetricsLevel()

Returns the current metrics log level

Config
SetMetricsLevel(int $data, bool $temp = true)

Sets the current metrics log level

bool
GetMetricsLog2DB()

Gets whether the server should log metrics to the database

bool
GetMetricsLog2File()

Gets whether the server should log errors to a log file in the datadir

bool
GetEnableEmail()

Gets whether using configured emailers is currently allowed

Emailer
GetMailer()

Retrieves a configured mailer service, picking one randomly

array
GetClientObject(bool $admin = false)

Gets the config as a printable client object

Details

at line 50
static array GetFieldTemplate()

Gets a template array of the object's properties (columns).

This template will be copied into the object when it is constructed. If a field maps to null, a basic Scalar fieldtype will be used.

Return Value

array

array of FieldTypes indexed by field names

in BaseObject at line 52
static string GetDBClass()

Returns the name of the class that should be used in the database for the table name (cast down at save)

Defaults to the actual class used. Can be overriden e.g. if multiple classes need to use the same table.

Return Value

string

in BaseObject at line 60
static string GetObjClass(array $row)

No description

Parameters

array $row

Return Value

string

in BaseObject at line 68
static int CountByQuery(ObjectDatabase $database, QueryBuilder $query)

Counts objects in the DB matching the given query

Parameters

ObjectDatabase $database

Reference to the database
QueryBuilder $query

The query to use for matching objects

Return Value

int

count of matched objects

in BaseObject at line 79
static array LoadByQuery(ObjectDatabase $database, QueryBuilder $query)

Loads an array of objects from the DB matching the given query

Parameters

ObjectDatabase $database

Reference to the database
QueryBuilder $query

The query to use for matching objects

Return Value

array

array of objects indexed by their IDs

in BaseObject at line 92
static int DeleteByQuery(ObjectDatabase $database, QueryBuilder $query)

Deletes objects from the DB matching the given query

The objects are loaded when they are deleted and their Delete()s are run

Parameters

ObjectDatabase $database

Reference to the database
QueryBuilder $query

The query to use for matching objects

Return Value

int

number of objects deleted

in BaseObject at line 103
static BaseObject|null TryLoadUniqueByQuery(ObjectDatabase $database, QueryBuilder $query)

Loads a unique object matching the given query

Parameters

ObjectDatabase $database

Reference to the database
QueryBuilder $query

the query to uniquely identify the object

Return Value

BaseObject|null

in BaseObject at line 116
static BaseObject NotNull(BaseObject|null $obj)

Asserts that the given object is not null

Parameters

BaseObject|null $obj

the object to check for null

Return Value

BaseObject

object if not null

Exceptions

ObjectNotFoundException

if the object is null

in BaseObject at line 127
static BaseObject|null TryLoadByID(ObjectDatabase $database, string $id)

Loads a unique object by its ID

Parameters

ObjectDatabase $database

Reference to the database
string $id

the ID of the object

Return Value

BaseObject|null

object or null if not found

in BaseObject at line 137
static void DeleteByID(ObjectDatabase $database, string $id)

Deletes a unique object by its ID

Parameters

ObjectDatabase $database

Reference to the database
string $id

the ID of the object

Return Value

void

in BaseObject at line 150
static array LoadAll(ObjectDatabase $database, int|null $limit = null, int|null $offset = null)

Loads all objects of this type from the database

Parameters

ObjectDatabase $database

Reference to the database
int|null $limit

the maximum number of objects to load
int|null $offset

the number of objects to skip loading

Return Value

array

array of objects indexed by their IDs

in BaseObject at line 160
static int DeleteAll(ObjectDatabase $database)

Deletes all objects of this type from the database

Parameters

ObjectDatabase $database

Reference to the database

Return Value

int

number of deleted objects

in BaseObject at line 176
static array LoadByObjectID(ObjectDatabase $database, string $field, string $id, string|null $class = null)

Loads objects from the database with the given object ID as the value of the given field

Can be used as an alternative to LoadByObject() to avoid actually loading the object

Parameters

ObjectDatabase $database

Reference to the database
string $field

The name of the field to check
string $id

The ID of the object referenced
string|null $class

optionally, the class to match if this column is polymorphic

Return Value

array

array of objects indexed by their IDs

in BaseObject at line 193
static int DeleteByObjectID(ObjectDatabase $database, string $field, string $id, string|null $class = null)

Deletes objects from the database with the given object ID as the value of the given field

Can be used as an alternative to DeleteByObject() to avoid actually loading the object

Parameters

ObjectDatabase $database

Reference to the database
string $field

The name of the field to check
string $id

The ID of the object referenced
string|null $class

optionally, the class to match if this column is polymorphic

Return Value

int

number of rows deleted

in BaseObject at line 206
static protected BaseObject|null TryLoadUniqueByKey(ObjectDatabase $database, string $field, string $key)

Loads a unique object matching the given field

Parameters

ObjectDatabase $database

Reference to the database
string $field

the name of the field to check
string $key

the value of the field that uniquely identifies the object

Return Value

BaseObject|null

in BaseObject at line 218
static protected bool TryDeleteByUniqueKey(ObjectDatabase $database, string $field, string $key)

Deletes a unique object matching the given field

Parameters

ObjectDatabase $database

Reference to the database
string $field

the name of the field to check
string $key

the value of the field that uniquely identifies the object

Return Value

bool

true if an object was deleted

in BaseObject at line 233
static array LoadByObject(ObjectDatabase $database, string $field, BaseObject $object, bool $isPoly = false)

Loads objects from the database with the given object referenced by the given field

Parameters

ObjectDatabase $database

Reference to the database
string $field

The name of the field to check
BaseObject $object

the object referenced by the field
bool $isPoly

whether or not this field is polymorphic

Return Value

array

array of objects indexed by their IDs

in BaseObject at line 247
static int DeleteByObject(ObjectDatabase $database, string $field, BaseObject $object, bool $isPoly = false)

Deletes objects from the database with the given object referenced by the given field

Parameters

ObjectDatabase $database

Reference to the database
string $field

The name of the field to check
BaseObject $object

the object referenced by the field
bool $isPoly

whether or not this field is polymorphic

Return Value

int

number of deleted objects

in BaseObject at line 261
static BaseObject|null TryLoadUniqueByObject(ObjectDatabase $database, string $field, BaseObject $object, bool $isPoly = false)

Loads a unique object from the database with the given object referenced by the given field

Parameters

ObjectDatabase $database

Reference to the database
string $field

The name of the field to check
BaseObject $object

the object referenced by the field
bool $isPoly

whether or not this field is polymorphic

Return Value

BaseObject|null

in BaseObject at line 275
static bool TryDeleteByUniqueObject(ObjectDatabase $database, string $field, BaseObject $object, bool $isPoly = false)

Deletes a unique object from the database with the given object referenced by the given field

Parameters

ObjectDatabase $database

Reference to the database
string $field

The name of the field to check
BaseObject $object

the object referenced by the field
bool $isPoly

whether or not this field is polymorphic

Return Value

bool

true if an object was deleted

in BaseObject at line 284
string ID()

Returns the unique ID of the object

Return Value

string

in BaseObject at line 287
string __toString()

Returns the string "id:class" where id is the object ID and class is its short class name

Return Value

string

in BaseObject at line 290
static string|null toString(BaseObject|null $obj)

Returns the given object's as a string if not null, else null

Parameters

BaseObject|null $obj

Return Value

string|null

in BaseObject at line 309
protected mixed GetScalar(string $field, bool $allowTemp = true)

Gets a scalar field

Parameters

string $field

the field name of the scalar
bool $allowTemp

whether to allow returning a value that was set as temporary

Return Value

mixed

any non-null scalar value

Exceptions

KeyNotFoundException

if the field name is invalid
NullValueException

if the field value is null

in BaseObject at line 322
protected TryGetScalar(string $field, bool $allowTemp = true)

Same as GetScalar() but returns null instead of throwing exceptions

Parameters

string $field
bool $allowTemp

See also

BaseObject::GetScalar

in BaseObject at line 336
protected int GetScalarDelta(string $field)

Returns the delta of the given scalar (non-zero if modified)

Parameters

string $field

the field name of the scalar

Return Value

int

of times modified for scalars, delta for counters

Exceptions

KeyNotFoundException

if the field name is invalid

in BaseObject at line 351
protected BaseObject GetObject(string $field)

Gets a single object reference

Parameters

string $field

the field name holding the reference

Return Value

BaseObject

any object value

Exceptions

KeyNotFoundException

if the field name is invalid
NullValueException

if the field value is null

in BaseObject at line 365
protected BaseObject|null TryGetObject(string $field)

Same as GetObject() but returns null instead of throwing exceptions

Parameters

string $field

Return Value

BaseObject|null

See also

BaseObject::GetObject

in BaseObject at line 379
protected bool HasObject(string $field)

Checks if the object reference is not-null without actually loading it (faster)

Parameters

string $field

the field name holding the reference

Return Value

bool

true if the object reference is not null

Exceptions

KeyNotFoundException

if the field name is invalid

in BaseObject at line 394
protected string GetObjectID(string $field)

Gets the ID of a referenced object without actually loading it (faster)

Parameters

string $field

the field name holding the reference

Return Value

string

the ID of the referenced object

Exceptions

KeyNotFoundException

if the field name is invalid
NullValueException

if the field value is null

in BaseObject at line 408
protected string|null TryGetObjectID(string $field)

Same as GetObjectID() but returns null instead of throwing exceptions

Parameters

string $field

Return Value

string|null

See also

BaseObject::GetObjectID

in BaseObject at line 422
protected string GetObjectType(string $field)

Gets the class name of a referenced object without actually loading it (faster)

Parameters

string $field

the field name holding the reference

Return Value

string

the class name of the referenced object

Exceptions

KeyNotFoundException

if the field name is invalid

in BaseObject at line 438
protected string|null TryGetObjectType(string $field)

Gets the class name of a referenced object without actually loading it (faster)

Parameters

string $field

the field name holding the reference

Return Value

string|null

the class name of the referenced object

Exceptions

KeyNotFoundException

if the field name is invalid

in BaseObject at line 451
protected BaseObject DeleteObject(string $field)

Deletes the object referenced in the field

Parameters

string $field

the field name holding the reference

Return Value

BaseObject

in BaseObject at line 467
protected array GetObjectRefs(string $field, int|null $limit = null, int|null $offset = null)

Gets an array of objects that reference this object

Parameters

string $field

the field name of the collection
int|null $limit

the maximum number of objects to load
int|null $offset

the number of objects to skip loading

Return Value

array

array of objects indexed by their IDs

Exceptions

KeyNotFoundException

if the field name is invalid

in BaseObject at line 481
protected int CountObjectRefs(string $field)

Gets the counter of objects referencing this object

Parameters

string $field

the field name of the collection

Return Value

int

the number of objects

Exceptions

KeyNotFoundException

if the field name is invalid

in BaseObject at line 497
protected StandardObject GetJoinObject(string $field, BaseObject $obj)

Loads the object that joins together two classes using a FieldTypes\ObjectJoin

Parameters

string $field

the field name using the join reference
BaseObject $obj

the object that is joined together with this one

Return Value

StandardObject

the join object that connects us to $obj

Exceptions

KeyNotFoundException

if the field name is invalid
NullValueException

if the given object is not joined to us

in BaseObject at line 514
protected StandardObject|null TryGetJoinObject(string $field, BaseObject $obj)

Same as GetJoinObject() but returns null instead of throwing exceptions

Parameters

string $field
BaseObject $obj

Return Value

StandardObject|null

See also

BaseObject::GetJoinObject

in BaseObject at line 530
protected BaseObject DeleteObjects(string $field)

Deletes all objects that reference this object

Parameters

string $field

the field name of the collection

Return Value

BaseObject

in BaseObject at line 546
protected BaseObject SetScalar(string $field, mixed $value, bool $temp = false)

Sets a scalar field to the given value

Parameters

string $field

the name of the field
mixed $value

the value of the scalar to set
bool $temp

if true, the value is temporary and will not be saved

Return Value

BaseObject

Exceptions

KeyNotFoundException

if the property name is invalid

in StandardObject at line 173
protected BaseObject DeltaCounter(string $name, int $delta = 1, bool $ignoreLimit = false)

Increment a counter by the given value

Parameters

string $name

the name of the counter field to increment
int $delta

the value to increment by
bool $ignoreLimit

if true, ignore the counter's limit

Return Value

BaseObject

Exceptions

CounterOverLimitException

if the counter's limit exists and is exceeded

See also

\Andromeda\Core\Database\BaseObject::DeltaScalar()

in BaseObject at line 598
protected bool BoolSetObject(string $field, BaseObject|null $object, bool $notification = false)

Sets a field to reference the given object

Will also call SetObject or AddObjectRef on the given object as appropriate for two-way references

Parameters

string $field

the name of the reference field
BaseObject|null $object

the object for the field to reference
bool $notification

true if this is a notification from another object that cross-references this one (internal only!)

Return Value

bool

true if this object was modified

Exceptions

KeyNotFoundException

if the property name is invalid

in BaseObject at line 649
protected BaseObject SetObject(string $field, BaseObject|null $object, bool $notification = false)

Same as BoolSetObject() but returns $this

Parameters

string $field
BaseObject|null $object
bool $notification

Return Value

BaseObject

See also

BaseObject::BoolSetObject

in StandardObject at line 185
protected bool AddObjectRef(string $field, BaseObject $object, bool $notification = false)

Adds an object reference, checking for a limit on the number of references

Parameters

string $field

the name of the field of the collection
BaseObject $object

the object to add to the collection
bool $notification

true if this is a notification from another object that cross-references this one (internal only!)

Return Value

bool

true if this object was modified

Exceptions

CounterOverLimitException

if the limit exists and is exceeded

See also

BaseObject::AddObjectRef

in BaseObject at line 696
protected bool RemoveObjectRef(string $field, BaseObject $object, bool $notification = false)

Removes the given object from a collection of referenced objects

Parameters

string $field

the name of the field of the collection
BaseObject $object

the object to add to the collection
bool $notification

true if this is a notification from another object that cross-references this one (internal only!)

Return Value

bool

true if this object was modified

Exceptions

KeyNotFoundException

if the property name is invalid

in BaseObject at line 727
__construct(ObjectDatabase $database, array $data)

Constructs the object by initializing its field template with values from the database

Parameters

ObjectDatabase $database

Reference to the database
array $data

array of columns from the DB in the form of name=>value

in BaseObject at line 750
private AddField(string $key, Scalar $field)

Adds the given field object to the correct internal array

Parameters

string $key
Scalar $field

in BaseObject at line 763
protected void SubConstruct()

Function to allow subclasses to do something after being constructed without overriding the constructor

Return Value

void

in BaseObject at line 771
BaseObject Save(bool $onlyMandatory = false)

Collects fields that have changed and saves them to the database

Parameters

bool $onlyMandatory

true if only required fields should be saved

Return Value

BaseObject

Exceptions

RowInsertFailedException

if the insert fails (duplicate?)

in BaseObject at line 814
bool isDeleted()

whether or not this object has been, or should be considered, deleted

This function can be overriden with a custom validity-check, and is used as a filter when loading objects

Return Value

bool

in BaseObject at line 820
void NotifyDBDeleted()

Deletes this object without sending to the DB

Return Value

void

in BaseObject at line 823
void Delete()

Deletes this object from the DB

Return Value

void

in BaseObject at line 849
protected void DeleteLater()

Schedules the object to be deleted when Save() is called

Return Value

void

in BaseObject at line 855
bool isCreated()

True if this object has been created and not yet saved to DB (should not be overriden)

Return Value

bool

in SingletonObject at line 38
static protected BaseObject BaseCreate(ObjectDatabase $database)

No description

Parameters

ObjectDatabase $database

Return Value

BaseObject

Exceptions

DuplicateSingletonException

if an object already exists in the DB

See also

StandardObject::BaseCreate

in StandardObject at line 23
protected float GetDate(string $name)

Returns the timestamp value stored in the given date field

Parameters

string $name

Return Value

float

See also

BaseObject::GetScalar

in StandardObject at line 29
protected float|null TryGetDate(string $name)

Returns the timestamp value stored in the given date field

Parameters

string $name

Return Value

float|null

See also

BaseObject::TryGetScalar

in StandardObject at line 38
protected StandardObject SetDate(string $name, float|null $value = null)

Sets the value of the given date field to the given value

Parameters

string $name

the name of the date field to set
float|null $value

the value of the timestamp, or null to use the current time

Return Value

StandardObject

See also

BaseObject::SetScalar

in StandardObject at line 44
float GetDateCreated()

Returns the timestamp when this object was created

Return Value

float

in StandardObject at line 58
protected int GetFeatureInt(string $name, bool $allowTemp = true)

Gets the value of the given feature field as an int (used for config)

Parameters

string $name
bool $allowTemp

Return Value

int

See also

BaseObject::GetScalar

in StandardObject at line 65
protected int|null TryGetFeatureInt(string $name, bool $allowTemp = true)

Gets the value of the given feature field as an int (used for config)

Parameters

string $name
bool $allowTemp

Return Value

int|null

See also

BaseObject::GetScalar

in StandardObject at line 75
protected bool GetFeatureBool(string $name, bool $allowTemp = true)

Gets the value of the given feature field as a bool (used for config)

Parameters

string $name
bool $allowTemp

Return Value

bool

See also

BaseObject::GetScalar

in StandardObject at line 82
protected bool|null TryGetFeatureBool(string $name, bool $allowTemp = true)

Gets the value of the given feature field as a bool (used for config)

Parameters

string $name
bool $allowTemp

Return Value

bool|null

See also

BaseObject::GetScalar

in StandardObject at line 93
protected StandardObject SetFeatureInt(string $name, int|null $value, bool $temp = false)

Sets the value of the given feature field to the given (?int) value

Parameters

string $name
int|null $value
bool $temp

Return Value

StandardObject

See also

BaseObject::SetScalar

in StandardObject at line 101
protected StandardObject SetFeatureBool(string $name, bool|null $value, bool $temp = false)

Sets the value of the given feature field to the given (?bool) value

Parameters

string $name
bool|null $value
bool $temp

Return Value

StandardObject

See also

BaseObject::SetScalar

in StandardObject at line 105
protected bool isFeatureModified(string $name)

Returns true if the given feature has been modified

Parameters

string $name

Return Value

bool

in StandardObject at line 114
protected int GetCounter(string $name)

Gets the value of the given counter field

Parameters

string $name

Return Value

int

See also

BaseObject::GetScalar

in StandardObject at line 121
protected int GetCounterLimit(string $name)

Gets the value of the given counter limit field

Parameters

string $name

Return Value

int

See also

BaseObject::GetScalar

in StandardObject at line 128
protected int|null TryGetCounterLimit(string $name)

Gets the value of the given counter limit field

Parameters

string $name

Return Value

int|null

See also

BaseObject::TryGetScalar

in StandardObject at line 140
protected StandardObject SetCounterLimit(string $name, int|null $value, bool $temp = false)

Sets the value of the given counter limit field

Parameters

string $name
int|null $value
bool $temp

Return Value

StandardObject

See also

BaseObject::SetScalar

in StandardObject at line 151
protected bool CheckCounter(string $name, int $delta = 0, bool $except = true)

Checks whether the given counter plus a delta would exceed the limit

Parameters

string $name

the name of the counter and counter limit field to check
int $delta

the value to try incrementing the counter by
bool $except

if true, throw an exception instead of returning false

Return Value

bool

if true, the limit exists and is not exceeded

Exceptions

CounterOverLimitException

if $except and retval is false

in StandardObject at line 202
protected array GetAllScalars(string|null $prefix)

Gets an array of the values of all fields matching a prefix

Parameters

string|null $prefix

the prefix to match fields against, or null to get all

Return Value

array

mapping field names (stripped of their prefix) to their values

See also

BaseObject::TryGetScalar

in SingletonObject at line 21
static SingletonObject GetInstance(ObjectDatabase $database)

Gets the instance of the given class, possibly loading it from the DB

Parameters

ObjectDatabase $database

reference to the database

Return Value

SingletonObject

Exceptions

DuplicateSingletonException

if > 1 object is loaded
ObjectNotFoundException

if no object is loaded

in BaseConfig at line 38
string getVersion()

Returns the database schema version

Return Value

string

in BaseConfig at line 44
BaseConfig setVersion(string $version)

Sets the database schema version to the given value

Parameters

string $version

Return Value

BaseConfig

at line 72
static Config Create(ObjectDatabase $database)

Creates a new config singleton with default values

Parameters

ObjectDatabase $database

Return Value

Config

at line 75
static string GetSetConfigUsage()

Returns the string detailing the CLI usage for SetConfig

Return Value

string

at line 86
Config SetConfig(Input $input)

Updates config with the parameters in the given input (see CLI usage)

Parameters

Input $input

Return Value

Config

Exceptions

UnwriteableDatadirException

if given a new datadir that is invalid

at line 151
array GetApps()

returns the array of registered apps

Return Value

array

at line 154
static array ListApps()

List all installable app folders that exist in the filesystem

Return Value

array

at line 168
Config EnableApp(string $app)

Registers the specified app name

Parameters

string $app

Return Value

Config

at line 193
Config DisableApp(string $app)

Unregisters the specified app name

Parameters

string $app

Return Value

Config

at line 212
bool isEnabled()

Returns whether the server is allowed to respond to requests

Return Value

bool

at line 215
Config setEnabled(bool $enable)

Set whether the server is allowed to respond to requests

Parameters

bool $enable

Return Value

Config

at line 220
bool isDryRun()

Returns true if the server is set to dry-run mode

Return Value

bool

at line 223
Config setDryRun(bool $val = true)

Sets the server to dryrun mode if $val is true

Parameters

bool $val

Return Value

Config

at line 226
bool isReadOnly()

Returns true if the server is set to read-only (not dry run)

Return Value

bool

at line 229
string|null GetDataDir()

Returns the configured global data directory path

Return Value

string|null

at line 232
bool GetEnableRequestLogDB()

Returns true if request logging to DB is enabled

Return Value

bool

at line 235
bool GetEnableRequestLogFile()

Returns true if request logging to data dir file is enabled

Return Value

bool

at line 238
bool GetEnableRequestLog()

Returns true if request logging is enabled

Return Value

bool

at line 249
int GetRequestLogDetails()

Returns the configured request log details detail level

Return Value

int

at line 263
int GetDebugLevel()

Returns the current debug level

Return Value

int

at line 269
Config SetDebugLevel(int $data, bool $temp = true)

Sets the current debug level

Parameters

int $data
bool $temp

if true, only for this request

Return Value

Config

at line 272
bool GetDebugLog2DB()

Gets whether the server should log errors to the database

Return Value

bool

at line 275
bool GetDebugLog2File()

Gets whether the server should log errors to a log file in the datadir

Return Value

bool

at line 278
bool GetDebugOverHTTP()

Gets whether debug should be allowed over a non-privileged interface

Return Value

bool

at line 289
int GetMetricsLevel()

Returns the current metrics log level

Return Value

int

at line 295
Config SetMetricsLevel(int $data, bool $temp = true)

Sets the current metrics log level

Parameters

int $data
bool $temp

if true, only for this request

Return Value

Config

at line 298
bool GetMetricsLog2DB()

Gets whether the server should log metrics to the database

Return Value

bool

at line 301
bool GetMetricsLog2File()

Gets whether the server should log errors to a log file in the datadir

Return Value

bool

at line 304
bool GetEnableEmail()

Gets whether using configured emailers is currently allowed

Return Value

bool

at line 310
Emailer GetMailer()

Retrieves a configured mailer service, picking one randomly

Return Value

Emailer

Exceptions

EmailUnavailableException

if not configured or not allowed

at line 328
array GetClientObject(bool $admin = false)

Gets the config as a printable client object

Parameters

bool $admin

if true, show sensitive admin-only values

Return Value

array

{api:int, features: {read_only:bool, enabled:bool}, apps:[{string:string}]} \ if admin, add: {datadir:?string, features:{ \ requestlog_file:bool, requestlog_db:bool, requestlog_details:enum, \ metrics:enum, metrics_dblog:bool, metrics_filelog:bool, email:bool debug:enum, debug_http:bool, debug_dblog:bool, debug_filelog:bool }}