• A
• B
• C
• D
• E
• F
• G
• H
• I
• J
• K
• L
• M
• N
• O
• P
• Q
• R
• S
• T
• U
• V
• W
• X
• Y
• Z

A

AccessLog — Class in namespace Andromeda\Apps\Accounts

Access log for the accounts app

Account — Class in namespace Andromeda\Apps\Accounts

Class representing a user account in the database

Account::AddGroup() — Method in class Account

Adds the account to the given group

Account::AddObjectRef() — Method in class Account

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

AccountCreateDeniedException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that creating accounts is not allowed

AccountDeleteDeniedException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that deleting accounts is not allowed

AccountDisabledException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the authenticated account is disabled

AccountExistsException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an account already exists under this username/email

AccountRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the action requires an account to act as

AccountWhitelistException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the requested username is not whitelisted

AccountsApp — Class in namespace Andromeda\Apps\Accounts

App for managing accounts and authenticating users.

AccountsApp::AddGroupMember() — Method in class AccountsApp

Adds an account to a group

AccountsApp::AddWhitelist() — Method in class AccountsApp

Adds a new entry to the account create whitelist

AdminRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that admin-level access is required

AuthAccessLog — Class in namespace Andromeda\Apps\Accounts

Provides a base class for apps that use the Authenticator to log auth info

AuthEntity — Class in namespace Andromeda\Apps\Accounts

Base class for account/groups containing properties that can be set per-account or per-group

AuthObject — Class in namespace Andromeda\Apps\Accounts

Represents an object that holds an authentication code that can be checked

AuthSourceTestFailException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the test on the authentication source failed

External::Activate() — Method in class External

FTP::Activate() — Method in class FTP

Initiates a connection to the FTP server

LDAP::Activate() — Method in class LDAP

Initiates a connection to the LDAP server

AuthenticationFailedException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the request is not allowed with the given authentication

Authenticator — Class in namespace Andromeda\Apps\Accounts

The class used to authenticate requests

$ Authenticator#account — Property in class Authenticator

Group::AddAccount() — Method in class Group

Adds a new account to this group

AccessLog — Class in namespace Andromeda\Apps\Core

Core app access log for use without the accounts app installed

AdminRequiredException — Class in namespace Andromeda\Apps\Core

Exception indicating that admin-level access is required

AccessLog — Class in namespace Andromeda\Apps\Files

Access log for the files app

File::AddStatsToLimit() — Method in class File

Adds this item's stats to the given limit, substracting if not $add

FilesApp::AuthenticateFileAccess() — Method in class FilesApp

Returns an ItemAccess authenticating the given file ID (or null to get from input), throws exceptions on failure

FilesApp::AuthenticateFolderAccess() — Method in class FilesApp

Returns an ItemAccess authenticating the given folder ID (or null to get from input), throws exceptions on failure

FilesApp::AuthenticateItemAccess() — Method in class FilesApp

Returns an ItemAccess authenticating the given item class/ID, throws exceptions on failure

FilesApp::AuthenticateItemObjAccess() — Method in class FilesApp

Returns an ItemAccess authenticating the given already-loaded object

Folder::AddItemCounts() — Method in class Folder

Adds the statistics from the given item to this folder

Folder::AddObjectRef() — Method in class Folder

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

Folder::AddStatsToLimit() — Method in class Folder

Adds this item's stats to the given limit, substracting if not $add

Item::AddStatsToOwner() — Method in class Item

Adds this item's stats to all owner limits

Item::AddStatsToFilesystem() — Method in class Item

Adds this item's stats to all filesystem limits

Item::AddStatsToLimit() — Method in class Item

Adds this item's stats to the given limit, substracting if not $add

ItemAccess::Authenticate() — Method in class ItemAccess

Primary authentication routine for granting access to an item

AccountCommon — Class in namespace Andromeda\Apps\Files\Limits

Account limits common between total and timed

AccountTimed — Class in namespace Andromeda\Apps\Files\Limits

Concrete class providing timed account limits

AccountTotal — Class in namespace Andromeda\Apps\Files\Limits

Concrete class providing account config and total stats

AccountTotalDefault — Class in namespace Andromeda\Apps\Files\Limits

A fake empty account limits that returns default property values

AuthEntityTimed — Class in namespace Andromeda\Apps\Files\Limits

AuthEntityTotal — Class in namespace Andromeda\Apps\Files\Limits

GroupTotal and AccountTotal have some extra common features not applicable to filesystems

Base::AddFileCounts() — Method in class Base

Adds stats from the given file to this limit object

Base::AddFolderCounts() — Method in class Base

Adds stats from the given folder to this limit object

Base::AddCumulativeFolderCounts() — Method in class Base

Adds cumulative stats from the given folder to this limit object

$ GroupTimed#acctlims — Property in class GroupTimed

cache of account limits that apply to this group

$ GroupTotal#acctlims — Property in class GroupTotal

cache of account limits that apply to this group

Share::Authenticate() — Method in class Share

Checks whether this share gives access to the given item to the given account

Share::AuthenticateByLink() — Method in class Share

Checks whether this share gives access to the given item and checks the key

ActivateException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that activating the storage failed

FTP::Activate() — Method in class FTP

Activates the storage by making any required connections

FTP::assertWriteable() — Method in class FTP

Asserts that the filesystem root can be written to

FWrapper::assertReadable() — Method in class FWrapper

Asserts that the filesystem root can be read

FWrapper::assertWriteable() — Method in class FWrapper

Asserts that the filesystem root can be written to

$ ItemStat#atime — Property in class ItemStat

Local::Activate() — Method in class Local

Activates the storage by making any required connections

S3::Activate() — Method in class S3

Activates the storage by making any required connections

S3::assertReadable() — Method in class S3

Asserts that the filesystem root can be read

S3::assertWriteable() — Method in class S3

Asserts that the filesystem root can be written to

SFTP::Activate() — Method in class SFTP

Activates the storage by making any required connections

SFTP::assertWriteable() — Method in class SFTP

Asserts that the filesystem root can be written to

SMB::Activate() — Method in class SMB

Activates the storage by making any required connections

Storage::Activate() — Method in class Storage

Activates the storage by making any required connections

Storage::assertReadable() — Method in class Storage

Asserts that the filesystem root can be read

Storage::assertWriteable() — Method in class Storage

Asserts that the filesystem root can be written to

Storage::AssertNotReadOnly() — Method in class Storage

Asserts that the storage is not read only

AppDependencyException — Class in namespace Andromeda\Core

Exception indicating that an app dependency was not met

AppVersionException — Class in namespace Andromeda\Core

Exception indicating that the app is not compatible with this framework version

$ BaseApp#API — Property in class BaseApp

Reference to the main API, for convenience

BaseObject::AddObjectRef() — Method in class BaseObject

Adds the given object to a collection of referenced objects

BaseObject::AddField() — Method in class BaseObject

Adds the given field object to the correct internal array

DBStats::Add() — Method in class DBStats

Adds another DBStats' stats to this one

ObjectJoin::AddObject() — Method in class ObjectJoin

Also creates a new join object joining us to the given object

$ ObjectRef#autoDelete — Property in class ObjectRef

if true, delete the linked object when unsetting our reference to it

ObjectRef::autoDelete() — Method in class ObjectRef

$ ObjectRefs#autoDelete — Property in class ObjectRefs

if true, delete the linked object when removing our reference to it

ObjectRefs::autoDelete() — Method in class ObjectRefs

ObjectRefs::AddObject() — Method in class ObjectRefs

Add the given object to this field's object array

QueryBuilder::AddData() — Method in class QueryBuilder

Adds the given value to the internal data array

QueryBuilder::And() — Method in class QueryBuilder

Returns a query string that combines the given arguments using AND

StandardObject::AddObjectRef() — Method in class StandardObject

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

$ EmailRecipient#address — Property in class EmailRecipient

Emailer::Activate() — Method in class Emailer

Initializes the PHPMailer instance

Copyable::Append() — Method in class Copyable

Copy another exception, converting its type

ErrorLog::arrayStrings() — Method in class ErrorLog

$ ErrorManager#API — Property in class ErrorManager

$ Input#app — Property in class Input

$ Input#action — Property in class Input

$ Input#auth — Property in class Input

Input::AddParam() — Method in class Input

Input::AddFile() — Method in class Input

Adds the given InputStream to the file array

AJAX — Class in namespace Andromeda\Core\IOFormat\Interfaces

The interface for using Andromeda over a web server

$ Output#appdata — Property in class Output

SafeParams::AddParam() — Method in class SafeParams

Adds the parameter to this object with the given name and value

InstalledApp::allowInstall() — Method in class InstalledApp

Returns true if the user is allowed to install/upgrade

ActionLog — Class in namespace Andromeda\Core\Logging

Log entry representing an app action in a request

ActionMetrics — Class in namespace Andromeda\Core\Logging

Log entry representing metrics for an app action

$ BaseAppLog#actionlog — Property in class BaseAppLog

$ Main#action_stats — Property in class Main

$ Main#apps — Property in class Main

$ RunContext#actionlog — Property in class RunContext

Utilities::array_last() — Method in class Utilities

Returns the last element of an array or null if it's empty

Utilities::array_map_keys() — Method in class Utilities

Performs a key-based array map

B

AuthAccessLog::BaseAuthCreate() — Method in class AuthAccessLog

Returns a new self object with the given auth info logged

AuthObject::BaseCreate() — Method in class AuthObject

Creates a new auth object

BadItemTypeException — Class in namespace Andromeda\Apps\Files

Exception indicating that an unknown item type was given

File::BasicCreate() — Method in class File

Creates a new empty file in the DB and checks for duplicates

BaseFileFS — Class in namespace Andromeda\Apps\Files\Filesystem

A basic filesystem type that stores files as files (revolutionary)

AccountCommon::BaseProcessGroupRemove() — Method in class AccountCommon

Processes a group membership removal, possibly deleting this account limit

AuthEntityTotal::BaseConfigLimits() — Method in class AuthEntityTotal

Configures the common (at some level) limit properites for the given object with the given input

Base — Class in namespace Andromeda\Apps\Files\Limits

The base type that all limits inherit from.

Base::BaseConfigUsage() — Method in class Base

Returns the command usage for BaseConfigLimits()

Base::BaseConfigLimits() — Method in class Base

Configures the common (at some level) limit properites for the given object with the given input

GroupCommon::BaseProcessAccountChange() — Method in class GroupCommon

Updates the group's stats by adding or subtracting an account's stats

GroupTimed::BaseConfigLimits() — Method in class GroupTimed

Timed::BaseConfigUsage() — Method in class Timed

Returns the command usage for BaseConfigLimits()

Timed::BaseConfigLimits() — Method in class Timed

Total::BaseConfigUsage() — Method in class Total

Returns the command usage for BaseConfigLimits()

Total::BaseConfigLimits() — Method in class Total

Configures the common (at some level) limit properites for the given object with the given input

BasePath — Class in namespace Andromeda\Apps\Files\Storage

A storage that has a base path

BaseApp — Class in namespace Andromeda\Core

The base class from which apps must inherit

BaseConfig — Class in namespace Andromeda\Core

A singleton object that stores a version field

BaseObject — Class in namespace Andromeda\Core\Database

The base class for representing objects stored in the database.

BaseObject::BoolSetObject() — Method in class BaseObject

Sets a field to reference the given object

BaseObject::BaseCreate() — Method in class BaseObject

Creates a new object of this type in the database and returns it

Database::BinaryAsStreams() — Method in class Database

Whether or not the DB fetches binary/blob fields as streams rather than scalars

Database::BinaryEscapeInput() — Method in class Database

Whether or not the DB requires binary input to be escaped

Database::beginTransaction() — Method in class Database

Begins a new database transaction

$ ObjectPoly#baseclass — Property in class ObjectPoly

The base class that the referenced object must inherit

QueryBuilder::BaseCompare() — Method in class QueryBuilder

Base function for safely comparing columns to values

SingletonObject::BaseCreate() — Method in class SingletonObject

StandardObject::BaseCreate() — Method in class StandardObject

Create the object by setting its created date

Emailer::BuildHostFromParams() — Method in class Emailer

Build a PHPMailer-formatted host string from an input

BaseException — Class in namespace Andromeda\Core\Exceptions

The base class for Andromeda exceptions

BreakpointException — Class in namespace Andromeda\Core\Exceptions

Internal-only exception used for getting a backtrace

BatchNotAllowedException — Class in namespace Andromeda\Core\IOFormat

Exception indicating that an app action does not allow batches

BatchFileParseException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating that the given batch file's syntax is not valid

BaseAppLog — Class in namespace Andromeda\Core\Logging

Base class for extended app action logs, supplementing ActionLog

BaseAppLog::BaseRunCreate() — Method in class BaseAppLog

Creates a new empty applog object and binds it to the current action log

BaseLog — Class in namespace Andromeda\Core\Logging

Base class for access logs, providing some common DB functions for user viewing

C

AccessLog::Create() — Method in class AccessLog

Creates a new log object that logs the given $auth value

$ Account#cryptoAvailable — Property in class Account

$ Account#crypto_handlers — Property in class Account

Account::Create() — Method in class Account

Creates a new user account

Account::CheckTwoFactor() — Method in class Account

Checks a two factor code

Account::CheckRecoveryKey() — Method in class Account

Returns true if the given recovery key matches one (and they exist)

Account::CheckPasswordAge() — Method in class Account

Returns true if the account's password is not out of date, or is using external auth

Account::CryptoAvailable() — Method in class Account

Returns true if crypto has been unlocked in this request and is available for operations

Account::ChangePassword() — Method in class Account

Re-keys the account's crypto if it exists, and re-hashes its password (if using local auth)

AccountsApp::ChangePassword() — Method in class AccountsApp

Changes the password for an account

AccountsApp::capitalizeWords() — Method in class AccountsApp

Returns the given string with each character after a space capitalized

AccountsApp::CreateAccount() — Method in class AccountsApp

Creates a new user account

AccountsApp::CreateSession() — Method in class AccountsApp

Creates a new session, and possibly a new client for the account

AccountsApp::CreateRecoveryKeys() — Method in class AccountsApp

Creates a set of recovery keys, optionally replacing existing

AccountsApp::CreateTwoFactor() — Method in class AccountsApp

Creates a two factor authentication source, and recovery keys

AccountsApp::CreateContact() — Method in class AccountsApp

Adds a contact to the account

AccountsApp::CreateGroup() — Method in class AccountsApp

Creates a new account group

AccountsApp::CreateAuthSource() — Method in class AccountsApp

Adds a new external authentication source, optionally testing it

AuthObject::CheckKeyMatch() — Method in class AuthObject

Returns true if the given key is valid, and stores it in memory for GetAuthKey()

AuthObject::ChangeAuthKey() — Method in class AuthObject

Sets the auth key to the given value and hashes it

External::Create() — Method in class External

Creates a new external auth source

FTP::Create() — Method in class FTP

Creates a new external auth source

IMAP::Create() — Method in class IMAP

Creates a new external auth source

LDAP::Create() — Method in class LDAP

Creates a new external auth source

Manager::Create() — Method in class Manager

Creates and tests a new external authentication backend, creating a manager and optionally, a default group for it

Manager::CreateDefaultGroup() — Method in class Manager

Creates a new default group whose implicit members are all accounts of this auth source

$ Authenticator#client — Property in class Authenticator

ChangeExternalPasswordException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the password for an account using external authentication cannot be changed

Client — Class in namespace Andromeda\Apps\Accounts

A client registered for authenticating as an account

Client::Create() — Method in class Client

Creates a new client object

Client::CheckMatch() — Method in class Client

Authenticates the given info claiming to be this client and checks the timeout

Config — Class in namespace Andromeda\Apps\Accounts

App config stored in the database

Config::Create() — Method in class Config

Creates a new Config singleton

Config::CreateDefaultGroup() — Method in class Config

Creates a new default group whose implicit members are all accounts

Contact — Class in namespace Andromeda\Apps\Accounts

An object describing a contact method for a user account

Contact::CheckFullKey() — Method in class Contact

Checks the given full/serialized key for validity, returns result

Contact::Create() — Method in class Contact

Creates a new contact

ContactBase — Class in namespace Andromeda\Apps\Accounts

ContactExistsException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that this contact already exists

ContactInfo — Class in namespace Andromeda\Apps\Accounts

Pair representing a contact type and value

ContactNotEmailException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that this contact is not an email address

ContactNotGivenException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that a valid contact value was not given

ContactRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an email address must be provided

CryptoAlreadyInitializedException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that crypto cannot be initialized because it already exists

CryptoInitRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the account does not have crypto initialized

CryptoKeyRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the request requires providing crypto details

CryptoNotAllowedException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that server-side crypto is not allowed

CryptoNotInitializedException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that crypto cannot be unlocked because it does not exist

CryptoUnlockRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that crypto must be unlocked by the client

$ FieldCrypt#crypto_cache — Property in class FieldCrypt

Stores fields decrypted in memory

FullAuthKey::CheckFullKey() — Method in class FullAuthKey

Checks the given full/serialized key for validity, returns result

Group::Create() — Method in class Group

Creates and returns a new group with the given name, priority, and comment

KeySource::CreateKeySource() — Method in class KeySource

Creates a new key source for the given account, initializing crypto if the account has it

RecoveryKey::CreateSet() — Method in class RecoveryKey

Returns a new array of recovery keys of the default set size

RecoveryKey::Create() — Method in class RecoveryKey

Creates a single recovery key for an account

RecoveryKey::CheckFullKey() — Method in class RecoveryKey

Checks the given full/serialized key for validity, returns result

Session::Create() — Method in class Session

Create a new session for the given account and client

Session::CheckMatch() — Method in class Session

Authenticates the given info claiming to be this session and checks the timeout

TwoFactor::Create() — Method in class TwoFactor

Creates and returns a new twofactor object for the given account

TwoFactor::CheckCode() — Method in class TwoFactor

Checks and returns whether the given twofactor code is valid

UsedToken::Create() — Method in class UsedToken

Logs a used token with the given twofactor object and code

Whitelist::Create() — Method in class Whitelist

Creates a new whitelist entry

AccessLog::Create() — Method in class AccessLog

Creates a new log object that logs whether or not the request was done as admin - may return null

CoreApp — Class in namespace Andromeda\Apps\Core

Server management/info app included with the framework.

CoreApp::ConfigDB() — Method in class CoreApp

Creates a database config with the given input

CoreApp::CreateMailer() — Method in class CoreApp

Creates a new emailer config

CoreApp::CountErrors() — Method in class CoreApp

Counts server error log entries, possibly filtered

CoreApp::CountRequests() — Method in class CoreApp

Counts all request logs matching the given input

CoreApp::CountAllActions() — Method in class CoreApp

Counts all action logs matching the given input

CoreApp::CountActions() — Method in class CoreApp

Counts all app action logs matching the given input

AccessLog::Create() — Method in class AccessLog

Creates a new log object that logs the given $auth value

Comment — Class in namespace Andromeda\Apps\Files

A user comment on an item

Comment::Create() — Method in class Comment

Config — Class in namespace Andromeda\Apps\Files

App config stored in the database

Config::Create() — Method in class Config

Creates a new config singleton

CrossFilesystemException — Class in namespace Andromeda\Apps\Files

Exception indicating that files cannot be moved across filessytems

File::CheckSize() — Method in class File

Checks if the given total size would exceed the limit

File::CountDownload() — Method in class File

Counts a download by updating limits, and notifying parents if $public

File::CountBandwidth() — Method in class File

Counts bandwidth by updating the count and notifying parents

File::CheckBandwidth() — Method in class File

Checks if the given bandwidth would exceed the limit

File::CopyToName() — Method in class File

Copies the item to a new name. If $overwrite, deletes an object if the target already exists.

File::CopyToParent() — Method in class File

Copies the item to a new parent. If $overwrite, deletes an object if the target already exists.

File::Create() — Method in class File

Creates a new empty file on disk and in the DB

FileUtils::ChunkedRead() — Method in class FileUtils

Peform a chunked file read to stdout

FileUtils::ChunkedWrite() — Method in class FileUtils

Perform a chunked write to a file

FilesApp::commit() — Method in class FilesApp

Tells the app to commit any changes made outside the database

FilesApp::CreateFolder() — Method in class FilesApp

Creates a folder in the given parent

FilesApp::CommentFile() — Method in class FilesApp

Adds a comment to a file

FilesApp::CommentFolder() — Method in class FilesApp

Adds a comment to a folder

FilesApp::CommentItem() — Method in class FilesApp

Adds a comment to an item

FilesApp::CreateFilesystem() — Method in class FilesApp

Creates a new filesystem

FilesApp::ConfigLimits() — Method in class FilesApp

Configures total limits for the given object

FilesApp::ConfigTimedLimits() — Method in class FilesApp

Configures timed limits for the given object

BaseFileFS::CreateFile() — Method in class BaseFileFS

Creates an empty file on storage

BaseFileFS::CopyFile() — Method in class BaseFileFS

Copies a file

External::CreateFolder() — Method in class External

Creates the given folder on disk

External::CopyFolder() — Method in class External

Copies a folder

FSImpl::CreateFolder() — Method in class FSImpl

Creates the given folder on disk

FSImpl::CreateFile() — Method in class FSImpl

Creates an empty file on storage

FSImpl::CopyFile() — Method in class FSImpl

Copies a file

FSImpl::CopyFolder() — Method in class FSImpl

Copies a folder

FSManager::Create() — Method in class FSManager

Creates and tests a new filesystem

Native::CreateFolder() — Method in class Native

no-op

Native::CopyFolder() — Method in class Native

$ NativeCrypt#chunksize — Property in class NativeCrypt

Folder::CountPublicVisit() — Method in class Folder

Increments the folder's visit counter

Folder::CheckIsNotChildOrSelf() — Method in class Folder

Asserts that this folder is not the given folder, or any of its parents

Folder::CountSubShare() — Method in class Folder

Counts a share on a subitem of this folder

$ InvalidDLRangeException#code — Property in class InvalidDLRangeException

Item::CopyToName() — Method in class Item

Copies the item to a new name. If $overwrite, deletes an object if the target already exists.

Item::CopyToParent() — Method in class Item

Copies the item to a new parent. If $overwrite, deletes an object if the target already exists.

Item::CheckName() — Method in class Item

Asserts that this item can be moved to the given name

Item::CheckParent() — Method in class Item

Asserts that this item can be moved to the given parent

Item::CountCreate() — Method in class Item

Registers a new item with all limit objects

Item::CountPublicDownload() — Method in class Item

Counts a public download on the item and its parents

Item::CountBandwidth() — Method in class Item

Counts the given bandwidth on the item and its parents

Item::CountLike() — Method in class Item

Increments the item's like counter

Item::CountShare() — Method in class Item

Increments the item's share counter

Like::CreateOrUpdate() — Method in class Like

Likes an item by creating or updating a like object

AccountCommon::ConfigLimits() — Method in class AccountCommon

Configures limits for the given account with the given input

Base::canTrackItems() — Method in class Base

Returns true if we should track size, item count, and share count

Base::canTrackDLStats() — Method in class Base

Returns true if we should count public downloads and bandwidth

Base::CountSize() — Method in class Base

Adds to the size counter, if item tracking is allowed

Base::CountItem() — Method in class Base

Increments the item counter, if item tracking is allowed. Decrements if not $count

Base::CountItems() — Method in class Base

Increments the item counter by the given value, if item tracking is allowed

Base::CountShare() — Method in class Base

Increments the share counter, if item tracking is allowed. Decrements if not $count

Base::CountShares() — Method in class Base

Increments the share counter by the given value, if item tracking is allowed

Base::CountPublicDownload() — Method in class Base

Increments the public download counter, if download tracking is allowed

Base::CountPublicDownloads() — Method in class Base

Increments the public download counter by the given value, if DL tracking is allowed

Base::CountBandwidth() — Method in class Base

Adds to the bandwidth counter, if download tracking is allowed

Base::CheckSize() — Method in class Base

Checks if the given size delta would exceed the size limit

Base::CheckBandwidth() — Method in class Base

Checks if the given bandwidth would exceed the limit

FilesystemCommon::ConfigLimits() — Method in class FilesystemCommon

GroupCommon::canTrackItems() — Method in class GroupCommon

GroupCommon::canTrackDLStats() — Method in class GroupCommon

GroupCommon::ConfigLimits() — Method in class GroupCommon

Configures limits for the given group with the given input

$ Timed#cache — Property in class Timed

array<limited object ID, self[]>

Timed::CreateTimed() — Method in class Timed

Creates and caches a new timed limit for the given object

$ TimedStats#cache — Property in class TimedStats

$ Total#cache — Property in class Total

array<limited object ID, self]

Total::Create() — Method in class Total

Creates and caches a new limit object for the given limited object

RootFolder::CopyToName() — Method in class RootFolder

Copies the item to a new name. If $overwrite, deletes an object if the target already exists.

RootFolder::CopyToParent() — Method in class RootFolder

Copies the item to a new parent. If $overwrite, deletes an object if the target already exists.

Share::CanRead() — Method in class Share

Returns true if the share grants read access to the item

Share::CanUpload() — Method in class Share

Returns true if the share grants upload (create new files) to the item

Share::CanModify() — Method in class Share

Returns true if the share grants write access to the item

Share::CanSocial() — Method in class Share

Returns true if the share allows social features (comments, likes) on the item

Share::CanReshare() — Method in class Share

Returns true if the share allows the target to re-share the item

Share::Create() — Method in class Share

Creates a new share to a share target

Share::CreateLink() — Method in class Share

Returns a new link-based share object

Share::CheckPassword() — Method in class Share

Returns true if the given password matches this share

BasePath::Create() — Method in class BasePath

FTP::Create() — Method in class FTP

$ FWrapper#contexts — Property in class FWrapper

array<path, FileContext> map for all file handles

FWrapper::ClosePath() — Method in class FWrapper

Closes any open handles for the given file path

$ ItemStat#ctime — Property in class ItemStat

Local::Create() — Method in class Local

Local::canGetFreeSpace() — Method in class Local

Returns whether or not the storage supports getting free space

S3::cleanPath() — Method in class S3

Returns the given path with no leading, trailing or duplicate /

S3::Create() — Method in class S3

Creates a new storage with the given input and the given FS manager

SFTP::Create() — Method in class SFTP

SMB::Create() — Method in class SMB

SMB::canGetFreeSpace() — Method in class SMB

Returns whether or not the storage supports getting free space

$ Storage#createdItems — Property in class Storage

array of paths that were newly created

Storage::Create() — Method in class Storage

Creates a new storage with the given input and the given FS manager

Storage::canGetFreeSpace() — Method in class Storage

Returns whether or not the storage supports getting free space

Storage::CreateFolder() — Method in class Storage

Asserts that the folder with the given path exists

Storage::CreateFile() — Method in class Storage

Creates a new empty file at the given path

Storage::CopyFile() — Method in class Storage

Copies a file from $old to $new (path and name can change)

Storage::CopyFolder() — Method in class Storage

Copies a folder from $old to $new (path and name can change)

Storage::canCopyFolders() — Method in class Storage

By default, most storages cannot copy whole folders

Storage::commit() — Method in class Storage

Storage::commitAll() — Method in class Storage

Commits all instantiated filesystems

UserPass::Create() — Method in class UserPass

Performs cred-crypt level initialization on a new storage

SubFolder::CopyToName() — Method in class SubFolder

Copies the item to a new name. If $overwrite, deletes an object if the target already exists.

SubFolder::CopyToParent() — Method in class SubFolder

Copies the item to a new parent. If $overwrite, deletes an object if the target already exists.

SubFolder::Create() — Method in class SubFolder

Creates a new non-root folder both in DB and on disk

Tag::Create() — Method in class Tag

Creates a new tag on an item

BaseApp::commit() — Method in class BaseApp

Tells the app to commit any changes made outside the database

CommitAfterRollbackException — Class in namespace Andromeda\Core

Andromeda cannot rollback and then commit since database/objects state is not sufficiently reset

Config — Class in namespace Andromeda\Core

The global framework config stored in the database

Config::Create() — Method in class Config

Creates a new config singleton with default values

CryptoAuth — Class in namespace Andromeda\Core

libsodium wrapper class for authentication-only crypto

CryptoAuth::CheckAuthCode() — Method in class CryptoAuth

Same as TryCheckAuthCode() but throws an exception on failure

CryptoKey — Class in namespace Andromeda\Core

libsodium wrapper class for keys

CryptoPublic — Class in namespace Andromeda\Core

libsodium wrapper class for public-key authenticated crypto

CryptoSecret — Class in namespace Andromeda\Core

libsodium wrapper class for secret-key authenticated crypto

$ BaseObject#created — Property in class BaseObject

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

BaseObject::CountByQuery() — Method in class BaseObject

Counts objects in the DB matching the given query

BaseObject::CountObjectRefs() — Method in class BaseObject

Gets the counter of objects referencing this object

CounterOverLimitException — Class in namespace Andromeda\Core\Database

Exception indicating that the counter exceeded its limit

$ Database#connection — Property in class Database

the PDO database connection

$ Database#config — Property in class Database

Database::commit() — Method in class Database

Commits the current database transaction

$ DatabaseConfigException#code — Property in class DatabaseConfigException

Counter — Class in namespace Andromeda\Core\Database\FieldTypes

Stores a value that represents a thread-safe counter

JoinObject::CreateJoin() — Method in class JoinObject

Creates a new join object and notifies the joined object

ObjectDatabase::CountObjectsByQuery() — Method in class ObjectDatabase

Counts objects using the given query

StandardObject::CheckCounter() — Method in class StandardObject

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

Emailer::Create() — Method in class Emailer

Creates a new email backend in the database with the given input (see CLI usage)

ClientDeniedException — Class in namespace Andromeda\Core\Exceptions

Base class for client requests that are denied (HTTP 403)

$ ClientDeniedException#code — Property in class ClientDeniedException

ClientErrorException — Class in namespace Andromeda\Core\Exceptions

Base class for generally invalid client requests (HTTP 400)

$ ClientErrorException#code — Property in class ClientErrorException

ClientException — Class in namespace Andromeda\Core\Exceptions

Base class for errors caused by the client's request

ClientNotFoundException — Class in namespace Andromeda\Core\Exceptions

Base class for client requests referencing something that was not found (HTTP 404)

$ ClientNotFoundException#code — Property in class ClientNotFoundException

Copyable — Class in namespace Andromeda\Core\Exceptions

An exception that can be created by copying the message from another

Copyable::Copy() — Method in class Copyable

Copy another exception, converting its type

CustomClientException — Class in namespace Andromeda\Core\Exceptions

Class for errors caused by the client's request (custom)

CustomClientException::Create() — Method in class CustomClientException

ErrorLog::CountByInput() — Method in class ErrorLog

Counts error log entries matching the given input

$ NotImplementedException#code — Property in class NotImplementedException

$ ServerException#code — Property in class ServerException

CLI — Class in namespace Andromeda\Core\IOFormat\Interfaces

The interface for using Andromeda via local console

$ MethodNotAllowedException#code — Property in class MethodNotAllowedException

$ Output#code — Property in class Output

Output::ClientException() — Method in class Output

Constructs an Output object representing a client error, showing the exception and possibly extra debug

$ InstallRequiredException#code — Property in class InstallRequiredException

$ InstalledApp#config — Property in class InstalledApp

ActionLog::Create() — Method in class ActionLog

Creates a new action log with the given input and request log

ActionMetrics::Create() — Method in class ActionMetrics

Creates an action metrics log entry

BaseLog::CountByInput() — Method in class BaseLog

Counts log entries by the given input

CommitMetrics — Class in namespace Andromeda\Core\Logging

Log entry representing metrics for a commit

CommitMetrics::Create() — Method in class CommitMetrics

Creates a commit metrics log entry

RequestLog::Create() — Method in class RequestLog

Creates a new request log entry from the main API

RequestMetrics::Create() — Method in class RequestMetrics

Logs metrics and returns a metrics object

$ Main#construct_stats — Property in class Main

$ Main#commit_stats — Property in class Main

$ Main#config — Property in class Main

$ Main#cfgException — Property in class Main

Main::commit() — Method in class Main

Commits the current transaction. Internal only, do not call via apps.

$ MaintenanceException#code — Property in class MaintenanceException

$ StaticWrapper#class — Property in class StaticWrapper

Transactions::commit() — Method in class Transactions

$ UpgradeRequiredException#code — Property in class UpgradeRequiredException

$ Utilities#chars — Property in class Utilities

Utilities::CaptureOutput() — Method in class Utilities

Captures and returns any echoes or prints in the given function

D

$ Account#delete_handlers — Property in class Account

Account::DeleteClients() — Method in class Account

Deletes all clients registered to the account

Account::DeleteByAuthSource() — Method in class Account

Deletes all accounts using the given auth source

Account::Delete() — Method in class Account

Deletes this account and all associated objects

Account::DecryptSecret() — Method in class Account

Decrypts a value using the account's crypto

Account::DestroyCrypto() — Method in class Account

Disables crypto on the account, stripping all keys

AccountsApp::DisableCrypto() — Method in class AccountsApp

Disables server side crypto for an account

AccountsApp::DeleteAccount() — Method in class AccountsApp

Deletes the current account (and signs out)

AccountsApp::DeleteSession() — Method in class AccountsApp

Deletes an account session (signing it out)

AccountsApp::DeleteClient() — Method in class AccountsApp

Deletes an account session and client (signing out fully)

AccountsApp::DeleteAllAuth() — Method in class AccountsApp

Deletes all registered clients/sessions for an account

AccountsApp::DeleteTwoFactor() — Method in class AccountsApp

Deletes a two factor source for an account

AccountsApp::DeleteContact() — Method in class AccountsApp

Deletes a contact from an account

AccountsApp::DeleteGroup() — Method in class AccountsApp

Deletes an account group

AccountsApp::DeleteAuthSource() — Method in class AccountsApp

Removes an external auth source, deleting accounts associated with it!

Manager::Delete() — Method in class Manager

Deletes the external authentication source and all accounts created by it

Client::DeleteSession() — Method in class Client

Deletes an existing session for this client

DuplicateGroupMembershipException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that this group membership already exists

FieldCrypt::DecryptAccount() — Method in class FieldCrypt

Loads any objects for the given account and decrypts their fields

$ Group#delete_handlers — Property in class Group

Group::Delete() — Method in class Group

Deletes this group and all associated objects

KeySource::DestroyCrypto() — Method in class KeySource

Erases all key material from the object

RecoveryKey::DeleteByAccount() — Method in class RecoveryKey

Deletes all recovery keys owned by the given account

Session::DeleteByAccount() — Method in class Session

Deletes all sessions for the given account

Session::DeleteByAccountExcept() — Method in class Session

Deletes all sessions for the given account except the given session

TwoFactor::DestroyCrypto() — Method in class TwoFactor

Stores the secret as plaintext (not encrypted)

Whitelist::DeleteByTypeAndValue() — Method in class Whitelist

Removes a whitelist entry, if it exists

CoreApp::DisableApp() — Method in class CoreApp

Unregisters (disables) an app

CoreApp::DeleteMailer() — Method in class CoreApp

Deletes a configured emailer

DatabaseFailException — Class in namespace Andromeda\Apps\Core

Client error indicating that the database config failed

DeletedByStorageException — Class in namespace Andromeda\Apps\Files

Exception indicating that the item was deleted when refreshed from storage

DuplicateItemException — Class in namespace Andromeda\Apps\Files

Exception indicating that the item target name already exists

File::Delete() — Method in class File

Deletes the file from both the DB and disk

FileUtils::DoChunkedRead() — Method in class FileUtils

Performs a chunked File read, echoing output and counting bandwidth

FileUtils::DoChunkedWrite() — Method in class FileUtils

Perform a chunked write to a file

FilesApp::DownloadFile() — Method in class FilesApp

Downloads a file or part of a file

FilesApp::DeleteFile() — Method in class FilesApp

Deletes a file

FilesApp::DeleteFolder() — Method in class FilesApp

Deletes a folder

FilesApp::DeleteItem() — Method in class FilesApp

Deletes an item.

FilesApp::DeleteTag() — Method in class FilesApp

Deletes an item tag

FilesApp::DeleteComment() — Method in class FilesApp

Deletes a comment

FilesApp::DeleteShare() — Method in class FilesApp

Deletes an existing share

FilesApp::DeleteFilesystem() — Method in class FilesApp

Removes a filesystem (and potentially its content)

BaseFileFS::DeleteFile() — Method in class BaseFileFS

Deletes the given file from storage

External::DeleteFolder() — Method in class External

Deletes the given folder from disk

FSImpl::DeleteFolder() — Method in class FSImpl

Deletes the given folder from disk

FSImpl::DeleteFile() — Method in class FSImpl

Deletes the given file from storage

FSManager::DeleteByAccount() — Method in class FSManager

Deletes all filesystems owned by the given account

FSManager::Delete() — Method in class FSManager

Deletes this filesystem and all folder roots on it - if $unlink, from DB only

Native::DeleteFolder() — Method in class Native

no-op

Folder::DeltaSize() — Method in class Folder

Increments the size of this folder and parents by the given #bytes

Folder::DeleteChildren() — Method in class Folder

Deletes all subfiles and subfolders, refresh if not isNotify

Item::Delete() — Method in class Item

Deleting an item also deletes all of its component objects (likes, tags, comments, shares)

GroupCommon::Delete() — Method in class GroupCommon

Deletes the group limits and potentially removes account limits

Timed::DeleteByClient() — Method in class Timed

Deletes all limit objects corresponding to the given limited object

Timed::DeleteByClientAndPeriod() — Method in class Timed

Deletes all limit objects corresponding to the given limited object and time period

Timed::DeltaCounter() — Method in class Timed

Increment a counter by the given value

Total::DeleteByClient() — Method in class Total

Deletes the limit object corresponding to the given limited object

RootFolder::DeleteRootsByFSManager() — Method in class RootFolder

Deletes all root folders on the given filesystem - if the FS is external or $unlink, only remove DB objects

RootFolder::DeleteRootsByAccount() — Method in class RootFolder

Deletes all root folders for the given owner - if the FS is external, only remove DB objects

RootFolder::Delete() — Method in class RootFolder

Deletes the folder and its contents from DB and disk

Share::Delete() — Method in class Share

Deletes the share

Storage::disallowBatch() — Method in class Storage

Disallows running a batch transaction

Storage::DeleteFile() — Method in class Storage

Deletes the file with the given path - NO ROLLBACK

Storage::DeleteFolder() — Method in class Storage

Deletes the empty folder with the given path - NO ROLLBACK

Storage::deleteRollbacks() — Method in class Storage

Deletes all pending rollback actions for the given path

SubFolder::Delete() — Method in class SubFolder

Deletes the folder and its contents from DB and disk

$ Config#dryrun — Property in class Config

Config::DisableApp() — Method in class Config

Unregisters the specified app name

CryptoKey::DeriveKey() — Method in class CryptoKey

Generates an encryption key from a password

CryptoPublic::Decrypt() — Method in class CryptoPublic

Decrypts and verifies data from a sender to a recipient

CryptoSecret::Decrypt() — Method in class CryptoSecret

Decrypts the given data

$ BaseObject#database — Property in class BaseObject

The object's primary reference to the database

$ BaseObject#deleted — Property in class BaseObject

whether or not this object has been deleted

$ BaseObject#dbDeleted — Property in class BaseObject

whether or not this object has been deleted by DB

$ BaseObject#deleteLater — Property in class BaseObject

BaseObject::DeleteByQuery() — Method in class BaseObject

Deletes objects from the DB matching the given query

BaseObject::DeleteByID() — Method in class BaseObject

Deletes a unique object by its ID

BaseObject::DeleteAll() — Method in class BaseObject

Deletes all objects of this type from the database

BaseObject::DeleteByObjectID() — Method in class BaseObject

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

BaseObject::DeleteByObject() — Method in class BaseObject

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

BaseObject::DeleteObject() — Method in class BaseObject

Deletes the object referenced in the field

BaseObject::DeleteObjects() — Method in class BaseObject

Deletes all objects that reference this object

BaseObject::DeltaCounter() — Method in class BaseObject

Increments a counter field by the given delta (thread safe)

BaseObject::Delete() — Method in class BaseObject

Deletes this object from the DB

BaseObject::DeleteLater() — Method in class BaseObject

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

DBStats — Class in namespace Andromeda\Core\Database

This class keeps track of performance metrics for the database.

Database — Class in namespace Andromeda\Core\Database

This class implements the PDO database abstraction.

$ Database#driver — Property in class Database

The enum value of the driver being used

DatabaseConfigException — Class in namespace Andromeda\Core\Database

Base class for database initialization exceptions

DatabaseException — Class in namespace Andromeda\Core\Database

Base class representing a run-time database error

DatabaseInstallException — Class in namespace Andromeda\Core\Database

Exception indicating that database install config failed

DatabaseInvalidException — Class in namespace Andromeda\Core\Database

Exception indicating that the database connection failed to initialize

DatabaseMissingException — Class in namespace Andromeda\Core\Database

Exception indicating that the database configuration is not found

DatabaseQueryException — Class in namespace Andromeda\Core\Database

Exception indicating that PDO failed to execute the given query

DatabaseReadOnlyException — Class in namespace Andromeda\Core\Database

Exception indicating that the a write was requested to a read-only database

DuplicateSingletonException — Class in namespace Andromeda\Core\Database

Exception indicating that the singleton was duplicated

DuplicateUniqueKeyException — Class in namespace Andromeda\Core\Database

Exception indicating that multiple objects were loaded for by unique query

Counter::Delta() — Method in class Counter

Increments the counter by the given delta

ObjectRef::DeleteObject() — Method in class ObjectRef

Deletes the object referenced by this field

ObjectRefs::DeleteObjects() — Method in class ObjectRefs

Deletes all objects that reference this field in a single query

$ Scalar#delta — Property in class Scalar

Count of how many times this field has been modified

$ Scalar#database — Property in class Scalar

Reference to the database

JoinObject::Delete() — Method in class JoinObject

Deletes this object from the DB

ObjectDatabase::DeleteObjectsByQuery() — Method in class ObjectDatabase

Delete objects matching the given query

ObjectDatabase::DeleteObject() — Method in class ObjectDatabase

Deletes a single object from the database (only to be called by the object itself)

$ QueryBuilder#data — Property in class QueryBuilder

StandardObject::DeltaCounter() — Method in class StandardObject

Increment a counter by the given value

DecryptionFailedException — Class in namespace Andromeda\Core

Exception indicating that decryption failed

DuplicateSingletonException — Class in namespace Andromeda\Core

Exception indicating that a duplicate singleton was constructed

$ ErrorManager#dblogok — Property in class ErrorManager

if false, the DB-based log encountered an error on the last entry

$ ErrorManager#debuglog — Property in class ErrorManager

IOInterface::DisallowBatch() — Method in class IOInterface

Asserts that only one output was given

$ CLI#debug — Property in class CLI

$ CLI#dbconf — Property in class CLI

$ Output#debug — Property in class Output

OutputHandler::DoOutput() — Method in class OutputHandler

Do the actual output routine

$ InstalledApp#database — Property in class InstalledApp

$ BaseAppLog#details — Property in class BaseAppLog

cached array of details log so we can set it once only in Save()

$ Main#database — Property in class Main

$ Main#dirty — Property in class Main

$ Main#dbException — Property in class Main

Utilities::delete_value() — Method in class Utilities

Deletes any of the given value from the given array reference

E

Account::EncryptSecret() — Method in class Account

Encrypts a value using the account's crypto

AccountsApp::EmailRecovery() — Method in class AccountsApp

Emails a recovery key to the user's registered contacts

AccountsApp::EnableCrypto() — Method in class AccountsApp

Enables server-side crypto for an account and returns new recovery keys

AccountsApp::EditContact() — Method in class AccountsApp

Edits a contact for an account

AccountsApp::EditGroup() — Method in class AccountsApp

Edits properties of an existing group

AccountsApp::EditAuthSource() — Method in class AccountsApp

Edits the properties of an existing auth source, optionally testing it

External — Class in namespace Andromeda\Apps\Accounts\Auth

Describes an external auth source that has a manager and lives in the database

External::Edit() — Method in class External

Edits properties of an existing auth source

FTP::Edit() — Method in class FTP

Edits properties of an existing auth source

IMAP::Edit() — Method in class IMAP

Edits properties of an existing auth source

LDAP::Edit() — Method in class LDAP

Edits properties of an existing auth source

Manager::Edit() — Method in class Manager

Edits properties of an existing external auth backend

Whitelist::ExistsTypeAndValue() — Method in class Whitelist

Checks whether a whitelist entry exists

CoreApp::EnableApp() — Method in class CoreApp

Registers (enables) an app

EmailShareDisabledException — Class in namespace Andromeda\Apps\Files

Exception indicating that emailing share links is not allowed

FilesApp::EditFileMeta() — Method in class FilesApp

Edits file metadata

FilesApp::EditFolderMeta() — Method in class FilesApp

Edits folder metadata

FilesApp::EditItemMeta() — Method in class FilesApp

Edits item metadata

FilesApp::EditComment() — Method in class FilesApp

Edits an existing comment properties

FilesApp::EditShare() — Method in class FilesApp

Edits properties of an existing share

FilesApp::EditFilesystem() — Method in class FilesApp

Edits an existing filesystem

External — Class in namespace Andromeda\Apps\Files\Filesystem

An External Andromeda filesystem is accessible outside Andromeda

FSManager::EditStorage() — Method in class FSManager

Edits properites of the underlying storage and runs test

FSManager::Edit() — Method in class FSManager

Edits an existing filesystem with the given values, and tests it

BasePath::Edit() — Method in class BasePath

FTP::Edit() — Method in class FTP

S3::Edit() — Method in class S3

Edits an existing storage with the given input

SFTP::Edit() — Method in class SFTP

SMB::Edit() — Method in class SMB

Storage::Edit() — Method in class Storage

Edits an existing storage with the given input

UserPass::Edit() — Method in class UserPass

Performs cred-crypt level edit on an existing storage

Config::EnableApp() — Method in class Config

Registers the specified app name

CryptoPublic::Encrypt() — Method in class CryptoPublic

Encrypts and signs data from a sender to a recipient

CryptoSecret::Encrypt() — Method in class CryptoSecret

Encrypts the given data

DBStats::endQuery() — Method in class DBStats

Ends tracking a query and updates the relevant stats

Scalar::EraseValue() — Method in class Scalar

Uses sodium to securely zero the value of this field

QueryBuilder::EscapeWildcards() — Method in class QueryBuilder

Returns the given string with escaped SQL wildcard characters

QueryBuilder::Equals() — Method in class QueryBuilder

Returns a query string asserting the given column is equal to the given value

EmailRecipient — Class in namespace Andromeda\Core

A name and address pair email recipient

EmailUnavailableException — Class in namespace Andromeda\Core

Exception indicating that a mailer was requested but none are configured (or it is disabled)

Emailer — Class in namespace Andromeda\Core

A configured email service stored in the database

EmptyRecipientsException — Class in namespace Andromeda\Core

Exception indicating that no recipients were given

ErrorLog — Class in namespace Andromeda\Core\Exceptions

Represents an error log entry in the database

ErrorManager — Class in namespace Andromeda\Core\Exceptions

The main error handler/manager

Output::Exception() — Method in class Output

Constructs an Output object representing a non-client error, possibly with debug

$ Main#error_manager — Property in class Main

$ VersionInfo#extra — Property in class VersionInfo

F

FTP — Class in namespace Andromeda\Apps\Accounts\Auth

Uses an FTP server for authentication

$ FTP#ftp — Property in class FTP

FTPConnectionFailure — Class in namespace Andromeda\Apps\Accounts\Auth

FTPExtensionException — Class in namespace Andromeda\Apps\Accounts\Auth

Contact::FetchInfoFromInput() — Method in class Contact

Fetches a type/value pair from input (depends on the param name given)

FieldCrypt — Class in namespace Andromeda\Apps\Accounts

Trait allowing objects to store fields encrypted with an account's crypto

FullAuthKey — Class in namespace Andromeda\Apps\Accounts

A trait for getting a serialized user key with both the ID and auth key

OptFieldCrypt::FieldCryptCreate() — Method in class OptFieldCrypt

Performs cred-crypt level initialization on a new storage

OptFieldCrypt::FieldCryptEdit() — Method in class OptFieldCrypt

Performs cred-crypt level edit on an existing storage

File — Class in namespace Andromeda\Apps\Files

Defines a user-stored file

FileUtils — Class in namespace Andromeda\Apps\Files

Helper class for reading/writing streams and files via chunks

FilesApp — Class in namespace Andromeda\Apps\Files

App that provides user-facing filesystem services.

FSImpl — Class in namespace Andromeda\Apps\Files\Filesystem

Abstract class for a filesystem implementation, with the actual disk functions.

$ FSImpl#fsmanager — Property in class FSImpl

FSManager — Class in namespace Andromeda\Apps\Files\Filesystem

An object that manages and points to a filesystem manager

FileCreator — Class in namespace Andromeda\Apps\Files\Filesystem

FolderCreator — Class in namespace Andromeda\Apps\Files\Filesystem

Folder — Class in namespace Andromeda\Apps\Files

Defines a user-stored folder which groups other items

$ Folder#fsDeleted — Property in class Folder

AccountTimed::ForceLoadByAccount() — Method in class AccountTimed

Returns the Timed limits for the given account and time period, creating if it does not exist

AccountTotal::ForceLoadByAccount() — Method in class AccountTotal

Loads a limit object for the given account, creating it if it does not exist

FilesystemCommon — Class in namespace Andromeda\Apps\Files\Limits

Filesystem limits common between total and timed

FilesystemTimed — Class in namespace Andromeda\Apps\Files\Limits

Concrete class providing timed filesystem limits

FilesystemTotal — Class in namespace Andromeda\Apps\Files\Limits

Concrete class providing filesystem config and total stats

FTP — Class in namespace Andromeda\Apps\Files\Storage

Allows FTP to be used as a backend storage

$ FTP#ftp — Property in class FTP

The FTP connection resource

FTPAppendOnlyException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that a random write was requested (FTP does not support it)

FTPAuthenticationFailure — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that authentication on the FTP server failed

FTPBase1 — Class in namespace Andromeda\Apps\Files\Storage

FTPBase2 — Class in namespace Andromeda\Apps\Files\Storage

FTPConnectionFailure — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the FTP server connection failed

FTPCopyFileException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that FTP does not support file copy

FTPExtensionException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the FTP extension is not installed

FWrapper — Class in namespace Andromeda\Apps\Files\Storage

A storage that uses PHP's fwrapper functions

FileCloseFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the file handle failed to close

FileContext — Class in namespace Andromeda\Apps\Files\Storage

FileCopyFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that copying the file failed

FileCreateFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that creating the file failed

FileDeleteFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that deleting the file failed

FileMoveFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that moving the file failed

FileOpenFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the file handle failed to open

FileReadFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that reading from the file failed

FileRenameFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that renaming the file failed

FileSeekFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the file handle failed to seek

FileWriteFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that writing to the file failed

FolderCopyFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that copying the folder failed

FolderCreateFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that creating the folder failed

FolderDeleteFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that deleting the folder failed

FolderMoveFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that moving the folder failed

FolderReadFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that reading folder contents failed

FolderRenameFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that renaming the folder failed

FoldersUnsupportedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that this storage does not support folder functions

FreeSpaceFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that finding free space failed

$ PathRollback#func — Property in class PathRollback

Database::fetchStreams() — Method in class Database

Loops through an array of row results and replaces streams with their values

FieldTypeException — Class in namespace Andromeda\Core\Database

Exception indicating that the requested counter name is not a counter

$ QueryBuilder#fromalias — Property in class QueryBuilder

$ ErrorManager#filelogok — Property in class ErrorManager

if false, the file-based log encountered an error on the last entry

FailedAppLoadException — Class in namespace Andromeda\Core

Exception indicating that the server failed to load a configured app

FinalizeTransactionException — Class in namespace Andromeda\Core

FinalizeOutput requires the database to not already be undergoing a transaction

IOInterface::formatSize() — Method in class IOInterface

Returns the binary-packed version of the given integer size

$ Input#files — Property in class Input

Main::FinalizeOutput() — Method in class Main

Compiles performance metrics and adds them to the given output

Utilities::FirstUpper() — Method in class Utilities

Returns the given string with the first character capitalized

G

$ Account#group_handlers — Property in class Account

Account::GetFieldTemplate() — Method in class Account

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

Account::GetInheritedFields() — Method in class Account

Gets the fields that can be inherited from a group, with their default values

Account::GetUsername() — Method in class Account

Returns the account's username

Account::GetDisplayName() — Method in class Account

Returns the account's full name if set, else its username

Account::GetDefaultGroups() — Method in class Account

Loads the groups that the account implicitly belongs to

Account::GetGroups() — Method in class Account

Returns a list of all groups that the account belongs to

Account::GetMyGroups() — Method in class Account

Returns a list of all groups that the account explicitly belongs to

Account::GetGroupJoin() — Method in class Account

Returns the object joining this account to the given group

Account::GetAuthSource() — Method in class Account

Returns the auth source the account authenticates against

Account::GetClients() — Method in class Account

Returns an array of clients registered to the account

Account::GetSessions() — Method in class Account

Returns an array of sessions registered to the account

Account::GetRecoveryKeys() — Method in class Account

Returns an array of recovery keys for the account

Account::GetTwoFactors() — Method in class Account

Returns an array of twofactors for the account

Account::GetForceUseTwoFactor() — Method in class Account

True if two factor should be required to create a session even for a pre-existing client

Account::GetAllowCrypto() — Method in class Account

True if account-based server-side crypto is allowed

Account::GetAllowAccountSearch() — Method in class Account

Returns 0 if account search is disabled, or N if up to N matches are allowed

Account::GetAllowGroupSearch() — Method in class Account

Returns 0 if group search is disabled, or N if up to N matches are allowed

Account::GetAllowUserDelete() — Method in class Account

Returns true if the user is allowed to delete their account

Account::getActiveDate() — Method in class Account

Gets the timestamp when this user was last active

Account::getLoggedonDate() — Method in class Account

Gets the timestamp when this user last created a session

Account::getPasswordDate() — Method in class Account

Account::GetClientTimeout() — Method in class Account

Returns the maximum allowed time since a client was last active for it to be valid

Account::GetSessionTimeout() — Method in class Account

Returns the maximum allowed time since a session was last active for it to be valid

Account::GetMaxPasswordAge() — Method in class Account

Account::GetContacts() — Method in class Account

Returns all contacts for this account

Account::GetContactEmails() — Method in class Account

Returns EmailReceipient objects for all email contacts

Account::GetEmailFrom() — Method in class Account

Returns the EmailRecipient to use for sending email FROM this account

Account::GetClientObject() — Method in class Account

Gets this account as a printable object

Account::GetPasswordHash() — Method in class Account

Gets the account's password hash

Account::GetEncryptedMasterKey() — Method in class Account

Gets a copy of the account's master key, encrypted

AccountsApp::getName() — Method in class AccountsApp

AccountsApp::getLogClass() — Method in class AccountsApp

Return this app's BaseAppLog class name, if used (or null)

AccountsApp::getConfigClass() — Method in class AccountsApp

Return the BaseConfig class for this app

AccountsApp::GetConfig() — Method in class AccountsApp

AccountsApp::getInstallFlags() — Method in class AccountsApp

AccountsApp::getUsage() — Method in class AccountsApp

Returns an array of strings showing the CLI usage of the app

AccountsApp::GetAuthSources() — Method in class AccountsApp

Returns a list of the configured authentication sources

AccountsApp::GetAccount() — Method in class AccountsApp

Gets the current account object, or the specified one

AccountsApp::GetGroup() — Method in class AccountsApp

Returns the requested group object

AccountsApp::GetMembership() — Method in class AccountsApp

Gets metadata for an account group membership

AccountsApp::GetWhitelist() — Method in class AccountsApp

Gets all entries in the account whitelist

AuthAccessLog::GetFieldTemplate() — Method in class AuthAccessLog

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

AuthAccessLog::GetPropUsage() — Method in class AuthAccessLog

Returns the CLI usage string for loading objects by properties

AuthAccessLog::GetPropCriteria() — Method in class AuthAccessLog

Adds query filter parameters using the given input

AuthAccessLog::GetClientObject() — Method in class AuthAccessLog

Returns the printable client object of this AuthAccessLog

AuthEntity::GetDisplayName() — Method in class AuthEntity

AuthEntity::GetContacts() — Method in class AuthEntity

AuthEntity::GetFieldTemplate() — Method in class AuthEntity

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

AuthEntity::GetPropUsage() — Method in class AuthEntity

defines command usage for SetProperties()

AuthObject::GetFieldTemplate() — Method in class AuthObject

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

AuthObject::GetAuthKey() — Method in class AuthObject

Returns the auth key or auth key hash

External::GetFieldTemplate() — Method in class External

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

External::GetManager() — Method in class External

Returns the auth manager object for this source

External::GetPropUsage() — Method in class External

Returns the backend-specific command usage for Create() and Edit()

External::GetClientObject() — Method in class External

FTP::GetFieldTemplate() — Method in class FTP

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

FTP::GetPropUsage() — Method in class FTP

Returns the backend-specific command usage for Create() and Edit()

FTP::GetClientObject() — Method in class FTP

Returns a printable client object for this FTP

IMAP::GetFieldTemplate() — Method in class IMAP

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

IMAP::GetPropUsage() — Method in class IMAP

Returns the backend-specific command usage for Create() and Edit()

IMAP::GetProtocol() — Method in class IMAP

IMAP::GetClientObject() — Method in class IMAP

Returns a printable client object for this IMAP

LDAP::GetFieldTemplate() — Method in class LDAP

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

LDAP::GetPropUsage() — Method in class LDAP

Returns the backend-specific command usage for Create() and Edit()

LDAP::GetClientObject() — Method in class LDAP

Returns a printable client object for this LDAP

LDAP::GetHostname() — Method in class LDAP

Returns the hostname of the LDAP server

LDAP::GetUseSSL() — Method in class LDAP

Returns whether to use SSL with the LDAP server

LDAP::GetUserPrefix() — Method in class LDAP

Returns the user prefix to use for looking up users in LDAP

Manager::GetFieldTemplate() — Method in class Manager

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

Manager::getAuthClasses() — Method in class Manager

Returns a map of all external Auth classes as $name=>$class

Manager::GetPropUsage() — Method in class Manager

Returns basic command usage for Create() and Edit()

Manager::GetPropUsages() — Method in class Manager

Gets command usage specific to external authentication backends

Manager::GetDefaultGroup() — Method in class Manager

Returns the group that all accounts from this auth source are implicitly part of

Manager::GetDefaultGroupID() — Method in class Manager

Returns the ID of the default group for this auth source

Manager::GetAuthSource() — Method in class Manager

Returns the actual auth source interface for this manager

Manager::GetAuthSourceType() — Method in class Manager

Returns the type of auth source for this manager, without actually loading it

Manager::GetShortSourceType() — Method in class Manager

Returns the class-only (no namespace) of the auth source

Manager::GetEnabled() — Method in class Manager

Returns the enum of how/if this is enabled

Manager::GetDescription() — Method in class Manager

Returns the description set for this auth source, or the class name if none is set

Manager::GetClientObject() — Method in class Manager

Returns a printable client object for this manager and auth source

Authenticator::GetAccount() — Method in class Authenticator

Returns the authenticated user account (not null)

Authenticator::GetRealAccount() — Method in class Authenticator

Returns the actual account used for the request, not the masqueraded one (not null)

Authenticator::GetSession() — Method in class Authenticator

Returns the session used for the request (not null)

Authenticator::GetClient() — Method in class Authenticator

Returns the client used for the request (not null)

Client::GetFieldTemplate() — Method in class Client

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

Client::GetLastAddress() — Method in class Client

Gets the interface address last used with this client

Client::GetUserAgent() — Method in class Client

Gets the interface user agent last used with this client

Client::GetAccount() — Method in class Client

Gets the account that owns this client

Client::GetSession() — Method in class Client

Gets the session in use on this client, if one exists

Client::getActiveDate() — Method in class Client

Gets the last timestamp this client was active

Client::getLoggedonDate() — Method in class Client

Gets the last timestamp the client created a session

Client::GetClientObject() — Method in class Client

Gets this client as a printable object

Config::GetFieldTemplate() — Method in class Config

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

Config::GetSetConfigUsage() — Method in class Config

Returns the string detailing the CLI usage for SetConfig

Config::GetDefaultGroup() — Method in class Config

Returns the default group that all users are implicitly part of

Config::GetDefaultGroupID() — Method in class Config

Returns the ID of the default group

Config::GetDefaultAuth() — Method in class Config

Returns the auth manager that will be used by default

Config::GetDefaultAuthID() — Method in class Config

Returns the ID of the auth manager that will be used by default

Config::GetAllowCreateAccount() — Method in class Config

Returns whether the API for creating new accounts is enabled

Config::GetUsernameIsContact() — Method in class Config

Returns whether emails should be used as usernames

Config::GetRequireContact() — Method in class Config

Returns whether a contact for accounts is required or validated

Config::GetClientObject() — Method in class Config

Gets the config as a printable client object

Contact::GetFieldTemplate() — Method in class Contact

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

Contact::GetType() — Method in class Contact

Returns the enum describing the type of contact

Contact::GetInfo() — Method in class Contact

Returns the actual contact value

Contact::GetIsValid() — Method in class Contact

Returns true if the contact has been validated

Contact::getIsPublic() — Method in class Contact

Returns whether or not the contact is public

Contact::GetAccount() — Method in class Contact

Returns the account that owns the contact

Contact::GetFetchUsage() — Method in class Contact

Contact::GetAsEmailRecipient() — Method in class Contact

Returns this contact as an email recipient

Contact::GetClientObject() — Method in class Contact

Gets this contact as a printable object

ContactBase::GetFullKeyPrefix() — Method in class ContactBase

FieldCrypt::getEncryptedFields() — Method in class FieldCrypt

Returns the list of fields encrypted in this object

FieldCrypt::GetAccount() — Method in class FieldCrypt

Returns the account that owns this object

FieldCrypt::GetFieldCryptFieldTemplate() — Method in class FieldCrypt

Gets the extra DB fields required for this trait

FieldCrypt::GetEncryptedScalar() — Method in class FieldCrypt

Decrypts and returns the value of the given field

FullAuthKey::GetFullKey() — Method in class FullAuthKey

Gets the full serialized key value for the user

Group — Class in namespace Andromeda\Apps\Accounts

A group of user accounts

Group::GetFieldTemplate() — Method in class Group

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

Group::GetDisplayName() — Method in class Group

Gets the short name of the group

Group::GetComment() — Method in class Group

Gets the comment for the group (or null)

Group::GetPriority() — Method in class Group

Gets the priority assigned to the group. Higher number means conflicting config takes precedent

Group::GetDefaultAccounts() — Method in class Group

Gets the list of accounts that are implicitly part of this group

Group::GetAccounts() — Method in class Group

Gets the list of all accounts in this group

Group::GetMyAccounts() — Method in class Group

Gets the list of accounts that are explicitly part of this group

Group::GetAccountAddedDate() — Method in class Group

Gets the date that an account became a member of this group (or null)

Group::GetAccountJoin() — Method in class Group

Returns the object joining this group to the given account

Group::GetContacts() — Method in class Group

Gets contact objects for all accounts in this group

Group::GetClientObject() — Method in class Group

Gets this group as a printable object

GroupExistsException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that a group already exists with this name

GroupInherit — Class in namespace Andromeda\Apps\Accounts

Trait that overrides some BaseObject functions to allow inheriting properties from Groups

GroupInherit::GetScalar() — Method in class GroupInherit

GroupInherit::GetObject() — Method in class GroupInherit

GroupJoin — Class in namespace Andromeda\Apps\Accounts

Class representing a group membership, joining an account and a group

GroupJoin::GetLeftField() — Method in class GroupJoin

Return the column name of the left side of the join

GroupJoin::GetLeftClass() — Method in class GroupJoin

Return the column name of the right side of the join

GroupJoin::GetRightField() — Method in class GroupJoin

Return the column name of the right side of the join

GroupJoin::GetRightClass() — Method in class GroupJoin

Return the object class referred to by the right side of the join

GroupJoin::GetAccount() — Method in class GroupJoin

Returns the joined account

GroupJoin::GetGroup() — Method in class GroupJoin

Returns the joined group

GroupJoin::GetClientObject() — Method in class GroupJoin

Returns a printable client object of this group membership

InheritedProperty::GetValue() — Method in class InheritedProperty

Returns the value of the inherited property

InheritedProperty::GetSource() — Method in class InheritedProperty

Returns the source object of the inherited property

KeySource::GetFieldTemplate() — Method in class KeySource

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

KeySource::GetAccount() — Method in class KeySource

Returns the account that owns this key source

KeySource::GetUnlockedKey() — Method in class KeySource

Returns the decrypted account master key

KeySource::GetClientObject() — Method in class KeySource

Returns a printable client object

OptFieldCrypt::GetFieldCryptCreateUsage() — Method in class OptFieldCrypt

Returns the command usage for Create()

OptFieldCrypt::GetFieldCryptEditUsage() — Method in class OptFieldCrypt

Returns the command usage for Edit()

OptFieldCrypt::GetFieldCryptClientObject() — Method in class OptFieldCrypt

Returns the printable client object of this trait

RecoveryKey::GetFieldTemplate() — Method in class RecoveryKey

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

RecoveryKey::GetClientObject() — Method in class RecoveryKey

Gets a printable client object for this key

RecoveryKeyBase::GetFullKeyPrefix() — Method in class RecoveryKeyBase

Session::GetFieldTemplate() — Method in class Session

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

Session::GetClient() — Method in class Session

Returns the client that owns this session

Session::getActiveDate() — Method in class Session

Gets the last timestamp this client was active

Session::GetClientObject() — Method in class Session

Returns a printable client object for this session

TwoFactor::GetFieldTemplate() — Method in class TwoFactor

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

TwoFactor::GetAccount() — Method in class TwoFactor

Gets the account that owns this object

TwoFactor::GetComment() — Method in class TwoFactor

Gets the comment/label the user assigned to this object

TwoFactor::GetUsedTokens() — Method in class TwoFactor

Gets an array of used tokens

TwoFactor::GetIsValid() — Method in class TwoFactor

Returns whether this twofactor has been validated

TwoFactor::GetSecret() — Method in class TwoFactor

Returns the (decrypted) OTP secret

TwoFactor::GetURL() — Method in class TwoFactor

Returns a Google URL for viewing a QR code of the OTP secret

TwoFactor::GetClientObject() — Method in class TwoFactor

Returns a printable client object for this twofactor

UsedToken::GetFieldTemplate() — Method in class UsedToken

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

UsedToken::GetCode() — Method in class UsedToken

Returns the value of the used token

UsedToken::GetTwoFactor() — Method in class UsedToken

Returns the two factor code this is associated with

Whitelist::GetFieldTemplate() — Method in class Whitelist

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

Whitelist::GetClientObject() — Method in class Whitelist

Returns a printable client object for this entry

AccessLog::GetFieldTemplate() — Method in class AccessLog

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

AccessLog::GetPropUsage() — Method in class AccessLog

Returns the CLI usage string for loading objects by properties

AccessLog::GetPropCriteria() — Method in class AccessLog

Adds query filter parameters using the given input

AccessLog::GetClientObject() — Method in class AccessLog

Returns the printable client object of this access log

CoreApp::getName() — Method in class CoreApp

CoreApp::getLogClass() — Method in class CoreApp

Return this app's BaseAppLog class name, if used (or null)

CoreApp::getConfigClass() — Method in class CoreApp

Return the BaseConfig class for this app

CoreApp::GetConfig() — Method in class CoreApp

CoreApp::getVersion() — Method in class CoreApp

CoreApp::getTemplateFolder() — Method in class CoreApp

Returns the path of the app's code folder

CoreApp::getUpgradeScripts() — Method in class CoreApp

CoreApp::getInstallUsage() — Method in class CoreApp

CoreApp::getUsage() — Method in class CoreApp

Returns an array of strings showing the CLI usage of the app

CoreApp::GetUsages() — Method in class CoreApp

Collects usage strings from every installed app and returns them

CoreApp::GetDBConfig() — Method in class CoreApp

Loads server DB config

CoreApp::GetMailers() — Method in class CoreApp

Returns a list of the configured mailers

CoreApp::GetErrors() — Method in class CoreApp

Returns the server error log, possibly filtered

CoreApp::GetRequests() — Method in class CoreApp

Returns all request logs matching the given input

CoreApp::GetAllActions() — Method in class CoreApp

Returns all action logs matching the given input

CoreApp::GetActions() — Method in class CoreApp

Returns all app action logs matching the given input

AccessLog::GetFieldTemplate() — Method in class AccessLog

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

AccessLog::GetPropUsage() — Method in class AccessLog

Returns the CLI usage string for loading objects by properties

AccessLog::GetPropCriteria() — Method in class AccessLog

Adds query filter parameters using the given input

AccessLog::GetClientObject() — Method in class AccessLog

Comment::GetFieldTemplate() — Method in class Comment

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

Comment::GetClientObject() — Method in class Comment

Returns a printable client object of this comment

Config::GetFieldTemplate() — Method in class Config

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

Config::GetSetConfigUsage() — Method in class Config

Returns the command usage for SetConfig()

Config::GetRWChunkSize() — Method in class Config

Returns the block size that should be used for file reads and writes

Config::GetCryptoChunkSize() — Method in class Config

Returns the default block size for encrypted filesystems

Config::GetAllowTimedStats() — Method in class Config

Returns whether the timed-stats system as a whole is enabled

Config::GetAPIUrl() — Method in class Config

Returns the URL this server API is accessible from over HTTP

Config::GetClientObject() — Method in class Config

Returns a printable client object for this config

File::GetFieldTemplate() — Method in class File

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

File::GetName() — Method in class File

Returns the name of this file

File::GetParent() — Method in class File

Returns the parent folder of this file

File::GetParentID() — Method in class File

Returns the ID of the parent folder

File::GetSize() — Method in class File

Returns the size of the file, in bytes

File::GetNumShares() — Method in class File

Returns the number of share objects belonging to the file

File::GetChunkSize() — Method in class File

Gets the preferred chunk size by the filesystem holding this file

File::GetClientObject() — Method in class File

FileUtils::GetChunkSize() — Method in class FileUtils

Returns the chunk size to use for reading/writing a file

FilesApp::getName() — Method in class FilesApp

FilesApp::getLogClass() — Method in class FilesApp

Return this app's BaseAppLog class name, if used (or null)

FilesApp::getConfigClass() — Method in class FilesApp

Return the BaseConfig class for this app

FilesApp::GetConfig() — Method in class FilesApp

FilesApp::getUsage() — Method in class FilesApp

Returns an array of strings showing the CLI usage of the app

FilesApp::GetFileMeta() — Method in class FilesApp

Returns file metadata

FilesApp::GetFolder() — Method in class FilesApp

Lists folder metadata and optionally the items in a folder (or filesystem root)

FilesApp::GetItemByPath() — Method in class FilesApp

Reads an item by a path (rather than by ID) - can specify a root folder or filesystem

FilesApp::GetFileComments() — Method in class FilesApp

Returns comments on a file

FilesApp::GetFolderComments() — Method in class FilesApp

Returns comments on a folder

FilesApp::GetItemComments() — Method in class FilesApp

Returns comments on an item

FilesApp::GetFileLikes() — Method in class FilesApp

Returns likes on a file

FilesApp::GetFolderLikes() — Method in class FilesApp

Returns likes on a folder

FilesApp::GetItemLikes() — Method in class FilesApp

Returns likes on an item

FilesApp::GetFilesystem() — Method in class FilesApp

Returns filesystem metadata (default if none specified)

FilesApp::GetFilesystems() — Method in class FilesApp

Returns a list of all filesystems available

FilesApp::GetLimitObject() — Method in class FilesApp

Common function for loading and authenticating the limited object and limit class referred to by input

FilesApp::GetLimits() — Method in class FilesApp

Loads the total limit object or objects for the given objects

FilesApp::GetTimedLimits() — Method in class FilesApp

Loads the timed limit object or objects for the given objects

FilesApp::GetTimedStatsFor() — Method in class FilesApp

Returns all stored time stats for an object

FilesApp::GetTimedStatsAt() — Method in class FilesApp

Returns timed stats for the given object or objects at the given time

BaseFileFS::GetFilePath() — Method in class BaseFileFS

External::GetItemPath() — Method in class External

Returns the root-relative path of the given item

External::GetFilePath() — Method in class External

Get the root-relative path of the given file

FSImpl::GetChunkSize() — Method in class FSImpl

Returns the preferred byte alignment of the filesystem.

FSImpl::GetFSManager() — Method in class FSImpl

Returns a reference to the parent FS manager

FSImpl::GetStorage() — Method in class FSImpl

Returns the underlying storage

FSImpl::GetDatabase() — Method in class FSImpl

Returns a database reference

FSManager::GetFieldTemplate() — Method in class FSManager

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

FSManager::GetName() — Method in class FSManager

Returns the name (or null) of this filesystem

FSManager::GetOwner() — Method in class FSManager

Returns the owner of this filesystem (or null)

FSManager::GetOwnerID() — Method in class FSManager

Returns the owner ID of this filesystem (or null)

FSManager::GetType() — Method in class FSManager

Returns the filesystem impl enum type

FSManager::GetStorage() — Method in class FSManager

Returns the underlying storage

FSManager::GetStorageType() — Method in class FSManager

Returns the type of the underlying storage

FSManager::GetDatabase() — Method in class FSManager

Returns a reference to the global database

FSManager::GetFSImpl() — Method in class FSManager

Rreturns the filesystem impl interface (items use this)

FSManager::getStorageClasses() — Method in class FSManager

Returns a map of all storage classes as $name=>$class

FSManager::GetCreateUsage() — Method in class FSManager

Returns the common command usage of Create()

FSManager::GetCreateUsages() — Method in class FSManager

Returns the command usage of Create() specific to each storage type

FSManager::GetEditUsage() — Method in class FSManager

Returns the command usage of Edit()

FSManager::GetEditUsages() — Method in class FSManager

FSManager::GetClientObject() — Method in class FSManager

Gets a printable client object of this filesystem

Native::GetFilePath() — Method in class Native

The path to a file is simply its ID, broken into a prefix

NativeCrypt::GetChunkSize() — Method in class NativeCrypt

Returns the preferred byte alignment of the filesystem.

NativeCrypt::GetAuthString() — Method in class NativeCrypt

Chunk swapping is prevented by signing each with the file ID and chunk index

NativeCrypt::GetChunkIndex() — Method in class NativeCrypt

Returns the chunk index storing the given byte offset

NativeCrypt::GetNumChunks() — Method in class NativeCrypt

Returns the number of chunks required to store the given number of bytes

Folder::GetDBClass() — Method in class Folder

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

Folder::GetObjClass() — Method in class Folder

Folder::GetFieldTemplate() — Method in class Folder

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

Folder::GetSize() — Method in class Folder

Returns the total size of the folder and its content in bytes

Folder::GetFiles() — Method in class Folder

Returns an array of the files in this folder (not recursive)

Folder::GetFolders() — Method in class Folder

Returns an array of the folders in this folder (not recursive)

Folder::GetNumFiles() — Method in class Folder

Returns the number of files in this folder (not recursive) (fast)

Folder::GetNumFolders() — Method in class Folder

Returns the number of folders in this folder (not recursive) (fast)

Folder::GetNumItems() — Method in class Folder

Returns the number of items in this folder (not recursive) (fast)

Folder::GetTotalShares() — Method in class Folder

Returns the total number of shares on this folder or its contents (recursive)

Folder::GetClientObject() — Method in class Folder

Item::GetFieldTemplate() — Method in class Item

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

Item::GetOwner() — Method in class Item

Returns the owner of this item, or null if it's on an external FS

Item::GetOwnerID() — Method in class Item

Returns the ID of the owner of this item (or null)

Item::GetName() — Method in class Item

Returns the name of this item

Item::GetSize() — Method in class Item

Returns the size of this item in bytes

Item::GetParent() — Method in class Item

Returns the parent folder of this item

Item::GetParentID() — Method in class Item

Returns the parent ID of this item

Item::GetDescription() — Method in class Item

Returns this item's description

Item::GetFilesystem() — Method in class Item

Returns the filesystem manager that stores this object

Item::GetFilesystemID() — Method in class Item

Returns the ID of the object's filesystem manager

Item::GetFSImpl() — Method in class Item

Returns the filesystem manager's implementor that stores this object

Item::GetBandwidth() — Method in class Item

Returns the bandwidth used by the item in bytes

Item::GetPublicDownloads() — Method in class Item

Returns the public download count of the item

Item::GetLikes() — Method in class Item

Returns the like objects for this item

Item::GetComments() — Method in class Item

Returns the comment objects for this item

Item::GetTags() — Method in class Item

Returns the tag objects for this item

Item::GetShares() — Method in class Item

Returns the share objects for this item

Item::GetNumShares() — Method in class Item

Returns the number of shares on this object

Item::GetLimitsBool() — Method in class Item

Returns a config bool for the item by checking applicable limits

Item::GetAllowPublicModify() — Method in class Item

Returns true if the item should allow public modifications

Item::GetAllowPublicUpload() — Method in class Item

Returns true if the item should allow public uploading

Item::GetAllowRandomWrite() — Method in class Item

Returns true if the item should allow random/partial writes

Item::GetAllowItemSharing() — Method in class Item

Returns true if the item should allow sharing

Item::GetAllowShareToGroups() — Method in class Item

Returns true if the item should allow group shares (shares with a group)

Item::GetAllowShareToEveryone() — Method in class Item

Returns true if the item should allow public shares (shares with all users)

Item::GetClientObject() — Method in class Item

ItemAccess::GetItem() — Method in class ItemAccess

Returns the item that is being accessed

ItemAccess::GetFile() — Method in class ItemAccess

Returns the item that is being accessed (if applicable)

ItemAccess::GetFolder() — Method in class ItemAccess

Returns the item that is being accessed (if applicable)

ItemAccess::GetShare() — Method in class ItemAccess

Returns the share object that grants access, or null if the item is owned

Like::GetFieldTemplate() — Method in class Like

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

Like::GetClientObject() — Method in class Like

Returns a printable client object of this like

AccountCommon::GetObjectClass() — Method in class AccountCommon

AccountCommon::GetAccountID() — Method in class AccountCommon

Returns the ID of the limited account

AccountCommon::GetAccount() — Method in class AccountCommon

Returns the limited account

AccountCommon::GetClientObject() — Method in class AccountCommon

Returns a printable client object that includes property inherit sources

AccountCommon::GetBaseUsage() — Method in class AccountCommon

$ AccountTimed#grouplims — Property in class AccountTimed

cache of group limits that apply to this account

AccountTimed::GetsMaxStatsAgeFrom() — Method in class AccountTimed

Returns the object from which this account limit inherits its max stats age

AccountTimed::GetGroups() — Method in class AccountTimed

loads group limits via a JOIN, caches, and returns them

AccountTimed::GetInheritedFields() — Method in class AccountTimed

$ AccountTotal#grouplims — Property in class AccountTotal

cache of group limits that apply to this account

AccountTotal::GetGroups() — Method in class AccountTotal

loads group limits via a JOIN, caches, and returns them

AccountTotal::GetInheritedFields() — Method in class AccountTotal

AccountTotal::GetAllowRandomWrite() — Method in class AccountTotal

Returns true if the limited object should allow random writes to files

AccountTotal::GetAllowPublicModify() — Method in class AccountTotal

Returns true if the limited object should allow public modification of files

AccountTotal::GetAllowPublicUpload() — Method in class AccountTotal

Returns true if the limited object should allow public upload to folders

AccountTotal::GetAllowItemSharing() — Method in class AccountTotal

Returns true if the limited object should allow sharing items

AccountTotal::GetAllowShareToGroups() — Method in class AccountTotal

Returns true if the limited object should allow sharing to groups

AccountTotal::GetAllowShareToEveryone() — Method in class AccountTotal

Returns true if the limited object should allow sharing to everyone

AccountTotal::GetAllowEmailShare() — Method in class AccountTotal

Returns true if this account is allowed to email share links

AccountTotal::GetAllowUserStorage() — Method in class AccountTotal

Returns true if this account is allowed to add new filesystems

AccountTotalDefault::GetGroups() — Method in class AccountTotalDefault

loads group limits via a JOIN, caches, and returns them

AuthEntityTimed::GetTimedUsage() — Method in class AuthEntityTimed

Returns the command usage for SetTimedLimits()

AuthEntityTotal::GetDBClass() — Method in class AuthEntityTotal

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

AuthEntityTotal::GetFieldTemplate() — Method in class AuthEntityTotal

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

AuthEntityTotal::GetConfigUsage() — Method in class AuthEntityTotal

Base::GetFieldTemplate() — Method in class Base

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

Base::GetBaseUsage() — Method in class Base

Returns the command usage for SetBaseLimits()

Base::GetLimitedObject() — Method in class Base

Returns the object that is subject to the limits

Base::GetPublicDownloads() — Method in class Base

Returns the public downloads counter for the limited object

Base::GetBandwidth() — Method in class Base

Returns the bandwidth counter for the limited object

Base::GetSize() — Method in class Base

Returns the size counter for the limited object

Base::GetItems() — Method in class Base

Returns the item counter for the limited object

Base::GetShares() — Method in class Base

Returns the share counter for the limited object

Base::GetClientObject() — Method in class Base

Base::GetObjectClass() — Method in class Base

Returns the class of the limited object

FilesystemCommon::GetObjectClass() — Method in class FilesystemCommon

FilesystemCommon::GetFilesystem() — Method in class FilesystemCommon

Returns the limited filesystem

FilesystemCommon::GetBaseUsage() — Method in class FilesystemCommon

FilesystemCommon::GetClientObject() — Method in class FilesystemCommon

FilesystemTimed::GetTimedUsage() — Method in class FilesystemTimed

Returns the command usage for SetTimedLimits()

GroupCommon — Class in namespace Andromeda\Apps\Files\Limits

Group limits common between total and timed

GroupCommon::GetObjectClass() — Method in class GroupCommon

GroupCommon::GetGroupID() — Method in class GroupCommon

Returns the ID of the limited group

GroupCommon::GetGroup() — Method in class GroupCommon

Returns the limited group object

GroupCommon::GetPriority() — Method in class GroupCommon

Returns the inheritance priority of the limited group

GroupCommon::GetBaseUsage() — Method in class GroupCommon

GroupCommon::GetTrackParam() — Method in class GroupCommon

GroupCommon::GetClientObject() — Method in class GroupCommon

GroupTimed — Class in namespace Andromeda\Apps\Files\Limits

Concrete class providing timed group member limits

GroupTimed::GetAccounts() — Method in class GroupTimed

loads account limits via a JOIN, caches, and returns them

GroupTotal — Class in namespace Andromeda\Apps\Files\Limits

Concrete class providing group config and total stats

GroupTotal::GetAccounts() — Method in class GroupTotal

loads account limits via a JOIN, caches, and returns them

GroupTotal::GetAllowEmailShare() — Method in class GroupTotal

Returns true if the group's members are allowed to email share links

GroupTotal::GetAllowUserStorage() — Method in class GroupTotal

Returns true if the group's members are allowed to add new filesystems

Timed::GetDBClass() — Method in class Timed

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

Timed::GetFieldTemplate() — Method in class Timed

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

Timed::GetTimePeriod() — Method in class Timed

Returns the time period for this timed limit

Timed::GetMaxStatsAge() — Method in class Timed

Returns the maximum stats history age (-1 for forever - default)

Timed::GetCurrentStats() — Method in class Timed

Loads and returns the current stats for this limit

Timed::GetCounter() — Method in class Timed

Gets the value of the given counter field

Timed::GetTimedUsage() — Method in class Timed

Returns the command usage for SetTimedLimits()

Timed::GetConfigUsage() — Method in class Timed

Timed::GetClientObject() — Method in class Timed

Returns a printable client object of this timed limit

TimedStats::GetDBClass() — Method in class TimedStats

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

TimedStats::GetFieldTemplate() — Method in class TimedStats

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

TimedStats::GetLimiter() — Method in class TimedStats

Returns the timed limit that owns this stats entry

TimedStats::GetTimeStart() — Method in class TimedStats

Returns the beginning of the time period for these stats

TimedStats::GetTimePeriod() — Method in class TimedStats

Returns the time period length for the timed stats

TimedStats::GetCounterLimit() — Method in class TimedStats

Gets the value of the given counter limit field

TimedStats::GetClientObject() — Method in class TimedStats

Returns a printable client object of the stats

Total::GetFieldTemplate() — Method in class Total

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

Total::GetAllowRandomWrite() — Method in class Total

Returns true if the limited object should allow random writes to files

Total::GetAllowPublicModify() — Method in class Total

Returns true if the limited object should allow public modification of files

Total::GetAllowPublicUpload() — Method in class Total

Returns true if the limited object should allow public upload to folders

Total::GetAllowItemSharing() — Method in class Total

Returns true if the limited object should allow sharing items

Total::GetAllowShareToGroups() — Method in class Total

Returns true if the limited object should allow sharing to groups

Total::GetAllowShareToEveryone() — Method in class Total

Returns true if the limited object should allow sharing to everyone

Total::GetConfigUsage() — Method in class Total

Total::GetClientObject() — Method in class Total

Returns a printable client object of this timed limit

RootFolder::GetObjClass() — Method in class RootFolder

RootFolder::GetName() — Method in class RootFolder

Returns the name of this item

RootFolder::GetParent() — Method in class RootFolder

Returns the parent folder of this item

RootFolder::GetParentID() — Method in class RootFolder

Returns the parent ID of this item

RootFolder::GetRootByAccountAndFS() — Method in class RootFolder

Loads the root folder for given account and FS, creating it if it doesn't exist

Share::GetFieldTemplate() — Method in class Share

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

Share::GetItem() — Method in class Share

Returns the item being shared

Share::GetItemID() — Method in class Share

Returns the ID of the item being shared

Share::GetOwner() — Method in class Share

Returns the account that created the share

Share::GetOwnerID() — Method in class Share

Returns the ID of the account that created the share

Share::GetDest() — Method in class Share

Returns the destination user/group of this share

Share::GetSetOptionsUsage() — Method in class Share

Returns the command usage for SetOptions()

Share::GetClientObject() — Method in class Share

Returns a printable client object of this share

BasePath::GetFieldTemplate() — Method in class BasePath

BasePath::GetClientObject() — Method in class BasePath

BasePath::GetCreateUsage() — Method in class BasePath

BasePath::GetEditUsage() — Method in class BasePath

BasePath::GetPath() — Method in class BasePath

Returns the full storage level path for the given root-relative path

FTP::GetFieldTemplate() — Method in class FTP

FTP::GetClientObject() — Method in class FTP

Returns a printable client object of this FTP storage

FTP::GetCreateUsage() — Method in class FTP

FTP::GetEditUsage() — Method in class FTP

FTP::GetFullURL() — Method in class FTP

Returns the full fwrapper URL for the given path

FWrapper::GetFullURL() — Method in class FWrapper

Returns the full fwrapper URL for the given path

FWrapper::GetContext() — Method in class FWrapper

Returns a context for the given file

Local::GetFreeSpace() — Method in class Local

Returns the available space in bytes on the storage

Local::GetFullURL() — Method in class Local

Returns the full fwrapper URL for the given path

S3::getEncryptedFields() — Method in class S3

S3::GetFieldTemplate() — Method in class S3

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

S3::GetClientObject() — Method in class S3

Returns a printable client object of this S3 storage

S3::GetBucket() — Method in class S3

Returns the S3 bucket identifier

S3::getUseTLS() — Method in class S3

Returns true if the connection should use TLS

S3::GetCreateUsage() — Method in class S3

Returns the command usage for Create()

S3::GetEditUsage() — Method in class S3

Returns the command usage for Edit()

S3::GetFullURL() — Method in class S3

Returns the full fwrapper URL for the given path

S3::getStdParams() — Method in class S3

Returns an array of the params used for all requests (bucket and key)

SFTP::getEncryptedFields() — Method in class SFTP

Returns the list of fields encrypted in this object

SFTP::GetFieldTemplate() — Method in class SFTP

SFTP::GetClientObject() — Method in class SFTP

Returns a printable client object of this SFTP storage

SFTP::GetUsername() — Method in class SFTP

Returns the configured username (mandatory)

SFTP::GetCreateUsage() — Method in class SFTP

SFTP::GetEditUsage() — Method in class SFTP

SFTP::GetFullURL() — Method in class SFTP

Returns the full fwrapper URL for the given path

SMB::GetFieldTemplate() — Method in class SMB

SMB::GetClientObject() — Method in class SMB

Returns a printable client object of this SMB storage

SMB::GetCreateUsage() — Method in class SMB

SMB::GetEditUsage() — Method in class SMB

SMB::GetFullURL() — Method in class SMB

Returns the full fwrapper URL for the given path

SMB::GetFreeSpace() — Method in class SMB

Returns the available space in bytes on the storage

Storage::GetAccount() — Method in class Storage

Returns the account that owns this storage (or null)

Storage::GetFilesystem() — Method in class Storage

Returns the FSManager that manages this storage

Storage::GetFieldTemplate() — Method in class Storage

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

Storage::GetClientObject() — Method in class Storage

Returns a printable client object of this storage

Storage::GetCreateUsage() — Method in class Storage

Returns the command usage for Create()

Storage::GetEditUsage() — Method in class Storage

Returns the command usage for Edit()

Storage::GetFreeSpace() — Method in class Storage

Returns the available space in bytes on the storage

Storage::getSize() — Method in class Storage

Returns the size of the file with the given path

UserPass::getEncryptedFields() — Method in class UserPass

UserPass::GetFieldTemplate() — Method in class UserPass

Gets the extra DB fields required for this trait

UserPass::GetClientObject() — Method in class UserPass

Returns the printable client object of this trait

UserPass::GetCreateUsage() — Method in class UserPass

Returns the command usage for Create()

UserPass::GetEditUsage() — Method in class UserPass

Returns the command usage for Edit()

SubFolder::GetObjClass() — Method in class SubFolder

SubFolder::GetName() — Method in class SubFolder

Returns the name of this item

SubFolder::GetParent() — Method in class SubFolder

Returns the parent folder of this item

SubFolder::GetParentID() — Method in class SubFolder

Returns the parent ID of this item

Tag::GetFieldTemplate() — Method in class Tag

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

Tag::GetItem() — Method in class Tag

Returns the item for this tag

Tag::GetClientObject() — Method in class Tag

Returns a printable client object of this tag

BaseApp::getUsage() — Method in class BaseApp

Returns an array of strings showing the CLI usage of the app

BaseApp::getName() — Method in class BaseApp

BaseApp::getLogClass() — Method in class BaseApp

Return this app's BaseAppLog class name, if used (or null)

BaseApp::getMetadata() — Method in class BaseApp

Loads a metadata for the given app with the given key

BaseApp::getAppRequires() — Method in class BaseApp

BaseApp::getAppApiVersion() — Method in class BaseApp

BaseApp::getVersion() — Method in class BaseApp

BaseConfig::GetFieldTemplate() — Method in class BaseConfig

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

BaseConfig::getVersion() — Method in class BaseConfig

Returns the database schema version

Config::GetFieldTemplate() — Method in class Config

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

Config::GetSetConfigUsage() — Method in class Config

Returns the string detailing the CLI usage for SetConfig

Config::GetApps() — Method in class Config

returns the array of registered apps

Config::GetDataDir() — Method in class Config

Returns the configured global data directory path

Config::GetEnableRequestLogDB() — Method in class Config

Returns true if request logging to DB is enabled

Config::GetEnableRequestLogFile() — Method in class Config

Returns true if request logging to data dir file is enabled

Config::GetEnableRequestLog() — Method in class Config

Returns true if request logging is enabled

Config::GetRequestLogDetails() — Method in class Config

Returns the configured request log details detail level

Config::GetDebugLevel() — Method in class Config

Returns the current debug level

Config::GetDebugLog2DB() — Method in class Config

Gets whether the server should log errors to the database

Config::GetDebugLog2File() — Method in class Config

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

Config::GetDebugOverHTTP() — Method in class Config

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

Config::GetMetricsLevel() — Method in class Config

Returns the current metrics log level

Config::GetMetricsLog2DB() — Method in class Config

Gets whether the server should log metrics to the database

Config::GetMetricsLog2File() — Method in class Config

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

Config::GetEnableEmail() — Method in class Config

Gets whether using configured emailers is currently allowed

Config::GetMailer() — Method in class Config

Retrieves a configured mailer service, picking one randomly

Config::GetClientObject() — Method in class Config

Gets the config as a printable client object

CryptoAuth::GenerateKey() — Method in class CryptoAuth

Generates a crypto key for use with this class

CryptoKey::GenerateSalt() — Method in class CryptoKey

Generates a salt for use with DeriveKey()

CryptoPublic::GenerateKeyPair() — Method in class CryptoPublic

Generates a public/private keypair

CryptoSecret::GenerateKey() — Method in class CryptoSecret

Generates a crypto key for use with this class

CryptoSecret::GenerateNonce() — Method in class CryptoSecret

Generates a crypto nonce for use with this class

BaseObject::GetFieldTemplate() — Method in class BaseObject

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

BaseObject::GetDBClass() — Method in class BaseObject

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

BaseObject::GetObjClass() — Method in class BaseObject

BaseObject::GetScalar() — Method in class BaseObject

Gets a scalar field

BaseObject::GetScalarDelta() — Method in class BaseObject

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

BaseObject::GetObject() — Method in class BaseObject

Gets a single object reference

BaseObject::GetObjectID() — Method in class BaseObject

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

BaseObject::GetObjectType() — Method in class BaseObject

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

BaseObject::GetObjectRefs() — Method in class BaseObject

Gets an array of objects that reference this object

BaseObject::GetJoinObject() — Method in class BaseObject

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

DBStats::getQueries() — Method in class DBStats

Returns the array of queries issued to the database

DBStats::getStats() — Method in class DBStats

Returns an array of statistics collected

Database::getDriver() — Method in class Database

Database::GetInstallUsage() — Method in class Database

Returns a string with the primary CLI usage for Install()

Database::GetInstallUsages() — Method in class Database

Returns the CLI usages specific to each driver

Database::GetClientObject() — Method in class Database

returns the array of config that was loaded from the config file

Database::getInfo() — Method in class Database

returns an array with some PDO attributes for debugging

Database::getAllQueries() — Method in class Database

Returns the array of query history

Counter::GetDBValue() — Method in class Counter

Returns the counter's delta as the value to be sent to the DB

JSON::GetDBValue() — Method in class JSON

Returns this field's value as a JSON string for the DB

ObjectJoin::GetIsRefsMany() — Method in class ObjectJoin

return true - referenced objects refer to us in an array

ObjectJoin::GetJoinClass() — Method in class ObjectJoin

ObjectJoin::GetJoinObject() — Method in class ObjectJoin

Return the actual join object used to join us to the given object

ObjectPoly::GetBaseClass() — Method in class ObjectPoly

ObjectPoly::GetRefClass() — Method in class ObjectPoly

ObjectPoly::GetIDTypeDBValue() — Method in class ObjectPoly

Returns the serialized database value of the given object ID and type

ObjectPoly::GetObjectDBValue() — Method in class ObjectPoly

Returns the serialized database value of the given object

ObjectPoly::GetDBValue() — Method in class ObjectPoly

Poly objects are serialized using their ID and class strings

ObjectRef::GetBaseClass() — Method in class ObjectRef

Returns the base class that the referenced object must be

ObjectRef::GetRefClass() — Method in class ObjectRef

ObjectRef::GetRefField() — Method in class ObjectRef

ObjectRef::GetRefIsMany() — Method in class ObjectRef

ObjectRef::GetObject() — Method in class ObjectRef

Returns the object referenced by this field, possibly loading it from the DB

ObjectRefs::GetIsRefsMany() — Method in class ObjectRefs

return false - referenced objects refer to us as a single object

ObjectRefs::GetRefClass() — Method in class ObjectRefs

ObjectRefs::GetRefField() — Method in class ObjectRefs

ObjectRefs::GetObjects() — Method in class ObjectRefs

Load the array of objects referencing this field

Scalar::GetMyField() — Method in class Scalar

Scalar::GetParent() — Method in class Scalar

Scalar::GetValue() — Method in class Scalar

Gets the actual (possibly unserialized) value of this field

Scalar::GetDelta() — Method in class Scalar

Scalar::GetDBValue() — Method in class Scalar

Gets the serialized value of this field that will exist in the DB

JoinObject::GetLeftField() — Method in class JoinObject

Return the column name of the left side of the join

JoinObject::GetLeftClass() — Method in class JoinObject

Return the object class referred to by the left side of the join

JoinObject::GetRightField() — Method in class JoinObject

Return the column name of the right side of the join

JoinObject::GetRightClass() — Method in class JoinObject

Return the object class referred to by the right side of the join

JoinObject::GetFieldTemplate() — Method in class JoinObject

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

JoinObject::GetWhereQuery() — Method in class JoinObject

Returns a query for selecting a unique join object

ObjectDatabase::getLoadedObjectIDs() — Method in class ObjectDatabase

ObjectDatabase::GetClassTableName() — Method in class ObjectDatabase

Return the database table name for a class

ObjectDatabase::GenerateObject() — Method in class ObjectDatabase

Generates a new blank object of the given class

QueryBuilder::GetData() — Method in class QueryBuilder

QueryBuilder::GetText() — Method in class QueryBuilder

Returns the compiled query as a string

QueryBuilder::GreaterThan() — Method in class QueryBuilder

Returns a query string asserting the given column is greater than the given value

QueryBuilder::GetWhere() — Method in class QueryBuilder

Returns the current WHERE string

SingletonObject::GetInstance() — Method in class SingletonObject

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

StandardObject::GetFieldTemplate() — Method in class StandardObject

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

StandardObject::GetDate() — Method in class StandardObject

Returns the timestamp value stored in the given date field

StandardObject::GetDateCreated() — Method in class StandardObject

Returns the timestamp when this object was created

StandardObject::GetFeatureInt() — Method in class StandardObject

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

StandardObject::GetFeatureBool() — Method in class StandardObject

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

StandardObject::GetCounter() — Method in class StandardObject

Gets the value of the given counter field

StandardObject::GetCounterLimit() — Method in class StandardObject

Gets the value of the given counter limit field

StandardObject::GetAllScalars() — Method in class StandardObject

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

EmailRecipient::GetName() — Method in class EmailRecipient

EmailRecipient::GetAddress() — Method in class EmailRecipient

Emailer::GetFieldTemplate() — Method in class Emailer

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

Emailer::GetCreateUsage() — Method in class Emailer

Returns a string with the CLI usage for creating an emailer

Emailer::GetCreateUsages() — Method in class Emailer

Returns a array of strings with the CLI usage for each specific driver

Emailer::GetUseReply() — Method in class Emailer

Returns whether or not to use the server from address for reply-to

Emailer::GetClientObject() — Method in class Emailer

Gets the config as a printable client object

ErrorLog::GetFieldTemplate() — Method in class ErrorLog

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

ErrorLog::GetPropUsage() — Method in class ErrorLog

Returns the common command usage for LoadByInput() and CountByInput()

ErrorLog::GetLoadUsage() — Method in class ErrorLog

Returns the command usage for LoadByInput()

ErrorLog::GetCountUsage() — Method in class ErrorLog

Returns the command usage for CountByInput()

ErrorLog::GetWhereQuery() — Method in class ErrorLog

ErrorLog::GetClientObject() — Method in class ErrorLog

Returns the values of all fields of this error log entry

ErrorLog::GetDebugData() — Method in class ErrorLog

Builds an array of debug data from the given exception

ErrorManager::GetDebugState() — Method in class ErrorManager

Returns true if the configured debug state is >= the requested level

ErrorManager::GetDebugLog() — Method in class ErrorManager

Returns the debug log if allowed by the debug state, else null

IOInterface::GetInputs() — Method in class IOInterface

Retrieves an array of input objects to run

IOInterface::getAddress() — Method in class IOInterface

Returns the address of the user on the interface

IOInterface::getUserAgent() — Method in class IOInterface

Returns the user agent string on the interface

IOInterface::GetDebugLevel() — Method in class IOInterface

Returns the debugging level requested by the interface

IOInterface::GetMetricsLevel() — Method in class IOInterface

Returns the perf metrics level requested by the interface

IOInterface::GetDBConfigFile() — Method in class IOInterface

Returns the path to the DB config file requested by the interface

IOInterface::GetDefaultOutmode() — Method in class IOInterface

Gets the default output mode for the interface

Input::GetApp() — Method in class Input

The app to be run

Input::GetAction() — Method in class Input

The app action to be run

Input::GetAuth() — Method in class Input

The basic authentication to be used

Input::GetParams() — Method in class Input

The inner collection of parameters to be used

Input::GetParam() — Method in class Input

Input::GetOptParam() — Method in class Input

Input::GetNullParam() — Method in class Input

Input::GetOptNullParam() — Method in class Input

Input::GetFiles() — Method in class Input

Returns the array of input files

Input::GetFile() — Method in class Input

Gets the file mapped to the parameter name

InputAuth::GetUsername() — Method in class InputAuth

InputAuth::GetPassword() — Method in class InputAuth

InputPath::GetPath() — Method in class InputPath

Returns the path to the input file

InputPath::GetName() — Method in class InputPath

Returns the name of the file to be used

InputPath::GetSize() — Method in class InputPath

Returns the size of the file to be used

InputPath::GetHandle() — Method in class InputPath

Returns the file's stream resource

InputStream::GetHandle() — Method in class InputStream

Returns the file's stream resource

InputStream::GetData() — Method in class InputStream

Returns the entire stream contents

AJAX::getAddress() — Method in class AJAX

Returns the address of the user on the interface

AJAX::getUserAgent() — Method in class AJAX

Returns the user agent string on the interface

AJAX::GetDefaultOutmode() — Method in class AJAX

AJAX::GetInput() — Method in class AJAX

Fetches an input object from the HTTP request

AJAX::GetRemoteURL() — Method in class AJAX

Build a remote Andromeda request URL

CLI::getKey() — Method in class CLI

Strips -- off the given string and returns (or false if not found)

CLI::getNextValue() — Method in class CLI

Returns the next args value (or null if not found) and increments $i

CLI::getAddress() — Method in class CLI

Returns the address of the user on the interface

CLI::getUserAgent() — Method in class CLI

Returns the user agent string on the interface

CLI::GetDebugLevel() — Method in class CLI

Returns the debugging level requested by the interface

CLI::GetMetricsLevel() — Method in class CLI

Returns the perf metrics level requested by the interface

CLI::GetDBConfigFile() — Method in class CLI

Returns the path to the DB config file requested by the interface

CLI::GetDefaultOutmode() — Method in class CLI

CLI::GetBatch() — Method in class CLI

Reads an array of Input objects from a batch file

CLI::GetInput() — Method in class CLI

Fetches an Input object by reading it from the command line

Output::GetCode() — Method in class Output

Returns the response code for the request

Output::GetMessage() — Method in class Output

Returns the error message string (only if not isOK)

Output::GetAppdata() — Method in class Output

Returns the response body to be returned (only if isOK)

Output::GetAsArray() — Method in class Output

Returns the Output object as a client array

Output::GetAsString() — Method in class Output

Returns the appdata as a single string (or null if not possible)

$ OutputHandler#getbytes — Property in class OutputHandler

OutputHandler::GetBytes() — Method in class OutputHandler

Return the number of bytes that will be output

SafeParam::GetTypeString() — Method in class SafeParam

Returns the string representing the given param type for printing

SafeParam::GetKey() — Method in class SafeParam

Returns the key name of the SafeParam

SafeParam::GetRawValue() — Method in class SafeParam

Returns the raw value of the SafeParam - caution!

SafeParam::GetValue() — Method in class SafeParam

Gets the value of the parameter, doing filtering/validation, and JSON decoding for objects/arrays

SafeParams::GetParam() — Method in class SafeParams

Gets the requested parameter (present and not null)

SafeParams::GetOptParam() — Method in class SafeParams

Same as GetParam() but returns null if the param is not present

SafeParams::GetNullParam() — Method in class SafeParams

Same as GetParam() but returns null if the param is present and null

SafeParams::GetOptNullParam() — Method in class SafeParams

Same as GetParam() but returns null if the param is not present, or is present and null

SafeParams::GetClientObject() — Method in class SafeParams

Returns a plain associative array of each parameter's name mapped to its raw value

InstalledApp::getInstallFlags() — Method in class InstalledApp

InstalledApp::getUpgradeFlags() — Method in class InstalledApp

InstalledApp::getInstallUsage() — Method in class InstalledApp

InstalledApp::getUsage() — Method in class InstalledApp

Returns an array of strings showing the CLI usage of the app

InstalledApp::getConfigClass() — Method in class InstalledApp

Return the BaseConfig class for this app

InstalledApp::getTemplateFolder() — Method in class InstalledApp

Returns the path of the app's code folder

InstalledApp::getUpgradeScripts() — Method in class InstalledApp

ActionLog::GetFieldTemplate() — Method in class ActionLog

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

ActionLog::GetRequestLog() — Method in class ActionLog

ActionLog::GetDetails() — Method in class ActionLog

Returns the log's app-specific "details" field

ActionLog::GetPropUsage() — Method in class ActionLog

Returns the CLI usage string for loading objects by properties

ActionLog::GetPropCriteria() — Method in class ActionLog

Adds query filter parameters using the given input

ActionLog::GetBaseClientObject() — Method in class ActionLog

Returns the printable client object of this action log

ActionLog::GetReqClientObject() — Method in class ActionLog

Returns the printable client object of this action log, with the request log

ActionLog::GetAppClientObject() — Method in class ActionLog

Returns the printable client object of this action log, with the applog

ActionLog::GetFullClientObject() — Method in class ActionLog

Returns the printable client object of this action log, with both the request and applogs

ActionMetrics::GetFieldTemplate() — Method in class ActionMetrics

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

ActionMetrics::GetClientObject() — Method in class ActionMetrics

Gets the printable client object for this object

BaseAppLog::GetActionLog() — Method in class BaseAppLog

Returns the ActionLog parent for this entry

BaseAppLog::GetDetailsLevel() — Method in class BaseAppLog

Returns the configured details log detail level

BaseAppLog::GetDetailsRef() — Method in class BaseAppLog

Returns a direct reference to the "details" log

BaseAppLog::GetBasePropUsage() — Method in class BaseAppLog

Returns the common CLI property usage for all app logs (joined to ActionLog)

BaseAppLog::GetPropCriteria() — Method in class BaseAppLog

Adds query filter parameters using the given input

BaseAppLog::GetClientObject() — Method in class BaseAppLog

Returns the app-specific client object for this applog

BaseAppLog::GetFullClientObject() — Method in class BaseAppLog

Returns the full printable client object for this app log

BaseLog::GetPropUsage() — Method in class BaseLog

Returns the CLI usage string for loading objects by properties

BaseLog::GetPropCriteria() — Method in class BaseLog

Adds query filter parameters using the given input

BaseLog::GetLoadUsage() — Method in class BaseLog

Returns the common CLI usage for loading log entries

BaseLog::GetCountUsage() — Method in class BaseLog

Returns the common CLI usage for counting log entries

BaseLog::GetWhereQuery() — Method in class BaseLog

Returns a compiled query selecting rows from the given input

CommitMetrics::GetFieldTemplate() — Method in class CommitMetrics

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

CommitMetrics::GetClientObject() — Method in class CommitMetrics

Gets the printable client object for this object

RequestLog::GetFieldTemplate() — Method in class RequestLog

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

RequestLog::GetPropUsage() — Method in class RequestLog

Returns the CLI usage string for loading objects by properties

RequestLog::GetPropCriteria() — Method in class RequestLog

Adds query filter parameters using the given input

RequestLog::GetClientObject() — Method in class RequestLog

Returns the printable client object of this request log

RequestLog::GetFullClientObject() — Method in class RequestLog

Returns the printable client object of this request log plus all request actions

RequestMetrics::GetFieldTemplate() — Method in class RequestMetrics

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

RequestMetrics::GetActions() — Method in class RequestMetrics

RequestMetrics::GetClientObject() — Method in class RequestMetrics

Returns the printable client object of this metrics

Main::GetTime() — Method in class Main

Gets the timestamp of when the request was started

Main::GetApps() — Method in class Main

Gets an array of instantiated apps

Main::GetDatabase() — Method in class Main

Returns the global ObjectDatabase instance or throws if not configured

Main::GetConfig() — Method in class Main

Returns the global config object if installed else throws

Main::GetInterface() — Method in class Main

Returns the interface used for the current request

Main::GetErrorManager() — Method in class Main

Returns a reference to the global error manager

Main::GetContext() — Method in class Main

Returns the RunContext that is currently being executed

Main::GetDebugLevel() — Method in class Main

Returns the configured debug level, or the interface's default

RunContext::GetInput() — Method in class RunContext

RunContext::GetActionLog() — Method in class RunContext

RunContext::GetMetrics() — Method in class RunContext

Singleton::GetInstance() — Method in class Singleton

Get the instance of the singleton

Utilities::GetHashAlgo() — Method in class Utilities

Returns the best password_hash algorithm available

Utilities::getClassesMatching() — Method in class Utilities

Returns all classes that are a $match type

VersionInfo::getCompatVer() — Method in class VersionInfo

Returns the Major.Minor compatibility version string

H

Account::HasGroup() — Method in class Account

Returns true if the account is a member of the given group

Account::HasRecoveryKeys() — Method in class Account

True if recovery keys exist for the account

Account::HasTwoFactor() — Method in class Account

True if a two factor exists for the account

Account::HasValidTwoFactor() — Method in class Account

Returns true if the account has a validated two factor and recovery keys

Account::hasCrypto() — Method in class Account

Returns true if server-side crypto is unavailable on the account

$ AuthObject#haveKey — Property in class AuthObject

KeySource::hasCrypto() — Method in class KeySource

Returns true if this key source contains key material

TwoFactor::hasCrypto() — Method in class TwoFactor

Returns whether the OTP secret is stored encrypted

$ FileContext#handle — Property in class FileContext

HostKeyMismatchException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the server's public key has changed

BaseObject::HasObject() — Method in class BaseObject

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

ErrorManager::HandleClientException() — Method in class ErrorManager

Handles a client exception, rolling back the DB, displaying debug data and returning an Output

ErrorManager::HandleThrowable() — Method in class ErrorManager

Handles a non-client exception, rolling back the DB, logging debug data and returning an Output

Input::HasParam() — Method in class Input

Input::HasFile() — Method in class Input

Determines whether or not the given key exists as an input file

$ InputStream#handle — Property in class InputStream

AJAX::HTTPPost() — Method in class AJAX

Helper function to send an HTTP post request

SafeParams::HasParam() — Method in class SafeParams

Returns true if the named parameter exists

Main::HasDatabase() — Method in class Main

Returns true if the global ObjectDatabase instance is valid

I

Account::isAdmin() — Method in class Account

True if this account has administrator privileges

Account::isEnabled() — Method in class Account

True if this account is enabled

Account::InitializeCrypto() — Method in class Account

Initializes secret-key crypto on the account

AccountsApp::Install() — Method in class AccountsApp

Installs the app by importing its SQL file and creating config

AuthAccessLog::isAdmin() — Method in class AuthAccessLog

Returns whether or not the Authenticator had admin status, or null auth was null

AuthObject::InitAuthKey() — Method in class AuthObject

Sets the auth key to a new random value

IMAP — Class in namespace Andromeda\Apps\Accounts\Auth

Uses an IMAP server for authentication

IMAPErrorException — Class in namespace Andromeda\Apps\Accounts\Auth

Exception indicating IMAP encountered an error

IMAPExtensionException — Class in namespace Andromeda\Apps\Accounts\Auth

Exception indicating the IMAP extension does not exist

ISource — Class in namespace Andromeda\Apps\Accounts\Auth

The basic authentication interface

InvalidAuthSourceException — Class in namespace Andromeda\Apps\Accounts\Auth

Exception indicating that the created auth source is invalid

$ Authenticator#input — Property in class Authenticator

$ Authenticator#instances — Property in class Authenticator

Authenticator::isSudoUser() — Method in class Authenticator

Returns true if the user is masquering as another user

Authenticator::isAdmin() — Method in class Authenticator

Returns true if the account used for the request is an admin

Authenticator::isRealAdmin() — Method in class Authenticator

Returns true if the real account used for the request is an admin

Contact::isEmail() — Method in class Contact

Returns true if this contact is an email contact

$ ContactInfo#info — Property in class ContactInfo

FieldCrypt::isFieldEncrypted() — Method in class FieldCrypt

Returns true if the given DB field is encrypted

FieldCrypt::isCryptoAvailable() — Method in class FieldCrypt

Returns true if field crypto is unlockable

Group::Initialize() — Method in class Group

Initializes a newly created group by running group change handlers on its implicit accounts

ImmutableGroupException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that this group membership is for a default group and cannot be changed

InheritedProperty — Class in namespace Andromeda\Apps\Accounts

A value and inherit-source pair

InvalidSessionException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the specified session is invalid

KeySource::InitializeCrypto() — Method in class KeySource

Initializes crypto, storing a copy of the account's master key

TwoFactor::InitializeCrypto() — Method in class TwoFactor

Stores the secret as encrypted by the owner

CoreApp::Install() — Method in class CoreApp

Installs the app by importing its SQL file and creating config

File::Import() — Method in class File

Creates a new file on disk and in the DB, importing content from the given path

BaseFileFS::ImportFile() — Method in class BaseFileFS

Creates a new file and imports its content

FSImpl::ImportFile() — Method in class FSImpl

Creates a new file and imports its content

$ FSManager#interface — Property in class FSManager

FSManager::isExternal() — Method in class FSManager

Returns true if the data in this filesystem is external, false if Andromeda owns it

FSManager::isEncrypted() — Method in class FSManager

Returns true if the data is encrypted before sending to the filesystem

FSManager::isReadOnly() — Method in class FSManager

Returns true if the filesystem is read-only

FSManager::isUserOwned() — Method in class FSManager

Returns true if this filesystem has an owner (not global)

InvalidFSTypeException — Class in namespace Andromeda\Apps\Files\Filesystem

Exception indicating that the stored filesystem type is not valid

InvalidNameException — Class in namespace Andromeda\Apps\Files\Filesystem

Exception indicating that the given filesystem name is invalid

InvalidStorageException — Class in namespace Andromeda\Apps\Files\Filesystem

Exception indicating that the underlying storage connection failed

NativeCrypt::ImportFile() — Method in class NativeCrypt

Creates a new file and imports its content

Folder::isFSDeleted() — Method in class Folder

InvalidDLRangeException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested download byte range is invalid

InvalidDestinationException — Class in namespace Andromeda\Apps\Files

Exception indicating that the folder destination is invalid

InvalidRootOpException — Class in namespace Andromeda\Apps\Files

Exception indicating that the operation is not valid on a root folder

InvalidSharePasswordException — Class in namespace Andromeda\Apps\Files

Exception indicating that the given share password is invalid

InvalidShareTargetException — Class in namespace Andromeda\Apps\Files

Exception indicating invalid share target params were given

Item — Class in namespace Andromeda\Apps\Files

An abstract class defining a user-created item in a filesystem.

Item::isWorldAccess() — Method in class Item

Returns true if this file should be accessible by all accounts

ItemAccess — Class in namespace Andromeda\Apps\Files

Authenticator class that implements item access rules

$ ItemAccess#item — Property in class ItemAccess

ItemAccess::ItemOwnerAccess() — Method in class ItemAccess

Returns whether the given account can access the given item without a share.

ItemAccessDeniedException — Class in namespace Andromeda\Apps\Files

Exception indicating that access to the requested item is denied

ItemLogFullException — Class in namespace Andromeda\Apps\Files

Exception indicating that only one file/folder access can logged

ItemSharingDisabledException — Class in namespace Andromeda\Apps\Files

Exception indicating that item sharing is not allowed

AccountTotal::Initialize() — Method in class AccountTotal

Initializes the account limit by adding stats from all FS items that it owns

Base::Initialize() — Method in class Base

Initializes the limit by gathering statistics

FilesystemTotal::Initialize() — Method in class FilesystemTotal

Initializes the FS total stats by adding stats from all root folders

GroupCommon::IsCounterOverLimit() — Method in class GroupCommon

GroupTimed::Initialize() — Method in class GroupTimed

Initializes group limits by adding a limit for each member account

GroupTotal::Initialize() — Method in class GroupTotal

Initializes group limits by adding a limit for each member account and adding stats

IGroupCommon — Class in namespace Andromeda\Apps\Files\Limits

Timed::Initialize() — Method in class Timed

Initializes the limit by gathering statistics

TimedStats::isCurrent() — Method in class TimedStats

Returns true iff the timed stats is current

Total::Initialize() — Method in class Total

Sets all stats counters to zero

RootFolder::isFSOwnedBy() — Method in class RootFolder

Returned if this root's filesystem is owned by $account

Share::IsLink() — Method in class Share

Returns true if this share is via a link rather than to an account/group

Share::IsExpired() — Method in class Share

Returns true if the share is expired, either by access count or expiry time

FTP::ItemStat() — Method in class FTP

Returns an ItemStat object on the given path

FTP::isFolder() — Method in class FTP

Returns true if the given path is a folder

FTP::isFile() — Method in class FTP

Returns true if the given path is a file

FWrapper::ItemStat() — Method in class FWrapper

Returns an ItemStat object on the given path

FWrapper::isFolder() — Method in class FWrapper

Returns true if the given path is a folder

FWrapper::isFile() — Method in class FWrapper

Returns true if the given path is a file

$ FileContext#isWrite — Property in class FileContext

ItemStat — Class in namespace Andromeda\Apps\Files\Storage

Class representing a stat result

ItemStatFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that stat failed

NoFolders::isFolder() — Method in class NoFolders

S3::ItemStat() — Method in class S3

Returns an ItemStat object on the given path

$ Storage#instances — Property in class Storage

array of all instantiated storages

Storage::isDryRun() — Method in class Storage

Returns true if the server is set to dry run mode

Storage::ItemStat() — Method in class Storage

Returns an ItemStat object on the given path

Storage::isFolder() — Method in class Storage

Returns true if the given path is a folder

Storage::isFile() — Method in class Storage

Returns true if the given path is a file

Storage::ImportFile() — Method in class Storage

Imports an existing file into the storage

Config::isEnabled() — Method in class Config

Returns whether the server is allowed to respond to requests

Config::isDryRun() — Method in class Config

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

Config::isReadOnly() — Method in class Config

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

BaseObject::ID() — Method in class BaseObject

Returns the unique ID of the object

BaseObject::isDeleted() — Method in class BaseObject

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

BaseObject::isCreated() — Method in class BaseObject

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

Database::Install() — Method in class Database

Creates and tests a new database config from the given user input

Database::isReadOnly() — Method in class Database

Returns true if the database is read-only

Database::importTemplate() — Method in class Database

Imports the appropriate SQL template file for an app

Database::importFile() — Method in class Database

Parses and imports an SQL file into the database

Database::inTransaction() — Method in class Database

Returns true if the DB is currently in a transaction

Counter::InitValue() — Method in class Counter

Gives the counter its value from the DB, or 0 if null

JSON::InitValue() — Method in class JSON

Initializes the value of this field by decoding the given JSON string

ObjectJoin::isAutoDelete() — Method in class ObjectJoin

ObjectJoin::InnerLoadObjects() — Method in class ObjectJoin

Perform the inner/core object array loading query using WHERE the join class references us and JOIN the target class

ObjectPoly::InitValue() — Method in class ObjectPoly

Initializes the poly reference using the DB string with the reference's ID and class

ObjectRef::isAutoDelete() — Method in class ObjectRef

$ ObjectRefs#isLoaded — Property in class ObjectRefs

true if the objects array is fully loaded

ObjectRefs::isAutoDelete() — Method in class ObjectRefs

ObjectRefs::InitValue() — Method in class ObjectRefs

Gives the counter its value from the DB, or 0 if null

ObjectRefs::InnerLoadObjects() — Method in class ObjectRefs

Perform the inner/core object array loading query using a WHERE references us on the target class

Scalar::Initialize() — Method in class Scalar

Initializes this field by tying it to an actual object

Scalar::InitValue() — Method in class Scalar

Gives the field its value loaded from the database

Scalar::isMandatorySave() — Method in class Scalar

InvalidDriverException — Class in namespace Andromeda\Core\Database

Exception indicating that the database was requested to use an unknkown driver

ObjectDatabase::InsertObject() — Method in class ObjectDatabase

INSERTs a new object into the database with the given data

QueryBuilder::IsNull() — Method in class QueryBuilder

Returns a string asserting the given column is null

QueryBuilder::IsTrue() — Method in class QueryBuilder

Returns a query string asserting the given column is "true" (greater than zero)

$ SingletonObject#instances — Property in class SingletonObject

StandardObject::isFeatureModified() — Method in class StandardObject

Returns true if the given feature has been modified

$ ErrorManager#interface — Property in class ErrorManager

IOInterface — Class in namespace Andromeda\Core\IOFormat

Describes an abstract PHP I/O interface abstraction

$ IOInterface#inputs — Property in class IOInterface

IOInterface::isApplicable() — Method in class IOInterface

Returns whether or not the interface is in use for this request

IOInterface::isPrivileged() — Method in class IOInterface

Returns whether or not the interface grants privileged access

IOInterface::Initialize() — Method in class IOInterface

Called during API construction to initialize the interface, e.g. to gather global arguments

IOInterface::isMultiOutput() — Method in class IOInterface

Returns true if the output is using multi-output mode

Input — Class in namespace Andromeda\Core\IOFormat

An abstracted Input object gathered from an interface

InputAuth — Class in namespace Andromeda\Core\IOFormat

A username and password combination

InputFileMissingException — Class in namespace Andromeda\Core\IOFormat

InputPath — Class in namespace Andromeda\Core\IOFormat

A file given as a path to an actual file

$ InputPath#istemp — Property in class InputPath

InputPath::isTemp() — Method in class InputPath

Returns true if the file is a temp file that can be moved

InputStream — Class in namespace Andromeda\Core\IOFormat

An input file stream

IntTypeErrorException — Class in namespace Andromeda\Core\IOFormat

Exception indicating the int-type setup code is invalid

AJAX::isApplicable() — Method in class AJAX

Returns whether or not the interface is in use for this request

AJAX::isPrivileged() — Method in class AJAX

CLI::isApplicable() — Method in class CLI

Returns whether or not the interface is in use for this request

CLI::isPrivileged() — Method in class CLI

CLI::Initialize() — Method in class CLI

Initializes CLI by fetching some global params from $argv

IllegalGetFieldException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating that the parameter cannot be part of $_GET

IncorrectCLIUsageException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating that the command line usage is incorrect

InvalidFileException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating that the given file is not valid

InvalidParseException — Class in namespace Andromeda\Core\IOFormat

Output::isOK() — Method in class Output

Returns whether or not the request succeeded

InstallRequiredException — Class in namespace Andromeda\Core

An exception indicating that the app is not installed and needs to be

InstalledApp — Class in namespace Andromeda\Core

Describes an app that needs database installation and has upgrade scripts for upgrading the database

InstalledApp::Install() — Method in class InstalledApp

Installs the app by importing its SQL file and creating config

InvalidAppException — Class in namespace Andromeda\Core

Exception indicating an invalid app name was given

InvalidMailTypeException — Class in namespace Andromeda\Core

Exception indicating that the configured mailer driver is invalid

InvalidVersionException — Class in namespace Andromeda\Core

Exception indicating that the given version string is invalid

BaseAppLog::isFullDetails() — Method in class BaseAppLog

Returns true if the configured details log detail level is >= full

$ Main#interface — Property in class Main

Main::innerCommit() — Method in class Main

Commits the database or does a rollback if readOnly/dryrun

Main::isEnabled() — Method in class Main

if false, requests are not allowed (always true for privileged interfaces)

$ RunContext#input — Property in class RunContext

$ Singleton#instances — Property in class Singleton

J

JSON — Class in namespace Andromeda\Core\Database\FieldTypes

Stores a value that is automatically JSON-encoded

$ ObjectJoin#joinclass — Property in class ObjectJoin

The name of the class that we are joined to

$ ObjectJoin#joinobjs — Property in class ObjectJoin

array cache of join objects

JoinObject — Class in namespace Andromeda\Core\Database

The base class for join objects managed by an ObjectJoin field type.

$ QueryBuilder#joins — Property in class QueryBuilder

QueryBuilder::Join() — Method in class QueryBuilder

Adds a JOIN clause to the query (can have > 1)

JSONDecodingException — Class in namespace Andromeda\Core

Exception indicating that JSON decoding failed

JSONEncodingException — Class in namespace Andromeda\Core

Exception indicating that JSON encoding failed

JSONException — Class in namespace Andromeda\Core

Converts a JSON failure into an exception

Utilities::JSONEncode() — Method in class Utilities

Encodes the data as JSON

Utilities::JSONDecode() — Method in class Utilities

Decodes the JSON data as an array

K

KeySource — Class in namespace Andromeda\Apps\Accounts

An object that holds an encrypted copy of an Account's master key

Share::KeepOwner() — Method in class Share

True if the uploader should stay the owner, else the owner of the parent is the owner

CryptoAuth::KeyLength() — Method in class CryptoAuth

Returns the length of a key for use with this class

CryptoSecret::KeyLength() — Method in class CryptoSecret

Returns the length of a key for use with this class

KeyNotFoundException — Class in namespace Andromeda\Core\Database

Exception indicating the specified field name is invalid

$ SafeParam#key — Property in class SafeParam

L

Account::LoadAllMatchingInfo() — Method in class Account

Returns all accounts whose username, fullname or contacts match the given info

Account::LoadByAuthSource() — Method in class Account

Returns an array of all accounts based on the given auth source

AccountsApp::ListAccounts() — Method in class AccountsApp

Returns a list of all registered accounts

AccountsApp::ListGroups() — Method in class AccountsApp

Returns a list of all registered groups

LDAP — Class in namespace Andromeda\Apps\Accounts\Auth

Uses an LDAP server for authentication

$ LDAP#ldap — Property in class LDAP

LDAPConnectionFailure — Class in namespace Andromeda\Apps\Accounts\Auth

Exception indicating that the LDAP connection failed

LDAPErrorException — Class in namespace Andromeda\Apps\Accounts\Auth

Exception indicating that LDAP encountered an error

LDAPExtensionException — Class in namespace Andromeda\Apps\Accounts\Auth

Exception indicating that the LDAP extension does not exist

Local — Class in namespace Andromeda\Apps\Accounts\Auth

The regular internal authentication source

Contact::LoadAccountsMatchingValue() — Method in class Contact

Returns all accounts matching the given contact value

FieldCrypt::LoadByAccount() — Method in class FieldCrypt

Returns all objects owned by the given account

Group::LoadAllMatchingName() — Method in class Group

Loads all groups matching the given name

CoreApp::ListApps() — Method in class CoreApp

AccessLog::LogAccess() — Method in class AccessLog

Links this log to the given item accessor

File::LoadAdoptedByOwner() — Method in class File

Returns all items with a parent that is not owned by the item owner

FilesApp::LikeFile() — Method in class FilesApp

Likes or dislikes a file

FilesApp::LikeFolder() — Method in class FilesApp

Likes or dislikes a folder

FilesApp::LikeItem() — Method in class FilesApp

Likes or dislikes an item

FilesApp::ListShares() — Method in class FilesApp

Returns a list of shares

FilesApp::ListAdopted() — Method in class FilesApp

Returns a list of all items where the user owns the item but not the parent

FSManager::LoadDefaultByAccount() — Method in class FSManager

Attempts to load the default filesystem (no name)

FSManager::LoadByAccount() — Method in class FSManager

Loads an array of all filesystems owned by the given account

Folder::LoadAdoptedByOwner() — Method in class Folder

Returns all items with a parent that is not owned by the item owner

Item::LoadByOwner() — Method in class Item

Returns an array of all items belonging to the given owner

Item::LoadAdoptedByOwner() — Method in class Item

Returns all items with a parent that is not owned by the item owner

Like — Class in namespace Andromeda\Apps\Files

A user-like (or dislike) on an item

AccountTimed::LoadByAccount() — Method in class AccountTimed

Returns the Timed limits for the given account and time period

AccountTimed::LoadAllForAccountAll() — Method in class AccountTimed

Returns all timed limits for the given account and its groups

AccountTotal::LoadByAccount() — Method in class AccountTotal

Returns the total limits object for this account

AccountTotal::LoadByAccountAll() — Method in class AccountTotal

Loads all limit objects for the given account, including its groups

Base::LoadAll() — Method in class Base

Loads all objects of this type from the database

FilesystemTimed::LoadAllForFilesystem() — Method in class FilesystemTimed

Loads all timed limits for the given filesystem

FilesystemTotal::LoadByFilesystem() — Method in class FilesystemTotal

Loads the total limit object for the given filesystem (or null if none exists)

GroupTimed::LoadByGroup() — Method in class GroupTimed

Loads the timed limit for the given group and time period

GroupTimed::LoadAllForGroup() — Method in class GroupTimed

Returns all timed limits for the given group

GroupTotal::LoadByGroup() — Method in class GroupTotal

Returns the total limits for the given group (or none)

Timed::LoadAllForPeriod() — Method in class Timed

Returns all Timed Limits with the given time period

Timed::LoadAllForClient() — Method in class Timed

Returns all timed limits for the given limited object (all time periods)

Timed::LoadByClientAndPeriod() — Method in class Timed

Loads the limit object for the given object and time period

TimedStats::LoadCurrentByLimit() — Method in class TimedStats

Returns (and creates) the current stats object for the given limit

TimedStats::LoadAllByLimit() — Method in class TimedStats

Loads all stats for the given limit object

TimedStats::LoadByLimitAtTime() — Method in class TimedStats

Loads the TimedStats for the given limit that overlaps the given time

Total::LoadByClient() — Method in class Total

Loads the limit object corresponding to the given limited object

RootFolder::LoadRootsByFSManager() — Method in class RootFolder

Loads all root folders on the given filesystem

RootFolder::LoadRootsByAccount() — Method in class RootFolder

Load all root folders for the given owner

Share::LoadByAccountOwner() — Method in class Share

Returns all shares owned by the given account

Share::LoadByAccountDest() — Method in class Share

Returns all shares targeted at the given account or any of its groups

Local — Class in namespace Andromeda\Apps\Files\Storage

A storage on local-disk on the server

LocalBase — Class in namespace Andromeda\Apps\Files\Storage

LocalNonAdminException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating only admins can create local storage

Storage::LoadByAccount() — Method in class Storage

Loads all storages for the given account (join with FSManager)

Config::ListApps() — Method in class Config

List all installable app folders that exist in the filesystem

BaseObject::LoadByQuery() — Method in class BaseObject

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

BaseObject::LoadAll() — Method in class BaseObject

Loads all objects of this type from the database

BaseObject::LoadByObjectID() — Method in class BaseObject

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

BaseObject::LoadByObject() — Method in class BaseObject

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

Database::logQuery() — Method in class Database

Logs a query to the internal query history, logging the actual data values if debug allows

ObjectRefs::LoadObjects() — Method in class ObjectRefs

Populate the objects array, merging with changes

$ ObjectDatabase#loaded — Property in class ObjectDatabase

ObjectDatabase::LoadObjectsByQuery() — Method in class ObjectDatabase

Loads an array of objects using the given query

$ QueryBuilder#limit — Property in class QueryBuilder

QueryBuilder::Like() — Method in class QueryBuilder

Returns a string comparing the given column to a value using LIKE

QueryBuilder::LessThan() — Method in class QueryBuilder

Returns a query string asserting the given column is less than the given value

QueryBuilder::Limit() — Method in class QueryBuilder

Assigns a LIMIT clause to the query

ErrorLog::LoadByInput() — Method in class ErrorLog

Returns all error log entries matching the given input

ErrorLog::LogDebugData() — Method in class ErrorLog

Creates a new error log entry object from GetDebugData()

ErrorManager::LogException() — Method in class ErrorManager

Log an exception to file (json) and database

ErrorManager::LogDebug() — Method in class ErrorManager

Adds an entry to the custom debug log, saved with exceptions

ErrorManager::LogBreakpoint() — Method in class ErrorManager

Creates an exception and logs it to the main error log (to get a backtrace)

LargeBatchException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating the given batch sequence has too many actions

$ SafeParams#logref — Property in class SafeParams

$ SafeParams#loglevel — Property in class SafeParams

SafeParams::LogData() — Method in class SafeParams

Logs the given $data as $key or sets a sub-log reference if it's a SafeParams

ActionLog::LoadByApplog() — Method in class ActionLog

Returns the ActionLog corresponding to the given BaseAppLog

BaseAppLog::LogDetails() — Method in class BaseAppLog

Adds the given arbitrary data to the log's "details" field

BaseLog::LoadByInput() — Method in class BaseLog

Loads log entries the given input

RequestLog::LogAction() — Method in class RequestLog

Creates an ActionLog for this request from the given action input

Main::LoadApp() — Method in class Main

Loads the main include file for an app and constructs it

Main::LoggedTry() — Method in class Main

Runs the given $func in try/catch and logs if exception

M

$ AccountCreateDeniedException#message — Property in class AccountCreateDeniedException

$ AccountDeleteDeniedException#message — Property in class AccountDeleteDeniedException

$ AccountDisabledException#message — Property in class AccountDisabledException

$ AccountExistsException#message — Property in class AccountExistsException

$ AccountRequiredException#message — Property in class AccountRequiredException

$ AccountWhitelistException#message — Property in class AccountWhitelistException

$ AdminRequiredException#message — Property in class AdminRequiredException

$ AuthSourceTestFailException#message — Property in class AuthSourceTestFailException

$ FTPConnectionFailure#message — Property in class FTPConnectionFailure

$ FTPExtensionException#message — Property in class FTPExtensionException

$ IMAPErrorException#message — Property in class IMAPErrorException

$ IMAPExtensionException#message — Property in class IMAPExtensionException

$ InvalidAuthSourceException#message — Property in class InvalidAuthSourceException

$ LDAPConnectionFailure#message — Property in class LDAPConnectionFailure

$ LDAPErrorException#message — Property in class LDAPErrorException

$ LDAPExtensionException#message — Property in class LDAPExtensionException

Manager — Class in namespace Andromeda\Apps\Accounts\Auth

Manages configured external authentication sources

$ AuthenticationFailedException#message — Property in class AuthenticationFailedException

$ ChangeExternalPasswordException#message — Property in class ChangeExternalPasswordException

$ ContactExistsException#message — Property in class ContactExistsException

$ ContactNotEmailException#message — Property in class ContactNotEmailException

$ ContactNotGivenException#message — Property in class ContactNotGivenException

$ ContactRequiredException#message — Property in class ContactRequiredException

$ CryptoAlreadyInitializedException#message — Property in class CryptoAlreadyInitializedException

$ CryptoInitRequiredException#message — Property in class CryptoInitRequiredException

$ CryptoKeyRequiredException#message — Property in class CryptoKeyRequiredException

$ CryptoNotAllowedException#message — Property in class CryptoNotAllowedException

$ CryptoNotInitializedException#message — Property in class CryptoNotInitializedException

$ CryptoUnlockRequiredException#message — Property in class CryptoUnlockRequiredException

$ DuplicateGroupMembershipException#message — Property in class DuplicateGroupMembershipException

$ GroupExistsException#message — Property in class GroupExistsException

$ ImmutableGroupException#message — Property in class ImmutableGroupException

$ InvalidSessionException#message — Property in class InvalidSessionException

$ NewPasswordRequiredException#message — Property in class NewPasswordRequiredException

$ OldPasswordRequiredException#message — Property in class OldPasswordRequiredException

$ PasswordRequiredException#message — Property in class PasswordRequiredException

$ RawKeyNotAvailableException#message — Property in class RawKeyNotAvailableException

$ RecoveryKeyCreateException#message — Property in class RecoveryKeyCreateException

$ RecoveryKeyFailedException#message — Property in class RecoveryKeyFailedException

$ SearchDeniedException#message — Property in class SearchDeniedException

$ SessionRequiredException#message — Property in class SessionRequiredException

$ TwoFactorRequiredException#message — Property in class TwoFactorRequiredException

$ UnknownAccountException#message — Property in class UnknownAccountException

$ UnknownAuthSourceException#message — Property in class UnknownAuthSourceException

$ UnknownClientException#message — Property in class UnknownClientException

$ UnknownContactException#message — Property in class UnknownContactException

$ UnknownGroupException#message — Property in class UnknownGroupException

$ UnknownGroupMembershipException#message — Property in class UnknownGroupMembershipException

$ UnknownSessionException#message — Property in class UnknownSessionException

$ UnknownTwoFactorException#message — Property in class UnknownTwoFactorException

$ AdminRequiredException#message — Property in class AdminRequiredException

$ DatabaseFailException#message — Property in class DatabaseFailException

MailSendFailException — Class in namespace Andromeda\Apps\Core

Client error indicating that the mailer config failed

$ MailSendFailException#message — Property in class MailSendFailException

$ UnknownMailerException#message — Property in class UnknownMailerException

$ BadItemTypeException#message — Property in class BadItemTypeException

$ CrossFilesystemException#message — Property in class CrossFilesystemException

$ DeletedByStorageException#message — Property in class DeletedByStorageException

$ DuplicateItemException#message — Property in class DuplicateItemException

$ EmailShareDisabledException#message — Property in class EmailShareDisabledException

FilesApp::MoveFile() — Method in class FilesApp

Moves (or copies) a file

FilesApp::MoveFolder() — Method in class FilesApp

Moves (or copies) a folder

FilesApp::MoveItem() — Method in class FilesApp

Moves or copies an item.

BaseFileFS::ManualCopyFolder() — Method in class BaseFileFS

Helper function to emulate copying a folder by copying its contents manually

External::MoveFile() — Method in class External

Moves a file

External::MoveFolder() — Method in class External

Moves a folder

FSImpl::MoveFile() — Method in class FSImpl

Moves a file

FSImpl::MoveFolder() — Method in class FSImpl

Moves a folder

$ InvalidFSTypeException#message — Property in class InvalidFSTypeException

$ InvalidNameException#message — Property in class InvalidNameException

$ InvalidStorageException#message — Property in class InvalidStorageException

Native::MoveFile() — Method in class Native

no-op

Native::MoveFolder() — Method in class Native

no-op

$ NativeCrypt#masterkey — Property in class NativeCrypt

$ InvalidDLRangeException#message — Property in class InvalidDLRangeException

$ InvalidDestinationException#message — Property in class InvalidDestinationException

$ InvalidRootOpException#message — Property in class InvalidRootOpException

$ InvalidSharePasswordException#message — Property in class InvalidSharePasswordException

$ InvalidShareTargetException#message — Property in class InvalidShareTargetException

Item::MapToLimits() — Method in class Item

Maps the given function to all applicable limit objects

Item::MapToTotalLimits() — Method in class Item

Maps the given function to all applicable total limit objects

Item::MapToTimedLimits() — Method in class Item

Maps the given function to all applicable timed limit objects

$ ItemAccessDeniedException#message — Property in class ItemAccessDeniedException

$ ItemLogFullException#message — Property in class ItemLogFullException

$ ItemSharingDisabledException#message — Property in class ItemSharingDisabledException

$ RandomWriteDisabledException#message — Property in class RandomWriteDisabledException

$ ShareExistsException#message — Property in class ShareExistsException

$ ShareExpiredException#message — Property in class ShareExpiredException

$ SharePublicItemException#message — Property in class SharePublicItemException

$ ShareTargetDisabledException#message — Property in class ShareTargetDisabledException

$ ShareURLGenerateException#message — Property in class ShareURLGenerateException

$ FTPAppendOnlyException#message — Property in class FTPAppendOnlyException

$ FTPAuthenticationFailure#message — Property in class FTPAuthenticationFailure

$ FTPConnectionFailure#message — Property in class FTPConnectionFailure

$ FTPCopyFileException#message — Property in class FTPCopyFileException

$ FTPExtensionException#message — Property in class FTPExtensionException

$ FileCloseFailedException#message — Property in class FileCloseFailedException

$ FileCopyFailedException#message — Property in class FileCopyFailedException

$ FileCreateFailedException#message — Property in class FileCreateFailedException

$ FileDeleteFailedException#message — Property in class FileDeleteFailedException

$ FileMoveFailedException#message — Property in class FileMoveFailedException

$ FileOpenFailedException#message — Property in class FileOpenFailedException

$ FileReadFailedException#message — Property in class FileReadFailedException

$ FileRenameFailedException#message — Property in class FileRenameFailedException

$ FileSeekFailedException#message — Property in class FileSeekFailedException

$ FileWriteFailedException#message — Property in class FileWriteFailedException

$ FolderCopyFailedException#message — Property in class FolderCopyFailedException

$ FolderCreateFailedException#message — Property in class FolderCreateFailedException

$ FolderDeleteFailedException#message — Property in class FolderDeleteFailedException

$ FolderMoveFailedException#message — Property in class FolderMoveFailedException

$ FolderReadFailedException#message — Property in class FolderReadFailedException

$ FolderRenameFailedException#message — Property in class FolderRenameFailedException

$ FoldersUnsupportedException#message — Property in class FoldersUnsupportedException

$ FreeSpaceFailedException#message — Property in class FreeSpaceFailedException

$ HostKeyMismatchException#message — Property in class HostKeyMismatchException

$ ItemStat#mtime — Property in class ItemStat

$ ItemStatFailedException#message — Property in class ItemStatFailedException

$ LocalNonAdminException#message — Property in class LocalNonAdminException

$ ReadOnlyException#message — Property in class ReadOnlyException

$ S3AwsSdkException#message — Property in class S3AwsSdkException

$ S3ConnectException#message — Property in class S3ConnectException

$ S3ErrorException#message — Property in class S3ErrorException

$ S3ModifyException#message — Property in class S3ModifyException

$ SMBConnectException#message — Property in class SMBConnectException

$ SMBExtensionException#message — Property in class SMBExtensionException

$ SMBStateInitException#message — Property in class SMBStateInitException

$ SSHAuthenticationFailure#message — Property in class SSHAuthenticationFailure

$ SSHConnectionFailure#message — Property in class SSHConnectionFailure

Storage::MoveFile() — Method in class Storage

Moves a file from $old to $new - name shall not change

Storage::MoveFolder() — Method in class Storage

Moves a folder from $old to $new - name shall not change

$ TestReadFailedException#message — Property in class TestReadFailedException

$ TestWriteFailedException#message — Property in class TestWriteFailedException

$ UnknownDestinationException#message — Property in class UnknownDestinationException

$ UnknownFileException#message — Property in class UnknownFileException

$ UnknownFilesystemException#message — Property in class UnknownFilesystemException

$ UnknownFolderException#message — Property in class UnknownFolderException

$ UnknownItemException#message — Property in class UnknownItemException

$ UnknownObjectException#message — Property in class UnknownObjectException

$ UnknownParentException#message — Property in class UnknownParentException

$ UserStorageDisabledException#message — Property in class UserStorageDisabledException

$ AppDependencyException#message — Property in class AppDependencyException

$ AppVersionException#message — Property in class AppVersionException

$ BaseApp#metadata — Property in class BaseApp

$ CommitAfterRollbackException#message — Property in class CommitAfterRollbackException

CryptoAuth::MakeAuthCode() — Method in class CryptoAuth

Creates an authentication code (MAC) from a message and key

$ BaseObject#modified — Property in class BaseObject

whether or not this object has been modified

$ DatabaseException#message — Property in class DatabaseException

$ DatabaseInvalidException#message — Property in class DatabaseInvalidException

$ DatabaseMissingException#message — Property in class DatabaseMissingException

$ DatabaseQueryException#message — Property in class DatabaseQueryException

$ DatabaseReadOnlyException#message — Property in class DatabaseReadOnlyException

$ DuplicateSingletonException#message — Property in class DuplicateSingletonException

$ DuplicateUniqueKeyException#message — Property in class DuplicateUniqueKeyException

$ FieldTypeException#message — Property in class FieldTypeException

ObjectRefs::MergeWithObjectChanges() — Method in class ObjectRefs

Merge changed references with the object array from the DB

$ Scalar#myfield — Property in class Scalar

The name of this field

$ Scalar#mandatorySave — Property in class Scalar

If true, this field should always be saved even in a rollback

$ InvalidDriverException#message — Property in class InvalidDriverException

$ KeyNotFoundException#message — Property in class KeyNotFoundException

$ NullValueException#message — Property in class NullValueException

$ ObjectNotFoundException#message — Property in class ObjectNotFoundException

$ ObjectTypeException#message — Property in class ObjectTypeException

QueryBuilder::ManyOr() — Method in class QueryBuilder

Syntactic sugar function to check many OR conditions at once

QueryBuilder::ManyAnd() — Method in class QueryBuilder

Syntactic sugar function to check many AND conditions at once

$ RowDeleteFailedException#message — Property in class RowDeleteFailedException

$ RowInsertFailedException#message — Property in class RowInsertFailedException

$ DecryptionFailedException#message — Property in class DecryptionFailedException

$ DuplicateSingletonException#message — Property in class DuplicateSingletonException

$ EmailUnavailableException#message — Property in class EmailUnavailableException

$ Emailer#mailer — Property in class Emailer

$ EmptyRecipientsException#message — Property in class EmptyRecipientsException

$ BreakpointException#message — Property in class BreakpointException

$ ClientDeniedException#message — Property in class ClientDeniedException

$ ClientErrorException#message — Property in class ClientErrorException

$ ClientNotFoundException#message — Property in class ClientNotFoundException

$ NotImplementedException#message — Property in class NotImplementedException

$ ServerException#message — Property in class ServerException

$ FailedAppLoadException#message — Property in class FailedAppLoadException

$ FinalizeTransactionException#message — Property in class FinalizeTransactionException

$ BatchNotAllowedException#message — Property in class BatchNotAllowedException

$ IntTypeErrorException#message — Property in class IntTypeErrorException

$ BatchFileParseException#message — Property in class BatchFileParseException

$ CLI#metrics — Property in class CLI

$ IllegalGetFieldException#message — Property in class IllegalGetFieldException

$ InvalidFileException#message — Property in class InvalidFileException

$ LargeBatchException#message — Property in class LargeBatchException

MethodNotAllowedException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating the HTTP method used is not allowed

$ MethodNotAllowedException#message — Property in class MethodNotAllowedException

$ NoAppActionException#message — Property in class NoAppActionException

$ RemoteInvalidException#message — Property in class RemoteInvalidException

$ UnknownBatchFileException#message — Property in class UnknownBatchFileException

$ InvalidParseException#message — Property in class InvalidParseException

$ Output#message — Property in class Output

$ Output#metrics — Property in class Output

SafeParam::MaxLength() — Method in class SafeParam

Returns a function that checks the max length of the value, for use with GetValue

$ SafeParamUnknownTypeException#message — Property in class SafeParamUnknownTypeException

$ InstallRequiredException#message — Property in class InstallRequiredException

$ InvalidAppException#message — Property in class InvalidAppException

$ InvalidMailTypeException#message — Property in class InvalidMailTypeException

$ InvalidVersionException#message — Property in class InvalidVersionException

$ JSONDecodingException#message — Property in class JSONDecodingException

$ JSONEncodingException#message — Property in class JSONEncodingException

MailSendException — Class in namespace Andromeda\Core

Exception indicating that sending mail failed

$ MailSendException#message — Property in class MailSendException

Main — Class in namespace Andromeda\Core

The main container class managing API singletons and running apps

MaintenanceException — Class in namespace Andromeda\Core

Exception indicating that the server is configured as disabled

$ MaintenanceException#message — Property in class MaintenanceException

MissingMetadataException — Class in namespace Andromeda\Core

An exception indicating that the metadata file is missing

$ MissingMetadataException#message — Property in class MissingMetadataException

MissingSingletonException — Class in namespace Andromeda\Core

Exception indicating that GetInstance() was called on a singleton that has not been constructed

$ MissingSingletonException#message — Property in class MissingSingletonException

$ RunContext#metrics — Property in class RunContext

$ UnknownActionException#message — Property in class UnknownActionException

$ UnknownAppException#message — Property in class UnknownAppException

$ UnwriteableDatadirException#message — Property in class UnwriteableDatadirException

$ UpgradeRequiredException#message — Property in class UpgradeRequiredException

$ VersionInfo#major — Property in class VersionInfo

$ VersionInfo#minor — Property in class VersionInfo

N

Account::NotifyValidContact() — Method in class Account

Sets this account to enabled if it was disabled pending a valid contact

NewPasswordRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that a new password must be provided

File::NotifyCreate() — Method in class File

File::NotifyFSDeleted() — Method in class File

Deletes the file from the DB only

FileCreator::NotifyCreate() — Method in class FileCreator

FolderCreator::NotifyCreate() — Method in class FolderCreator

Native — Class in namespace Andromeda\Apps\Files\Filesystem

An Andromeda native filesystem stores only file content.

NativeCrypt — Class in namespace Andromeda\Apps\Files\Filesystem

Implements an encryption layer on top of the native filesystem.

Folder::NotifyFSDeleted() — Method in class Folder

Deletes this folder and its contents from the DB only

Item::NotifyCreate() — Method in class Item

Creates a new object in the database only (no filesystem call)

Item::NotifyFSDeleted() — Method in class Item

Deletes the item from the DB only

RootFolder::NotifyCreate() — Method in class RootFolder

Creates a new object in the database only (no filesystem call)

Share::NeedsPassword() — Method in class Share

Returns true if this share requires a password to access

NoFolders — Class in namespace Andromeda\Apps\Files\Storage

A storage that does not support subfolders

SubFolder::NotifyCreate() — Method in class SubFolder

Creates a new non-root folder in DB only

CryptoSecret::NonceLength() — Method in class CryptoSecret

Returns the length of a nonce for use with this class

BaseObject::NotNull() — Method in class BaseObject

Asserts that the given object is not null

BaseObject::NotifyDBDeleted() — Method in class BaseObject

Deletes this object without sending to the DB

NullValueException — Class in namespace Andromeda\Core\Database

Exception indicating that the requested scalar is null

QueryBuilder::NotEquals() — Method in class QueryBuilder

Returns a query string asserting the given column is not equal to the given value

QueryBuilder::Not() — Method in class QueryBuilder

Returns a query string that inverts the logic of the given query

$ EmailRecipient#name — Property in class EmailRecipient

NotImplementedException — Class in namespace Andromeda\Core\Exceptions

Exception indicating something is not implemented - these are not unexpected server errors (HTTP 501)

$ IOInterface#numretfuncs — Property in class IOInterface

$ InputPath#name — Property in class InputPath

NoAppActionException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating that the app or action parameters are missing

O

OldPasswordRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the old password must be provided

OptFieldCrypt — Class in namespace Andromeda\Apps\Accounts

Trait for storage classes that store a optionally-encrypted credential fields

File::onOwnerFS() — Method in class File

Returns true if the file resides on a user-added storage

FilesApp::OwnFile() — Method in class FilesApp

Takes ownership of a file

FilesApp::OwnFolder() — Method in class FilesApp

Takes ownership of a folder

FTP::OpenReadHandle() — Method in class FTP

Returns a read handle for the given path

FTP::OpenWriteHandle() — Method in class FTP

Returns a write handle for the given path

FTP::OpenContext() — Method in class FTP

Returns a new handle for the given path

FWrapper::OpenReadHandle() — Method in class FWrapper

Returns a read handle for the given path

FWrapper::OpenWriteHandle() — Method in class FWrapper

Returns a write handle for the given path

FWrapper::OpenContext() — Method in class FWrapper

Returns a new handle for the given path

$ FileContext#offset — Property in class FileContext

S3::OpenReadHandle() — Method in class S3

Returns a read handle for the given path

S3::OpenWriteHandle() — Method in class S3

Returns a write handle for the given path

S3::OpenContext() — Method in class S3

Returns a new handle for the given path

SMB::OpenReadHandle() — Method in class SMB

Returns a read handle for the given path

SMB::OpenWriteHandle() — Method in class SMB

Returns a write handle for the given path

$ Storage#onRollback — Property in class Storage

array of functions to run for rollback

CryptoSecret::OutputOverhead() — Method in class CryptoSecret

Returns the size overhead of an encrypted string over a plaintext one

$ BaseObject#objects — Property in class BaseObject

$ BaseObject#objectrefs — Property in class BaseObject

ObjectJoin — Class in namespace Andromeda\Core\Database\FieldTypes

A field that represents a many-to-many relationship with another object.

ObjectPoly — Class in namespace Andromeda\Core\Database\FieldTypes

Represents a reference to a polymorphic object that implements a base class

ObjectRef — Class in namespace Andromeda\Core\Database\FieldTypes

Stores a reference to another BaseObject

$ ObjectRef#object — Property in class ObjectRef

The object that is referenced

ObjectRefs — Class in namespace Andromeda\Core\Database\FieldTypes

Represents a collection of (non-polymorphic) objects that reference this one.

$ ObjectRefs#objects — Property in class ObjectRefs

array of objects that reference this field

ObjectDatabase — Class in namespace Andromeda\Core\Database

Provides the basic interfaces between BaseObject and the underlying PDO database

$ ObjectDatabase#objects — Property in class ObjectDatabase

ObjectNotFoundException — Class in namespace Andromeda\Core\Database

Exception indicating that the requested object is null

ObjectTypeException — Class in namespace Andromeda\Core\Database

Exception indicating that the requested class does not match the loaded object

$ QueryBuilder#orderby — Property in class QueryBuilder

$ QueryBuilder#orderdesc — Property in class QueryBuilder

$ QueryBuilder#offset — Property in class QueryBuilder

QueryBuilder::Or() — Method in class QueryBuilder

Returns a query string that combines the given arguments using OR

QueryBuilder::OrderBy() — Method in class QueryBuilder

Assigns an ORDER BY clause to the query

QueryBuilder::Offset() — Method in class QueryBuilder

Assigns an OFFSET clause to the query (use with LIMIT)

$ IOInterface#outmode — Property in class IOInterface

Output — Class in namespace Andromeda\Core\IOFormat

Represents the output to be shown to the user

$ Output#ok — Property in class Output

OutputHandler — Class in namespace Andromeda\Core\IOFormat

Class for custom app output routines

$ OutputHandler#output — Property in class OutputHandler

$ StaticWrapper#overrides — Property in class StaticWrapper

P

Client::PruneOldFor() — Method in class Client

Prunes old clients from the DB that have expired

PasswordRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that a password for authentication was required but not given

Session::PruneOldFor() — Method in class Session

Prunes old sessions from the DB that have expired

UsedToken::PruneOldCodes() — Method in class UsedToken

Prunes old codes from the database that are too old to be valid anyway

CoreApp::PHPInfo() — Method in class CoreApp

Prints the phpinfo() page

FilesApp::PurgeLimits() — Method in class FilesApp

Deletes all total limits for the given object

FilesApp::PurgeTimedLimits() — Method in class FilesApp

Deletes all timed limits for the given object

AccountTimed::ProcessGroupRemove() — Method in class AccountTimed

AccountTotal::ProcessGroupRemove() — Method in class AccountTotal

GroupTimed::ProcessAccountChange() — Method in class GroupTimed

GroupTotal::ProcessAccountChange() — Method in class GroupTotal

TimedStats::PruneStatsByLimit() — Method in class TimedStats

Prunes all stats history for the given limit that have expired

PathRollback — Class in namespace Andromeda\Apps\Files\Storage

Class representing a path and rollback action

$ PathRollback#path — Property in class PathRollback

Database::pushStatsContext() — Method in class Database

Add a new performance metrics context on to the stack

Database::popStatsContext() — Method in class Database

Pop the current performance metrics context off of the stack

$ ObjectRefs#parentPoly — Property in class ObjectRefs

True if our object is referenced as a polymorphic field

$ Scalar#parent — Property in class Scalar

Reference to this field's parent object

PHPError — Class in namespace Andromeda\Core\Exceptions

Represents an non-exception error from PHP

$ Input#params — Property in class Input

$ InputAuth#password — Property in class InputAuth

$ InputPath#path — Property in class InputPath

Output::ParseArray() — Method in class Output

Parses a response from a remote Andromeda API request into an Output object

$ SafeParams#params — Property in class SafeParams

$ VersionInfo#patch — Property in class VersionInfo

Q

$ DBStats#query_start — Property in class DBStats

$ DBStats#queries — Property in class DBStats

$ Database#queries — Property in class Database

global history of SQL queries sent to the DB (not a stack)

Database::query() — Method in class Database

Sends an SQL query down to the database, possibly beginning a transaction

QueryBuilder — Class in namespace Andromeda\Core\Database

Minimalistic class for building prepared post-FROM SQL query strings

R

Account::RemoveGroup() — Method in class Account

Removes the account from the given group

Account::RegisterGroupChangeHandler() — Method in class Account

Registers a function to be run when the account is added to or removed from a group

Account::RunGroupChangeHandlers() — Method in class Account

Runs all functions registered to handle the account being added to or removed from a group

Account::RemoveObjectRef() — Method in class Account

Removes the given object from a collection of referenced objects

Account::resetPasswordDate() — Method in class Account

Sets the account's last password change date to 0, potentially forcing a password reset

Account::RegisterDeleteHandler() — Method in class Account

Registers a function to be run when an account is deleted

Account::RegisterCryptoHandler() — Method in class Account

Registers a function to be run when crypto is enabled/disabled on the account

AccountsApp::Run() — Method in class AccountsApp

Checks if the client is running/needs to run install/upgrade {@inheritDoc}

AccountsApp::RunGetConfig() — Method in class AccountsApp

Gets config for this app

AccountsApp::RunSetConfig() — Method in class AccountsApp

Sets config for this app

AccountsApp::RemoveGroupMember() — Method in class AccountsApp

Removes an account from a group

AccountsApp::RemoveWhitelist() — Method in class AccountsApp

Removes an entry from the account create whitelist

$ Authenticator#realaccount — Property in class Authenticator

Authenticator::RequireAdmin() — Method in class Authenticator

Requires that the user is an administrator

Authenticator::RequirePassword() — Method in class Authenticator

Requires that the user provides their password

Authenticator::RequireCrypto() — Method in class Authenticator

Requires that the account's crypto is unlocked for the request (and exists)

Authenticator::RequireCryptoFor() — Method in class Authenticator

Runs TryRequireCrypto() on all instantiated authenticators for $account and throws if not unlocked

FieldCrypt::RequireCrypto() — Method in class FieldCrypt

Unlocks account crypto for usage and returns it

Group::RemoveAccount() — Method in class Group

Removes an account from this group

Group::RegisterDeleteHandler() — Method in class Group

Registers a function to be run when a group is deleted

RawKeyNotAvailableException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the raw (non-hashed) key does not exist in memory

RecoveryKey — Class in namespace Andromeda\Apps\Accounts

A recovery key allows account recovery by bypassing a password

RecoveryKeyBase — Class in namespace Andromeda\Apps\Accounts

RecoveryKeyCreateException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that a recovery key cannot be generated

RecoveryKeyFailedException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the given recovery key is not valid

CoreApp::Run() — Method in class CoreApp

Checks if the client is running/needs to run install/upgrade {@inheritDoc}

CoreApp::RunGetConfig() — Method in class CoreApp

Loads server config

CoreApp::RunSetConfig() — Method in class CoreApp

Sets server config

$ File#refreshed — Property in class File

File::Refresh() — Method in class File

Sends a RefreshFile() command to the filesystem to refresh metadata

File::ReadBytes() — Method in class File

Reads content from the file

FileUtils::ReadStream() — Method in class FileUtils

Reads from the given stream (since fread may only return 8K)

FilesApp::rollback() — Method in class FilesApp

Tells the app to rollback any changes made outside the database

FilesApp::Run() — Method in class FilesApp

Checks if the client is running/needs to run install/upgrade {@inheritDoc}

FilesApp::RunGetConfig() — Method in class FilesApp

Gets config for this app

FilesApp::RunSetConfig() — Method in class FilesApp

Sets config for this app

FilesApp::RenameFile() — Method in class FilesApp

Renames (or copies) a file

FilesApp::RenameFolder() — Method in class FilesApp

Renames (or copies) a folder

FilesApp::RenameItem() — Method in class FilesApp

Renames or copies an item

BaseFileFS::ReadBytes() — Method in class BaseFileFS

Reads the exact number of desired bytes from the given file

External::RefreshFile() — Method in class External

Updates the given DB file from disk

External::RefreshFolder() — Method in class External

Updates the given DB folder (and contents) from disk

External::RenameFile() — Method in class External

Renames a file to the given name

External::RenameFolder() — Method in class External

Renames a folder to the given name

FSImpl::RefreshFile() — Method in class FSImpl

Synchronizes the given file's metadata with storage

FSImpl::RefreshFolder() — Method in class FSImpl

Synchronizes the given folder's metadata with storage

FSImpl::ReadBytes() — Method in class FSImpl

Reads the exact number of desired bytes from the given file

FSImpl::RenameFile() — Method in class FSImpl

Renames a file to the given name

FSImpl::RenameFolder() — Method in class FSImpl

Renames a folder to the given name

Native::RefreshFile() — Method in class Native

no-op

Native::RefreshFolder() — Method in class Native

no-op

Native::RenameFile() — Method in class Native

no-op

Native::RenameFolder() — Method in class Native

no-op

NativeCrypt::ReadBytes() — Method in class NativeCrypt

Reads the exact number of desired bytes from the given file

NativeCrypt::ReadChunk() — Method in class NativeCrypt

Reads and decrypts the given chunk from the file

$ Folder#refreshed — Property in class Folder

Folder::RemoveObjectRef() — Method in class Folder

Removes the given object from a collection of referenced objects

Folder::Refresh() — Method in class Folder

Refreshes the folder's metadata from disk

Folder::RecursiveItems() — Method in class Folder

Recursively lists subitems in this folder

Item::Refresh() — Method in class Item

Updates the metadata of this item by scanning the object in the filesystem

RandomWriteDisabledException — Class in namespace Andromeda\Apps\Files

Exception indicating that random write access is not allowed

RootFolder — Class in namespace Andromeda\Apps\Files

A root folder has no parent or name

ReadOnlyException — Class in namespace Andromeda\Apps\Files\Storage

Client exception indicating that a write was attempted to a read-only storage

Storage::ReadFolder() — Method in class Storage

Lists the contents of a folder

Storage::ReadBytes() — Method in class Storage

Reads data from a file

Storage::RenameFile() — Method in class Storage

Renames a file from $old to $new - path shall not change

Storage::RenameFolder() — Method in class Storage

Renames a folder from $old to $new - path shall not change

Storage::renameRollbacks() — Method in class Storage

Moves all pending rollback actions from $old to $new for delete tracking

Storage::rollback() — Method in class Storage

Storage::rollbackAll() — Method in class Storage

Rolls back all instantiated filesystems

BaseApp::Run() — Method in class BaseApp

The main entry point into the app

BaseApp::rollback() — Method in class BaseApp

Tells the app to rollback any changes made outside the database

BaseObject::RemoveObjectRef() — Method in class BaseObject

Removes the given object from a collection of referenced objects

$ DBStats#reads — Property in class DBStats

$ DBStats#read_time — Property in class DBStats

$ Database#read_only — Property in class Database

if true, don't allow writes

Database::RequiresSAVEPOINT() — Method in class Database

Whether or not the DB aborts transactions after an error and requires use of SAVEPOINTs

Database::rollback() — Method in class Database

Rolls back the current database transaction

ObjectJoin::RemoveObject() — Method in class ObjectJoin

Also deletes the join object joining us to the given object

$ ObjectRef#refclass — Property in class ObjectRef

The class of the object that is referenced

$ ObjectRef#reffield — Property in class ObjectRef

The name of the field in the referenced object that cross-references our parent object

$ ObjectRef#refmany — Property in class ObjectRef

if true and reffield is null, the referenced object's reffield is an array of objects rather than a single reference

$ ObjectRefs#refclass — Property in class ObjectRefs

$ ObjectRefs#reffield — Property in class ObjectRefs

The name of the field in the referenced object that references our parent object

$ ObjectRefs#refs_added — Property in class ObjectRefs

$ ObjectRefs#refs_deleted — Property in class ObjectRefs

ObjectRefs::RemoveObject() — Method in class ObjectRefs

Deletes the given object from this field's object array

$ Scalar#realvalue — Property in class Scalar

The actual value of this field that will exist in the DB

Scalar::ResetDelta() — Method in class Scalar

Resets the delta of this field to 0

ObjectDatabase::Rows2Objects() — Method in class ObjectDatabase

Converts database rows into objects

RowDeleteFailedException — Class in namespace Andromeda\Core\Database

Exception indicating that the desired row was not deleted

RowInsertFailedException — Class in namespace Andromeda\Core\Database

Exception indicating that the desired row was not inserted

$ IOInterface#retfuncs — Property in class IOInterface

IOInterface::RegisterOutputHandler() — Method in class IOInterface

Registers a user output handler function to run after the initial commit

AJAX::RemoteRequest() — Method in class AJAX

Send a request to a remote Andromeda API

RemoteInvalidException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating that the remote response is invalid

InstalledApp::Run() — Method in class InstalledApp

Checks if the client is running/needs to run install/upgrade {@inheritDoc}

RequestLog — Class in namespace Andromeda\Core\Logging

Log entry representing an API request

RequestMetrics — Class in namespace Andromeda\Core\Logging

Log entry representing an metrics for a request

$ Main#reqlog — Property in class Main

$ Main#rolledback — Property in class Main

Main::Run() — Method in class Main

Calls into an app to run the given Input command

Main::RunRemote() — Method in class Main

Calls into a remote API to run the given Input command

Main::rollback() — Method in class Main

Rolls back the current transaction. Internal only, do not call via apps.

RunContext — Class in namespace Andromeda\Core

Transactions::rollback() — Method in class Transactions

Utilities::RandomRange() — Method in class Utilities

Returns the number of possible characters for a digit in Random

Utilities::Random() — Method in class Utilities

Returns a random string with the given length

Utilities::return_bytes() — Method in class Utilities

Returns a size string converted to bytes

Utilities::replace_first() — Method in class Utilities

Equivalent to str_replace but only does one replacement

Utilities::RunAtomic() — Method in class Utilities

Runs the given function with no execution timeouts or user aborts

S

Account::SetFullName() — Method in class Account

Sets the account's full name

Account::setAdmin() — Method in class Account

Sets this account's admin-status to the given value

Account::setDisabled() — Method in class Account

Sets the account's disabled status to the given enum value

Account::setActiveDate() — Method in class Account

Sets the last-active timestamp to now

Account::setLoggedonDate() — Method in class Account

Sets the timestamp of last-login to now

Account::setPasswordDate() — Method in class Account

Account::SearchByFullName() — Method in class Account

Returns an array of accounts with any part of their full name matching the name given

Account::SendMessage() — Method in class Account

Sends a message to all of this account's valid contacts

Account::SetPasswordHash() — Method in class Account

Sets the account's password hash to the given value

AccountsApp::SetFullName() — Method in class AccountsApp

Sets the user's full (real) name

AccountsApp::SearchAccounts() — Method in class AccountsApp

Searches for accounts identified with the given name prefix

AccountsApp::SearchGroups() — Method in class AccountsApp

Searches for groups identified with the given name prefix

AccountsApp::SetAccountProps() — Method in class AccountsApp

Sets config on an account

AccountsApp::SetGroupProps() — Method in class AccountsApp

Sets config on a group

AccountsApp::SendMessage() — Method in class AccountsApp

Sends a message to the given account or group's contacts

AuthEntity::SendMessage() — Method in class AuthEntity

AuthEntity::SetProperties() — Method in class AuthEntity

Sets the value of an inherited property for the object

FTP::SubConstruct() — Method in class FTP

Asserts that the FTP extension exists

IMAP::SubConstruct() — Method in class IMAP

Checks for the existence of the IMAP extension

LDAP::SubConstruct() — Method in class LDAP

Checks for the existence of the LDAP extension

Local::SetPassword() — Method in class Local

Hashes and sets the given password on a given account

$ Authenticator#session — Property in class Authenticator

Authenticator::StaticTryRequireTwoFactor() — Method in class Authenticator

Authenticator::StaticTryRequireCrypto() — Method in class Authenticator

Same as StaticRequireCrypto() but does nothing if the account does not have crypto

Authenticator::StaticRequireCrypto() — Method in class Authenticator

Client::setActiveDate() — Method in class Client

Sets the timestamp this client was active to now

Client::setLoggedonDate() — Method in class Client

Sets the timestamp when the client last created a session

Config::SetConfig() — Method in class Config

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

Config::SetDefaultAuth() — Method in class Config

Sets the default auth manager to the given value

Config::SetAllowCreateAccount() — Method in class Config

Sets whether the API for creating new accounts is enabled

Config::SetUsernameIsContact() — Method in class Config

Sets whether emails should be used as usernames

Config::SetRequireContact() — Method in class Config

Contact::SetIsValid() — Method in class Contact

Sets whether the contact has been validated

Contact::setIsPublic() — Method in class Contact

Sets whether this contact should be publically searchable

Contact::setUseFrom() — Method in class Contact

Sets whether this contact should be used as from (can only be one)

Contact::SendMessage() — Method in class Contact

Sends a message to this contact

Contact::SendMessageMany() — Method in class Contact

Sends a message to the given array of contacts

Contact::SendEmails() — Method in class Contact

Sends a message to the given email recipients

FieldCrypt::SetEncryptedScalar() — Method in class FieldCrypt

Sets the value of the given field

FieldCrypt::SetEncrypted() — Method in class FieldCrypt

Sets the crypto state of all stored fields

Group::SetDisplayName() — Method in class Group

Sets the short name of the group

Group::SetComment() — Method in class Group

Sets the comment for the group (or null)

Group::SetPriority() — Method in class Group

Sets the priority assigned to the group

Group::SendMessage() — Method in class Group

Sends a message to all of this group's accounts' valid contacts (with BCC)

$ InheritedProperty#source — Property in class InheritedProperty

SearchDeniedException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that account/group search is not allowed

Session — Class in namespace Andromeda\Apps\Accounts

Implements an account session, the primary implementor of authentication

Session::setActiveDate() — Method in class Session

Sets the timestamp this client was active to now

SessionRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the action requires a session to use

CoreApp::ServerInfo() — Method in class CoreApp

Gets miscellaneous server identity information

Comment::SetComment() — Method in class Comment

Sets the value of this comment and updates the modified date

Config::SetConfig() — Method in class Config

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

File::SetSize() — Method in class File

Sets the size of the file and update stats

File::SetName() — Method in class File

Renames the item. If $overwrite, deletes an object if the target already exists.

File::SetParent() — Method in class File

Moves the item to a new parent. If $overwrite, deletes an object if the target already exists.

File::SetContents() — Method in class File

Sets the file's contents to the file of the given path

FilesApp::ShareFile() — Method in class FilesApp

Creates shares for a file

FilesApp::ShareFolder() — Method in class FilesApp

Creates shares for a folder

FilesApp::ShareItem() — Method in class FilesApp

Creates shares for an item

FilesApp::ShareInfo() — Method in class FilesApp

Retrieves metadata on a share object (from a link)

FSManager::SetReadOnly() — Method in class FSManager

Sets whether this filesystem is read-only

FSManager::SetName() — Method in class FSManager

Sets the name of this filesystem, checks uniqueness

FSManager::SetOwner() — Method in class FSManager

Sets the owner of this filesystem to the given account

FSManager::SetType() — Method in class FSManager

Changes the filesystem impl enum type to the given value

$ Folder#subrefreshed — Property in class Folder

Folder::SetOwnerRecursive() — Method in class Folder

Sets this folder and its contents' owners to the given account

Item::SetName() — Method in class Item

Renames the item. If $overwrite, deletes an object if the target already exists.

Item::SetParent() — Method in class Item

Moves the item to a new parent. If $overwrite, deletes an object if the target already exists.

Item::SetDescription() — Method in class Item

Sets this item's description to the given value

Item::SetOwner() — Method in class Item

Sets this item's owner to the given account

Item::SetAccessed() — Method in class Item

Sets the item's access time to the given value or now if null

Item::SetCreated() — Method in class Item

Sets the item's created time to the given value or now if null

Item::SetModified() — Method in class Item

Sets the item's modified time to the given value or now if null

Item::SubGetClientObject() — Method in class Item

Returns a printable client object of this item

$ ItemAccess#share — Property in class ItemAccess

AccountCommon::SetBaseLimits() — Method in class AccountCommon

AccountTimed::SubConstruct() — Method in class AccountTimed

register a group change handler that updates this specific object's grouplim cache

AccountTotal::SubConstruct() — Method in class AccountTotal

register a group change handler that updates this specific object's grouplim cache

AuthEntityTimed::SetTimedLimits() — Method in class AuthEntityTimed

Sets config for a timed limit

Base::SetBaseLimits() — Method in class Base

Sets the properties that apply to Base limits

FilesystemCommon::SetBaseLimits() — Method in class FilesystemCommon

FilesystemTimed::SetTimedLimits() — Method in class FilesystemTimed

Sets config for a timed limit

GroupCommon::SetBaseLimits() — Method in class GroupCommon

GroupTimed::SubConstruct() — Method in class GroupTimed

register a group change handler that updates this specific object's accountlim cache

GroupTotal::SubConstruct() — Method in class GroupTotal

register a group change handler that updates this specific object's accountlim cache

Timed::SetTimedLimits() — Method in class Timed

Sets config for a timed limit

Total::SetDownloadDate() — Method in class Total

Updates the last download timestamp to now

Total::SetUploadDate() — Method in class Total

Updates the last upload (file create) timestamp to now

RootFolder::SetName() — Method in class RootFolder

Renames the item. If $overwrite, deletes an object if the target already exists.

RootFolder::SetParent() — Method in class RootFolder

Moves the item to a new parent. If $overwrite, deletes an object if the target already exists.

Share — Class in namespace Andromeda\Apps\Files

A share granting access to an item

Share::SetAccessed() — Method in class Share

Sets the share's access date to now and increments the access counter

Share::SetPassword() — Method in class Share

Sets the given password for this share

Share::SetOptions() — Method in class Share

Modifies share permissions and properties from the given input

ShareExistsException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested share already exists

ShareExpiredException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested share has expired

SharePublicItemException — Class in namespace Andromeda\Apps\Files

Exception indicating that a share was requested for a public item

ShareTargetDisabledException — Class in namespace Andromeda\Apps\Files

Exception indicating that sharing to the given target is not allowed

ShareURLGenerateException — Class in namespace Andromeda\Apps\Files

Exception indicating that the absolute URL of a share cannot be determined

BasePath::SetPath() — Method in class BasePath

Sets the path of the storage's root

FTP::SubConstruct() — Method in class FTP

Check for the FTP extension

FTP::SubReadFolder() — Method in class FTP

The storage-specific ReadFolder

FTP::SubCreateFolder() — Method in class FTP

The storage-specific CreateFolder

FTP::SubCreateFile() — Method in class FTP

The storage-specific CreateFile

FTP::SubImportFile() — Method in class FTP

The storage-specific ImportFile

FTP::supportsReadWrite() — Method in class FTP

Returns true if we can read from a stream opened as write

FTP::supportsSeekReuse() — Method in class FTP

Returns true if an already-open stream can be seeked randomly

FTP::SubTruncate() — Method in class FTP

FTP::SubDeleteFile() — Method in class FTP

The storage-specific DeleteFile

FTP::SubDeleteFolder() — Method in class FTP

The storage-specific DeleteFolder

FTP::SubRenameFile() — Method in class FTP

The storage-specific RenameFile

FTP::SubRenameFolder() — Method in class FTP

The storage-specific RenameFolder

FTP::SubMoveFile() — Method in class FTP

The storage-specific MoveFile

FTP::SubMoveFolder() — Method in class FTP

The storage-specific MoveFolder

FTP::SubCopyFile() — Method in class FTP

The storage-specific CopyFile

FWrapper::SubReadFolder() — Method in class FWrapper

The storage-specific ReadFolder

FWrapper::SubCreateFolder() — Method in class FWrapper

The storage-specific CreateFolder

FWrapper::SubCreateFile() — Method in class FWrapper

The storage-specific CreateFile

FWrapper::SubImportFile() — Method in class FWrapper

The storage-specific ImportFile

FWrapper::SubTruncate() — Method in class FWrapper

The storage-specific Truncate

FWrapper::SubDeleteFile() — Method in class FWrapper

The storage-specific DeleteFile

FWrapper::SubDeleteFolder() — Method in class FWrapper

The storage-specific DeleteFolder

FWrapper::SubRenameFile() — Method in class FWrapper

The storage-specific RenameFile

FWrapper::SubRenameFolder() — Method in class FWrapper

The storage-specific RenameFolder

FWrapper::SubMoveFile() — Method in class FWrapper

The storage-specific MoveFile

FWrapper::SubMoveFolder() — Method in class FWrapper

The storage-specific MoveFolder

FWrapper::SubCopyFile() — Method in class FWrapper

The storage-specific CopyFile

FWrapper::SubReadBytes() — Method in class FWrapper

The storage-specific ReadBytes

FWrapper::SubWriteBytes() — Method in class FWrapper

The storage-specific WriteBytes

FWrapper::supportsReadWrite() — Method in class FWrapper

Returns true if we can read from a stream opened as write

FWrapper::supportsSeekReuse() — Method in class FWrapper

Returns true if an already-open stream can be seeked randomly

$ ItemStat#size — Property in class ItemStat

Local::SubImportFile() — Method in class Local

Import the file quickly by just renaming it if allowed

NoFolders::supportsFolders() — Method in class NoFolders

NoFolders::SubCreateFolder() — Method in class NoFolders

NoFolders::SubDeleteFolder() — Method in class NoFolders

NoFolders::SubRenameFolder() — Method in class NoFolders

NoFolders::SubMoveFile() — Method in class NoFolders

NoFolders::SubMoveFolder() — Method in class NoFolders

NoFolders::SubCopyFolder() — Method in class NoFolders

S3 — Class in namespace Andromeda\Apps\Files\Storage

Allows using an S3-compatible server for backend storage

$ S3#s3 — Property in class S3

s3 connection resource

$ S3#streamID — Property in class S3

The stream wrapper ID

S3::SetAccessKey() — Method in class S3

Sets the S3 access key to the given value

S3::SetSecretKey() — Method in class S3

Sets the S3 secret key to the given value

S3::SubConstruct() — Method in class S3

Checks for the SMB client extension

S3::SubReadFolder() — Method in class S3

The storage-specific ReadFolder

S3::SubReadBytes() — Method in class S3

The storage-specific ReadBytes

S3::supportsReadWrite() — Method in class S3

Returns true if we can read from a stream opened as write

S3::supportsSeekReuse() — Method in class S3

Returns true if an already-open stream can be seeked randomly

S3::SubCreateFile() — Method in class S3

The storage-specific CreateFile

S3::SubTruncate() — Method in class S3

The storage-specific Truncate

S3AwsSdkException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the S3 SDK is missing

S3Base — Class in namespace Andromeda\Apps\Files\Storage

S3ConnectException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that S3 failed to connect or read the base path

S3ErrorException — Class in namespace Andromeda\Apps\Files\Storage

Exception that wraps S3 SDK exceptions

S3ModifyException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that objects cannot be modified

SFTP — Class in namespace Andromeda\Apps\Files\Storage

Allows using an SFTP server for backend storage using phpseclib

$ SFTP#sftp — Property in class SFTP

sftp connection resource

SFTP::SetPrivkey() — Method in class SFTP

Sets the private key used for authentication

SFTP::SetKeypass() — Method in class SFTP

Sets the password for the private key, encrypted if $fieldcrypt

SFTP::SetHostKey() — Method in class SFTP

Sets the cached host public key to the given value

SFTP::SubImportFile() — Method in class SFTP

The storage-specific ImportFile

SFTPBase1 — Class in namespace Andromeda\Apps\Files\Storage

SFTPBase2 — Class in namespace Andromeda\Apps\Files\Storage

SMB — Class in namespace Andromeda\Apps\Files\Storage

Allows using an SMB/CIFS server for backend storage

$ SMB#state — Property in class SMB

SMB::SubConstruct() — Method in class SMB

Checks for the SMB client extension

SMB::SubTruncate() — Method in class SMB

The storage-specific Truncate

SMBBase1 — Class in namespace Andromeda\Apps\Files\Storage

SMBBase2 — Class in namespace Andromeda\Apps\Files\Storage

SMBConnectException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that SMB failed to connect or read the base path

SMBExtensionException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the libsmbclient extension is missing

SMBStateInitException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the SMB state initialization failed

SSHAuthenticationFailure — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that SSH authentication failed

SSHConnectionFailure — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the SSH connection failed

Storage — Class in namespace Andromeda\Apps\Files\Storage

A Storage implements the on-disk functions that actually store data.

Storage::supportsFolders() — Method in class Storage

By default, most storages support using folders

Storage::SubReadFolder() — Method in class Storage

The storage-specific ReadFolder

Storage::SubCreateFolder() — Method in class Storage

The storage-specific CreateFolder

Storage::SubCreateFile() — Method in class Storage

The storage-specific CreateFile

Storage::SubImportFile() — Method in class Storage

The storage-specific ImportFile

Storage::SubReadBytes() — Method in class Storage

The storage-specific ReadBytes

Storage::SubWriteBytes() — Method in class Storage

The storage-specific WriteBytes

Storage::SubTruncate() — Method in class Storage

The storage-specific Truncate

Storage::SubDeleteFile() — Method in class Storage

The storage-specific DeleteFile

Storage::SubDeleteFolder() — Method in class Storage

The storage-specific DeleteFolder

Storage::SubRenameFile() — Method in class Storage

The storage-specific RenameFile

Storage::SubRenameFolder() — Method in class Storage

The storage-specific RenameFolder

Storage::SubMoveFile() — Method in class Storage

The storage-specific MoveFile

Storage::SubMoveFolder() — Method in class Storage

The storage-specific MoveFolder

Storage::SubCopyFile() — Method in class Storage

The storage-specific CopyFile

Storage::SubCopyFolder() — Method in class Storage

The storage-specific CopyFolder

Storage::SubConstruct() — Method in class Storage

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

StorageException — Class in namespace Andromeda\Apps\Files\Storage

Base exception indicating a storage failure

UserPass::SetUsername() — Method in class UserPass

Sets the stored username

UserPass::SetPassword() — Method in class UserPass

Sets the stored password

SubFolder — Class in namespace Andromeda\Apps\Files

A subfolder has a parent

SubFolder::SetName() — Method in class SubFolder

Renames the item. If $overwrite, deletes an object if the target already exists.

SubFolder::SetParent() — Method in class SubFolder

Moves the item to a new parent. If $overwrite, deletes an object if the target already exists.

BaseConfig::setVersion() — Method in class BaseConfig

Sets the database schema version to the given value

Config::SetConfig() — Method in class Config

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

Config::setEnabled() — Method in class Config

Set whether the server is allowed to respond to requests

Config::setDryRun() — Method in class Config

Sets the server to dryrun mode if $val is true

Config::SetDebugLevel() — Method in class Config

Sets the current debug level

Config::SetMetricsLevel() — Method in class Config

Sets the current metrics log level

$ BaseObject#scalars — Property in class BaseObject

BaseObject::SetScalar() — Method in class BaseObject

Sets a scalar field to the given value

BaseObject::SetObject() — Method in class BaseObject

Same as BoolSetObject() but returns $this

BaseObject::SubConstruct() — Method in class BaseObject

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

BaseObject::Save() — Method in class BaseObject

Collects fields that have changed and saves them to the database

$ DBStats#start_time — Property in class DBStats

DBStats::startQuery() — Method in class DBStats

Begins tracking a query by logging the current time

$ Database#stats_stack — Property in class Database

Database::setReadOnly() — Method in class Database

Sets the database as writeable or readonly

Database::SupportsRETURNING() — Method in class Database

Whether or not the DB supports the RETURNING keyword

Database::SQLConcat() — Method in class Database

Returns the given arguments concatenated in SQL

Database::SQLUpsert() — Method in class Database

Returns the driver-specific SQL UPSERT DO NOTHING query

Database::startTimingQuery() — Method in class Database

Begins timing a query (performance metrics)

Database::stopTimingQuery() — Method in class Database

Ends timing a query (performance metrics)

ObjectPoly::ShortClass() — Method in class ObjectPoly

Returns the given class name minus the first namespace

ObjectPoly::SetObject() — Method in class ObjectPoly

Also updates the class name of the object

ObjectRef::SetObject() — Method in class ObjectRef

Sets the value of this field to reference the given object

Scalar — Class in namespace Andromeda\Core\Database\FieldTypes

Represents a basic scalar value stored in the column of a database table

Scalar::SetValue() — Method in class Scalar

ObjectDatabase::saveObjects() — Method in class ObjectDatabase

Loops through every objects and saves them to the DB

ObjectDatabase::SaveObject() — Method in class ObjectDatabase

UPDATEs an object in the database with the given data

QueryBuilder::SelfJoinWhere() — Method in class QueryBuilder

Performs a self join on a table (selects an alias table and sets the WHERE query)

SingletonObject — Class in namespace Andromeda\Core\Database

Extends StandardObject with interfaces for a singleton object

StandardObject — Class in namespace Andromeda\Core\Database

Extends BaseObject with helpers for some commonly-used interfaces

StandardObject::SetDate() — Method in class StandardObject

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

StandardObject::SetFeatureInt() — Method in class StandardObject

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

StandardObject::SetFeatureBool() — Method in class StandardObject

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

StandardObject::SetCounterLimit() — Method in class StandardObject

Sets the value of the given counter limit field

Emailer::SendMail() — Method in class Emailer

Send an email

ErrorManager::SetAPI() — Method in class ErrorManager

ServerException — Class in namespace Andromeda\Core\Exceptions

Base class for server exceptions (errors in server code)

IOInterface::subGetInputs() — Method in class IOInterface

IOInterface::SetOutputMode() — Method in class IOInterface

Sets the output mode to the given mode or null (none) - NOT USED in "multi-output" mode!

Input::SetLogger() — Method in class Input

Sets the optional param logger to the given BaseAppLog

AJAX::subGetInputs() — Method in class AJAX

Retrieves an array of input objects from the request to run

CLI::subGetInputs() — Method in class CLI

Output::SetMetrics() — Method in class Output

Sets performance metrics to be returned

Output::Success() — Method in class Output

Constructs an Output object representing a success response

SafeParam — Class in namespace Andromeda\Core\IOFormat

Class representing a client input parameter

SafeParamException — Class in namespace Andromeda\Core\IOFormat

Base exception indicating a problem with a client parameter

SafeParamInvalidEnumException — Class in namespace Andromeda\Core\IOFormat

Exception indicating an invalid enum-based paramter

SafeParamInvalidException — Class in namespace Andromeda\Core\IOFormat

Exception indicating that the parameter failed sanitization or validation

SafeParamKeyMissingException — Class in namespace Andromeda\Core\IOFormat

An exception indicating that the requested parameter name does not exist

SafeParamNullValueException — Class in namespace Andromeda\Core\IOFormat

An exception indicating that the requested parameter has a null value

SafeParamUnknownTypeException — Class in namespace Andromeda\Core\IOFormat

Exception indicating that an invalid type was requested

SafeParams — Class in namespace Andromeda\Core\IOFormat

A thin class that manages a collection of SafeParam objects

SafeParams::SetLogRef() — Method in class SafeParams

Takes an array reference for logging fetched parameters

ActionLog::SetApplog() — Method in class ActionLog

Sets an extended BaseAppLog to accompany this ActionLog

ActionLog::SetDetails() — Method in class ActionLog

Sets the log's app-specific "details" field

ActionLog::Save() — Method in class ActionLog

Collects fields that have changed and saves them to the database

BaseAppLog::SaveDetails() — Method in class BaseAppLog

Send the cached details log to the action log

BaseAppLog::Save() — Method in class BaseAppLog

Collects fields that have changed and saves them to the database

RequestLog::SetError() — Method in class RequestLog

Sets the given exception as the request result

RequestLog::Save() — Method in class RequestLog

Saves this request log, either to DB or file (or both) {@inheritDoc}

RequestMetrics::Save() — Method in class RequestMetrics

Saves this metrics log, either to DB or file (or both) {@inheritDoc}

$ Main#stack — Property in class Main

RunContext::SetMetrics() — Method in class RunContext

Singleton — Class in namespace Andromeda\Core

Abstract class implementing a singleton

StaticWrapper — Class in namespace Andromeda\Core

A class for overriding static methods for unit testing

Utilities::ShortClassName() — Method in class Utilities

Returns a class name with the namespace stripped

T

Account::TryLoadByUsername() — Method in class Account

Attempts to load an account with the given username

Account::TryLoadByContactInfo() — Method in class Account

Attempts to load an account with the given contact info

AccountsApp::TestAuthSource() — Method in class AccountsApp

Tests an auth source by running an auth query on it

AuthAccessLog::TryGetAccount() — Method in class AuthAccessLog

AuthAccessLog::TryGetSudouser() — Method in class AuthAccessLog

AuthAccessLog::TryGetClient() — Method in class AuthAccessLog

AuthObject::TryLoadByAccountAndID() — Method in class AuthObject

Attemps to load the object with the given account and ID

Authenticator::TryGetAccount() — Method in class Authenticator

Returns the authenticated user account (or null)

Authenticator::TryGetRealAccount() — Method in class Authenticator

Returns the actual account used for the request, not the masqueraded one (or null)

Authenticator::TryGetSession() — Method in class Authenticator

Returns the session used for the request (or null)

Authenticator::TryGetClient() — Method in class Authenticator

Returns the client used for the request or null

Authenticator::TryAuthenticate() — Method in class Authenticator

The primary authentication routine

Authenticator::TryRequireTwoFactor() — Method in class Authenticator

Requires that the user posts a twofactor code, if the account uses twofactor

Authenticator::TryRequireCrypto() — Method in class Authenticator

Same as RequireCrypto() but does nothing if the account does not have crypto

Contact::TryLoadAccountFromContact() — Method in class Contact

Attemps to load a from contact for the given account

Contact::TryLoadByInfoPair() — Method in class Contact

Returns the contact object matching the given value and type, or null

Contact::TryLoadByAccountAndID() — Method in class Contact

Attempts to load a contact by the given ID for the given account

$ ContactInfo#type — Property in class ContactInfo

FieldCrypt::TryGetEncryptedScalar() — Method in class FieldCrypt

Decrypts and returns the value of the given field

FullAuthKey::TryLoadByFullKey() — Method in class FullAuthKey

Tries to load an AuthObject by the full serialized key - DOES NOT CheckFullKey()!

Group::TryLoadByName() — Method in class Group

Tries to load a group by name, returning null if not found

GroupInherit::TryGetScalar() — Method in class GroupInherit

GroupInherit::TryGetObject() — Method in class GroupInherit

GroupInherit::TryGetInheritsScalarFrom() — Method in class GroupInherit

Returns the object that the value of the given field is inherited from

GroupInherit::TryGetInheritsObjectFrom() — Method in class GroupInherit

Returns the object that the value of the given field is inherited from

GroupInherit::TryGetInheritable() — Method in class GroupInherit

Returns an inherited property value and source pair

TwoFactor — Class in namespace Andromeda\Apps\Accounts

Describes an OTP twofactor authentication source for an account

TwoFactor::TryLoadByAccountAndID() — Method in class TwoFactor

Tries to load a two factor object by the given account and ID

TwoFactorRequiredException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that a two factor code was required but not given

CoreApp::TestMail() — Method in class CoreApp

Sends a test email via a given mailer

Comment::TryLoadByAccountAndID() — Method in class Comment

Tries to load a comment object by the given account and comment ID

File::TryGetClientObject() — Method in class File

Returns a printable client object of the file

FilesApp::TryAuthenticateFolderAccess() — Method in class FilesApp

Returns an ItemAccess authenticating the given folder ID (or null to get from input), returns null on failure

FilesApp::TryAuthenticateItemAccess() — Method in class FilesApp

Returns an ItemAccess authenticating the given item class/ID, returns null on failure

FilesApp::TruncateFile() — Method in class FilesApp

Truncates (resizes a file)

FilesApp::TagFile() — Method in class FilesApp

Adds a tag to a file

FilesApp::TagFolder() — Method in class FilesApp

Adds a tag to a folder

FilesApp::TagItem() — Method in class FilesApp

Adds a tag to an item

BaseFileFS::Truncate() — Method in class BaseFileFS

Truncates (changes size of) a file

FSImpl::Truncate() — Method in class FSImpl

Truncates (changes size of) a file

FSManager::TryLoadByAccountAndID() — Method in class FSManager

Attempts to load a filesystem with the given owner and ID - if $null, the owner can be null

FSManager::TryLoadByAccountAndName() — Method in class FSManager

Attempts to load a filesystem with the given owner (or null) and name

NativeCrypt::Truncate() — Method in class NativeCrypt

Truncates (changes size of) a file

Folder::TryGetClientObject() — Method in class Folder

Returns a printable client object of this folder

Item::TryLoadByParentAndName() — Method in class Item

Attemps to load this item by the given info

Item::TryGetClientObject() — Method in class Item

ItemAccess::TryAuthenticate() — Method in class ItemAccess

Same as ItemAccess::Authenticate() but returns null rather than client exceptions

AccountCommon::TryGetInheritsScalarFrom() — Method in class AccountCommon

Timed — Class in namespace Andromeda\Apps\Files\Limits

Stores limits whose statistics are specific to a given time period.

TimedStats — Class in namespace Andromeda\Apps\Files\Limits

Stores an entry of statistics for a Timed limit

TimedStats::TryLoadCurrent() — Method in class TimedStats

Returns the current stats for the given limit, if it exists

TimedStats::TryGetCounterLimit() — Method in class TimedStats

Gets the value of the given counter limit field

Total — Class in namespace Andromeda\Apps\Files\Limits

The basic kind of limit not subject to a timeperiod, also stores config

S3::TryGetAccessKey() — Method in class S3

Returns the S3 access key (or null)

S3::TryGetSecretKey() — Method in class S3

Returns the S3 secret key (or null)

S3::tryS3() — Method in class S3

Runs an S3 client function

SFTP::TryGetPrivkey() — Method in class SFTP

Returns the private key for authentication

SFTP::TryGetKeypass() — Method in class SFTP

Returns the password for the private key

SFTP::TryGetHostKey() — Method in class SFTP

Returns the cached public key for the server host

SMB::TryGetWorkgroup() — Method in class SMB

Returns the SMB workgroup to use (or null)

Storage::Test() — Method in class Storage

Asserts that the underlying storage can be connected and read from/written to

Storage::TestWriteable() — Method in class Storage

Manually tests if the root is writeable by uploading a test file

Storage::Truncate() — Method in class Storage

Truncates the file (changes size)

TestReadFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the tested storage is not readable

TestWriteFailedException — Class in namespace Andromeda\Apps\Files\Storage

Exception indicating that the tested storage is not writeable

UserPass::TryGetUsername() — Method in class UserPass

Returns the decrypted username

UserPass::TryGetPassword() — Method in class UserPass

Returns the decrypted password

Tag — Class in namespace Andromeda\Apps\Files

A category tag placed on an item

CryptoAuth::TryCheckAuthCode() — Method in class CryptoAuth

Tries to authenticate a message using a secret key

BaseObject::TryLoadUniqueByQuery() — Method in class BaseObject

Loads a unique object matching the given query

BaseObject::TryLoadByID() — Method in class BaseObject

Loads a unique object by its ID

BaseObject::TryLoadUniqueByKey() — Method in class BaseObject

Loads a unique object matching the given field

BaseObject::TryDeleteByUniqueKey() — Method in class BaseObject

Deletes a unique object matching the given field

BaseObject::TryLoadUniqueByObject() — Method in class BaseObject

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

BaseObject::TryDeleteByUniqueObject() — Method in class BaseObject

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

BaseObject::toString() — Method in class BaseObject

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

BaseObject::TryGetScalar() — Method in class BaseObject

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

BaseObject::TryGetObject() — Method in class BaseObject

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

BaseObject::TryGetObjectID() — Method in class BaseObject

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

BaseObject::TryGetObjectType() — Method in class BaseObject

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

BaseObject::TryGetJoinObject() — Method in class BaseObject

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

$ Scalar#tempvalue — Property in class Scalar

The possibly-temporary-only value of this field

JoinObject::TryLoadJoin() — Method in class JoinObject

Loads the join object that joins together two objects

JoinObject::TryDeleteJoin() — Method in class JoinObject

Deletes the join object that joins together two objects

ObjectDatabase::TryPreloadObjectByID() — Method in class ObjectDatabase

Attempt to fetch an object from the cache by its ID

ObjectDatabase::TryLoadObjectByUniqueKey() — Method in class ObjectDatabase

Attempt to load a unique object by the value of a field

StandardObject::TryGetDate() — Method in class StandardObject

Returns the timestamp value stored in the given date field

StandardObject::TryGetFeatureInt() — Method in class StandardObject

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

StandardObject::TryGetFeatureBool() — Method in class StandardObject

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

StandardObject::TryGetCounterLimit() — Method in class StandardObject

Gets the value of the given counter limit field

EmailRecipient::ToString() — Method in class EmailRecipient

IOInterface::TryGet() — Method in class IOInterface

Constructs and returns a singleton of the appropriate interface type

Input::TryGetFile() — Method in class Input

Same as GetFile() but returns null rather than throwing an exception

ActionLog::TryGetApplog() — Method in class ActionLog

$ Main#total_stats — Property in class Main

$ Main#time — Property in class Main

Main::TryGetConfig() — Method in class Main

Returns the global config object or null if not installed

Main::TryLoadApp() — Method in class Main

Loads the main include file for an app and constructs it

Transactions — Class in namespace Andromeda\Core

Simple interface with rollback() and commit()

U

Account::UnlockCryptoFromPassword() — Method in class Account

Attempts to unlock crypto using the given password

Account::UnlockCryptoFromKeySource() — Method in class Account

Attempts to unlock crypto using the given unlocked key source

Account::UnlockCryptoFromRecoveryKey() — Method in class Account

Attempts to unlock crypto using a full recovery key

UnknownAccountException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an unknown account was given

UnknownAuthSourceException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an unknown authentication source was given

UnknownClientException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an unknown client was given

UnknownContactException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an unknown contact was given

UnknownGroupException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an unknown group was given

UnknownGroupMembershipException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that the group membership does not exist

UnknownSessionException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an unknown session was given

UnknownTwoFactorException — Class in namespace Andromeda\Apps\Accounts

Exception indicating that an unknown twofactor was given

UsedToken — Class in namespace Andromeda\Apps\Accounts

Object for tracking used two factor codes, to prevent replay attacks

CoreApp::Upgrade() — Method in class CoreApp

Iterates over the list of upgrade scripts, running them sequentially until the DB is up to date with the code

UnknownMailerException — Class in namespace Andromeda\Apps\Core

Exception indicating that the specified mailer object does not exist

FilesApp::UnknownItemException() — Method in class FilesApp

Throws an unknown file/folder exception if given, else item exception

FilesApp::UploadFile() — Method in class FilesApp

Uploads a new file to the given folder. Bandwidth is counted.

Local::usesBandwidth() — Method in class Local

By default, most storages use network bandwidth

Storage::usesBandwidth() — Method in class Storage

By default, most storages use network bandwidth

UserPass — Class in namespace Andromeda\Apps\Files\Storage

Trait for storage classes that store a possibly-encrypted username and password

UnknownDestinationException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested destination folder does not exist

UnknownFileException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested file does not exist

UnknownFilesystemException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested filesystem does not exist

UnknownFolderException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested folder does not exist

UnknownItemException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested item does not exist

UnknownObjectException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested object does not exist

UnknownParentException — Class in namespace Andromeda\Apps\Files

Exception indicating that the requested parent does not exist

UserStorageDisabledException — Class in namespace Andromeda\Apps\Files

Exception indicating that user-added filesystems are not allowed

Database::UsePublicSchema() — Method in class Database

Whether or not the DB expects using public. as a prefix for table names

ObjectDatabase::UnsetObject() — Method in class ObjectDatabase

IOInterface::UserOutput() — Method in class IOInterface

Tells the interface to run the custom user output functions

$ InputAuth#username — Property in class InputAuth

AJAX::UserOutput() — Method in class AJAX

Tells the interface to run the custom user output functions

UnknownBatchFileException — Class in namespace Andromeda\Core\IOFormat\Interfaces

Exception indicating that the given batch file is not valid

InstalledApp::Upgrade() — Method in class InstalledApp

Iterates over the list of upgrade scripts, running them sequentially until the DB is up to date with the code

UnknownActionException — Class in namespace Andromeda\Core

An exception indicating that the requested action is invalid for this app

UnknownAppException — Class in namespace Andromeda\Core

Exception indicating that the requested app is invalid

UnwriteableDatadirException — Class in namespace Andromeda\Core

Exception indicating that the configured data directory is not valid

UpgradeRequiredException — Class in namespace Andromeda\Core

Exception indicating that the database upgrade scripts must be run

Utilities — Class in namespace Andromeda\Core

Abstract with some global static utility functions

V

Account::VerifyPassword() — Method in class Account

Returns true if the given password is correct for this account

AccountsApp::VerifyTwoFactor() — Method in class AccountsApp

Verifies a two factor source

AccountsApp::VerifyContact() — Method in class AccountsApp

Verifies an account contact

External::VerifyAccountPassword() — Method in class External

Verify the password given

External::VerifyUsernamePassword() — Method in class External

FTP::VerifyUsernamePassword() — Method in class FTP

IMAP::VerifyUsernamePassword() — Method in class IMAP

ISource::VerifyAccountPassword() — Method in class ISource

Verify the password given

LDAP::VerifyUsernamePassword() — Method in class LDAP

Local::VerifyAccountPassword() — Method in class Local

Verify the password given

$ InheritedProperty#value — Property in class InheritedProperty

$ SafeParam#value — Property in class SafeParam

VersionInfo — Class in namespace Andromeda\Core

Class for parsing a version string into components

$ VersionInfo#version — Property in class VersionInfo

W

Whitelist — Class in namespace Andromeda\Apps\Accounts

Whitelist entry for allowing account signups

File::WriteBytes() — Method in class File

Writes content to the file

FileUtils::WriteStream() — Method in class FileUtils

Writes data to the given stream

FilesApp::WriteToFile() — Method in class FilesApp

Writes new data to an existing file - data is posted as a file

BaseFileFS::WriteBytes() — Method in class BaseFileFS

Writes to the given file, possibly appending it

FSImpl::WriteBytes() — Method in class FSImpl

Writes to the given file, possibly appending it

NativeCrypt::WriteBytes() — Method in class NativeCrypt

Writes to the given file, possibly appending it

NativeCrypt::WriteChunk() — Method in class NativeCrypt

Encrypts and writes the given data to the given chunk

Storage::WriteBytes() — Method in class Storage

Writes data to a file

$ DBStats#writes — Property in class DBStats

$ DBStats#write_time — Property in class DBStats

$ QueryBuilder#where — Property in class QueryBuilder

QueryBuilder::Where() — Method in class QueryBuilder

Assigns a WHERE clause to the query

IOInterface::WriteOutput() — Method in class IOInterface

Tells the interface to print its final output

AJAX::WriteOutput() — Method in class AJAX

Tells the interface to print its final output

CLI::WriteOutput() — Method in class CLI

Tells the interface to print its final output

_

Account::__destruct() — Method in class Account

AccountsApp::__construct() — Method in class AccountsApp

All apps are constructed when Andromeda runs

Authenticator::__construct() — Method in class Authenticator

ContactInfo::__construct() — Method in class ContactInfo

InheritedProperty::__construct() — Method in class InheritedProperty

FSImpl::__construct() — Method in class FSImpl

NativeCrypt::__construct() — Method in class NativeCrypt

ItemAccess::__construct() — Method in class ItemAccess

AccountTotalDefault::__construct() — Method in class AccountTotalDefault

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

FileContext::__construct() — Method in class FileContext

ItemStat::__construct() — Method in class ItemStat

PathRollback::__construct() — Method in class PathRollback

BaseApp::__construct() — Method in class BaseApp

All apps are constructed when Andromeda runs

BaseObject::__toString() — Method in class BaseObject

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

BaseObject::__construct() — Method in class BaseObject

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

CounterOverLimitException::__construct() — Method in class CounterOverLimitException

DBStats::__construct() — Method in class DBStats

Constructs a new stats context and logs the current time

Database::__construct() — Method in class Database

Constructs the database and initializes the PDO connection

Counter::__construct() — Method in class Counter

Constructs a new counter with a default value of zero

ObjectJoin::__construct() — Method in class ObjectJoin

Construct a new object join field

ObjectPoly::__construct() — Method in class ObjectPoly

Creates a new object reference field

ObjectRef::__construct() — Method in class ObjectRef

Creates a new object reference field

ObjectRefs::__construct() — Method in class ObjectRefs

Creates a new object reference array field

Scalar::__construct() — Method in class Scalar

Declares a new scalar fieldtype (use this in object templates)

QueryBuilder::__toString() — Method in class QueryBuilder

EmailRecipient::__construct() — Method in class EmailRecipient

BaseException::__construct() — Method in class BaseException

Copyable::__construct() — Method in class Copyable

ErrorManager::__construct() — Method in class ErrorManager

Registers PHP error and exception handlers

ErrorManager::__destruct() — Method in class ErrorManager

PHPError::__construct() — Method in class PHPError

IOInterface::__construct() — Method in class IOInterface

Construct the singleton for use.

Input::__construct() — Method in class Input

Constructs an input object using the data gathered from the interface, and sanitizes the app/action strings

InputAuth::__construct() — Method in class InputAuth

InputFileMissingException::__construct() — Method in class InputFileMissingException

InputPath::__construct() — Method in class InputPath

InputStream::__construct() — Method in class InputStream

CLI::__construct() — Method in class CLI

Construct the singleton for use.

IncorrectCLIUsageException::__construct() — Method in class IncorrectCLIUsageException

Output::__construct() — Method in class Output

OutputHandler::__construct() — Method in class OutputHandler

SafeParam::__construct() — Method in class SafeParam

Construct a new SafeParam with the given key and value

SafeParamInvalidEnumException::__construct() — Method in class SafeParamInvalidEnumException

SafeParamInvalidException::__construct() — Method in class SafeParamInvalidException

SafeParamKeyMissingException::__construct() — Method in class SafeParamKeyMissingException

SafeParamNullValueException::__construct() — Method in class SafeParamNullValueException

InstalledApp::__construct() — Method in class InstalledApp

All apps are constructed when Andromeda runs

JSONException::__construct() — Method in class JSONException

Main::__construct() — Method in class Main

Initializes the Main API

RunContext::__construct() — Method in class RunContext

Singleton::__construct() — Method in class Singleton

Construct the singleton for use.

StaticWrapper::__construct() — Method in class StaticWrapper

StaticWrapper::_override() — Method in class StaticWrapper

Overrides a static function on the class

StaticWrapper::__call() — Method in class StaticWrapper

VersionInfo::__construct() — Method in class VersionInfo

VersionInfo::__toString() — Method in class VersionInfo