File

bool

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

Sets a field to reference the given object

from BaseObject

BaseObject

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

Same as BoolSetObject() but returns $this

from BaseObject

bool

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

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

bool

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

Removes the given object from a collection of referenced objects

from BaseObject

__construct(ObjectDatabase $database, array $data)

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

from BaseObject

AddField(string $key, Scalar $field)

Adds the given field object to the correct internal array

from BaseObject

void

SubConstruct()

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

from BaseObject

BaseObject

Save(bool $onlyMandatory = false)

Collects fields that have changed and saves them to the database

from BaseObject

bool

isDeleted()

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

from BaseObject

void

NotifyDBDeleted()

Deletes this object without sending to the DB

from BaseObject

void

Delete()

Deletes the file from both the DB and disk

void

DeleteLater()

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

from BaseObject

bool

isCreated()

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

from BaseObject

static BaseObject

BaseCreate(ObjectDatabase $database)

Create the object by setting its created date

float

GetDate(string $name)

Returns the timestamp value stored in the given date field

float|null

TryGetDate(string $name)

Returns the timestamp value stored in the given date field

StandardObject

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

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

float

GetDateCreated()

Returns the timestamp when this object was created

int

GetFeatureInt(string $name, bool $allowTemp = true)

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

int|null

TryGetFeatureInt(string $name, bool $allowTemp = true)

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

bool

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

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

bool|null

TryGetFeatureBool(string $name, bool $allowTemp = true)

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

StandardObject

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

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

StandardObject

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

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

bool

isFeatureModified(string $name)

Returns true if the given feature has been modified

int

GetCounter(string $name)

Gets the value of the given counter field

int

GetCounterLimit(string $name)

Gets the value of the given counter limit field

int|null

TryGetCounterLimit(string $name)

Gets the value of the given counter limit field

StandardObject

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

Sets the value of the given counter limit field

bool

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

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

array

GetAllScalars(string|null $prefix)

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

Item

Refresh()

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

Account|null

GetOwner()

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

from Item

string|null

GetOwnerID()

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

from Item

string|null

GetName()

Returns the name of this file

int

GetSize()

Returns the size of the file, in bytes

Folder|null

GetParent()

Returns the parent folder of this file

string|null

GetParentID()

Returns the ID of the parent folder

Item

SetName(string $name, bool $overwrite = false)

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

Item

SetParent(Folder $parent, bool $overwrite = false)

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

string|null

GetDescription()

Returns this item's description

from Item

Item

SetDescription(string|null $val)

Sets this item's description to the given value

from Item

Item

CopyToName(Account|null $owner, string $name, bool $overwrite = false)

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

Item

CopyToParent(Account|null $owner, Folder $parent, bool $overwrite = false)

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

Item|null

CheckName(string $name, bool $overwrite, bool $reuse)

Asserts that this item can be moved to the given name

from Item

Item|null

CheckParent(Folder $parent, bool $overwrite, bool $reuse)

Asserts that this item can be moved to the given parent

from Item

Item

SetOwner(Account $account)

Sets this item's owner to the given account

from Item

static Item

NotifyCreate(ObjectDatabase $database, Folder $parent, Account|null $account, string $name)

No description

FSManager

GetFilesystem()

Returns the filesystem manager that stores this object

from Item

string

GetFilesystemID()

Returns the ID of the object's filesystem manager

from Item

FSImpl

GetFSImpl(bool $requireExist = true)

Returns the filesystem manager's implementor that stores this object

from Item

bool

isWorldAccess()

Returns true if this file should be accessible by all accounts

from Item

Item

SetAccessed(float|null $time = null)

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

from Item

Item

SetCreated(float|null $time = null)

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

from Item

Item

SetModified(float|null $time = null)

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

from Item

int

GetBandwidth()

Returns the bandwidth used by the item in bytes

from Item

int

GetPublicDownloads()

Returns the public download count of the item

from Item

array

GetLikes(int|null $limit = null, int|null $offset = null)

Returns the like objects for this item

from Item

array

GetComments(int|null $limit = null, int|null $offset = null)

Returns the comment objects for this item

from Item

array

GetTags()

Returns the tag objects for this item

from Item

array

GetShares()

Returns the share objects for this item

from Item

int

GetNumShares()

Returns the number of share objects belonging to the file

Item

CountCreate()

Registers a new item with all limit objects

from Item

Item

CountPublicDownload()

Counts a public download on the item and its parents

from Item

Item

CountBandwidth(int $bytes)

Counts bandwidth by updating the count and notifying parents

Item

CountLike(bool $value, bool $count = true)

Increments the item's like counter

from Item

Item

CountShare(bool $count = true)

Increments the item's share counter

from Item

Item

MapToLimits(callable $func)

Maps the given function to all applicable limit objects

from Item

Item

MapToTotalLimits(callable $func)

Maps the given function to all applicable total limit objects

from Item

Item

MapToTimedLimits(callable $func)

Maps the given function to all applicable timed limit objects

from Item

Item

AddStatsToOwner(bool $add = true)

Adds this item's stats to all owner limits

from Item

Item

AddStatsToFilesystem(bool $add = true)

Adds this item's stats to all filesystem limits

from Item

void

AddStatsToLimit(Base $limit, bool $add = true)

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

bool

GetLimitsBool(callable $func, Account|null $account)

Returns a config bool for the item by checking applicable limits

from Item

bool

GetAllowPublicModify()

Returns true if the item should allow public modifications

from Item

bool

GetAllowPublicUpload()

Returns true if the item should allow public uploading

from Item

bool

GetAllowRandomWrite(Account $account)

Returns true if the item should allow random/partial writes

from Item

bool

GetAllowItemSharing(Account $account)

Returns true if the item should allow sharing

from Item

bool

GetAllowShareToGroups(Account $account)

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

from Item

bool

GetAllowShareToEveryone(Account $account)

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

from Item

void

NotifyFSDeleted()

Deletes the file from the DB only

static Item|null

TryLoadByParentAndName(ObjectDatabase $database, Folder $parent, string $name)

Attemps to load this item by the given info

from Item

static array

LoadByOwner(ObjectDatabase $database, Account $account)

Returns an array of all items belonging to the given owner

from Item

static array

LoadAdoptedByOwner(ObjectDatabase $database, Account $account)

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

array|null

SubGetClientObject(bool $owner = false, bool $details = false)

Returns a printable client object of this item

from Item

array

GetClientObject(bool $owner = false, bool $details = false)

No description

array|null

TryGetClientObject(bool $owner = false, bool $details = false)

Returns a printable client object of the file

File

SetSize(int $size, bool $notify = false)

Sets the size of the file and update stats

File

CheckSize(int $size)

Checks if the given total size would exceed the limit

File

CountDownload(bool $public = true)

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

File

CheckBandwidth(int $bytes)

Checks if the given bandwidth would exceed the limit

static File

BasicCreate(ObjectDatabase $database, Folder $parent, Account|null $account, string $name, bool $overwrite = false)

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

static File

Create(ObjectDatabase $database, Folder $parent, Account|null $account, string $name, bool $overwrite = false)

Creates a new empty file on disk and in the DB

static File

Import(ObjectDatabase $database, Folder $parent, Account|null $account, InputPath $infile, bool $overwrite = false)

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

File

SetContents(InputPath $infile)

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

int|null

GetChunkSize()

Gets the preferred chunk size by the filesystem holding this file

bool

onOwnerFS()

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

string

ReadBytes(int $start, int $length)

Reads content from the file

File

WriteBytes(int $start, string $data)

Writes content to the file

Details

at line 23
`static array GetFieldTemplate()`

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

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

Return Value

array

array of FieldTypes indexed by field names

in BaseObject at line 52
`static string GetDBClass()`

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

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

Return Value

string

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

No description

Parameters

array

$row

Return Value

string

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

Counts objects in the DB matching the given query

Parameters

ObjectDatabase	$database	Reference to the database
QueryBuilder	$query	The query to use for matching objects

Return Value

int	count of matched objects

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

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

Parameters

ObjectDatabase	$database	Reference to the database
QueryBuilder	$query	The query to use for matching objects

Return Value

array

array of objects indexed by their IDs

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

Deletes objects from the DB matching the given query

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

Parameters

ObjectDatabase	$database	Reference to the database
QueryBuilder	$query	The query to use for matching objects

Return Value

int	number of objects deleted

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

Loads a unique object matching the given query

Parameters

ObjectDatabase	$database	Reference to the database
QueryBuilder	$query	the query to uniquely identify the object

Return Value

BaseObject|null

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

Asserts that the given object is not null

Parameters

BaseObject|null

$obj

the object to check for null

Return Value

object if not null

Exceptions

ObjectNotFoundException

if the object is null

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

Loads a unique object by its ID

Parameters

ObjectDatabase	$database	Reference to the database
string	$id	the ID of the object

Return Value

BaseObject|null

object or null if not found

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

Deletes a unique object by its ID

Parameters

ObjectDatabase	$database	Reference to the database
string	$id	the ID of the object

Return Value

void

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

Loads all objects of this type from the database

Parameters

ObjectDatabase	$database	Reference to the database
int\|null	$limit	the maximum number of objects to load
int\|null	$offset	the number of objects to skip loading

Return Value

array

array of objects indexed by their IDs

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

Deletes all objects of this type from the database

Parameters

ObjectDatabase

$database

Reference to the database

Return Value

int	number of deleted objects

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

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

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

Parameters

ObjectDatabase	$database	Reference to the database
string	$field	The name of the field to check
string	$id	The ID of the object referenced
string\|null	$class	optionally, the class to match if this column is polymorphic

Return Value

array

array of objects indexed by their IDs

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

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

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

Parameters

ObjectDatabase	$database	Reference to the database
string	$field	The name of the field to check
string	$id	The ID of the object referenced
string\|null	$class	optionally, the class to match if this column is polymorphic

Return Value

int	number of rows deleted

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

Loads a unique object matching the given field

Parameters

ObjectDatabase	$database	Reference to the database
string	$field	the name of the field to check
string	$key	the value of the field that uniquely identifies the object

Return Value

BaseObject|null

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

Deletes a unique object matching the given field

Parameters

ObjectDatabase	$database	Reference to the database
string	$field	the name of the field to check
string	$key	the value of the field that uniquely identifies the object

Return Value

bool	true if an object was deleted

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

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

Parameters

ObjectDatabase	$database	Reference to the database
string	$field	The name of the field to check
BaseObject	$object	the object referenced by the field
bool	$isPoly	whether or not this field is polymorphic

Return Value

array

array of objects indexed by their IDs

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

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

Parameters

ObjectDatabase	$database	Reference to the database
string	$field	The name of the field to check
BaseObject	$object	the object referenced by the field
bool	$isPoly	whether or not this field is polymorphic

Return Value

int	number of deleted objects

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

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

Parameters

ObjectDatabase	$database	Reference to the database
string	$field	The name of the field to check
BaseObject	$object	the object referenced by the field
bool	$isPoly	whether or not this field is polymorphic

Return Value

BaseObject|null

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

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

Parameters

ObjectDatabase	$database	Reference to the database
string	$field	The name of the field to check
BaseObject	$object	the object referenced by the field
bool	$isPoly	whether or not this field is polymorphic

Return Value

bool	true if an object was deleted

in BaseObject at line 284
`string ID()`

Returns the unique ID of the object

Return Value

string

in BaseObject at line 287
`string __toString()`

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

Return Value

string

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

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

Parameters

BaseObject|null

$obj

Return Value

string|null

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

Gets a scalar field

Parameters

string	$field	the field name of the scalar
bool	$allowTemp	whether to allow returning a value that was set as temporary

Return Value

mixed

any non-null scalar value

Exceptions

KeyNotFoundException	if the field name is invalid
NullValueException	if the field value is null

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

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

Parameters

string	$field
bool	$allowTemp

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

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

Parameters

string

$field

the field name of the scalar

Return Value

int	of times modified for scalars, delta for counters

Exceptions

if the field name is invalid

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

Gets a single object reference

Parameters

string

$field

the field name holding the reference

Return Value

any object value

Exceptions

KeyNotFoundException	if the field name is invalid
NullValueException	if the field value is null

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

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

Parameters

string

$field

Return Value

BaseObject|null

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

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

Parameters

string

$field

the field name holding the reference

Return Value

bool	true if the object reference is not null

Exceptions

if the field name is invalid

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

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

Parameters

string

$field

the field name holding the reference

Return Value

string

the ID of the referenced object

Exceptions

KeyNotFoundException	if the field name is invalid
NullValueException	if the field value is null

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

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

Parameters

string

$field

Return Value

string|null

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

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

Parameters

string

$field

the field name holding the reference

Return Value

string

the class name of the referenced object

Exceptions

if the field name is invalid

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

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

Parameters

string

$field

the field name holding the reference

Return Value

string|null

the class name of the referenced object

Exceptions

if the field name is invalid

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

Deletes the object referenced in the field

Parameters

string

$field

the field name holding the reference

Return Value

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

Gets an array of objects that reference this object

Parameters

string	$field	the field name of the collection
int\|null	$limit	the maximum number of objects to load
int\|null	$offset	the number of objects to skip loading

Return Value

array

array of objects indexed by their IDs

Exceptions

if the field name is invalid

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

Gets the counter of objects referencing this object

Parameters

string

$field

the field name of the collection

Return Value

int	the number of objects

Exceptions

if the field name is invalid

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

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

Parameters

string	$field	the field name using the join reference
BaseObject	$obj	the object that is joined together with this one

Return Value

StandardObject

the join object that connects us to $obj

Exceptions

KeyNotFoundException	if the field name is invalid
NullValueException	if the given object is not joined to us

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

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

Parameters

string	$field
BaseObject	$obj

if the property name is invalid

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

Increment a counter by the given value

Parameters

string	$name	the name of the counter field to increment
int	$delta	the value to increment by
bool	$ignoreLimit	if true, ignore the counter's limit

Return Value

CounterOverLimitException

Exceptions

if the counter's limit exists and is exceeded

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

Sets a field to reference the given object

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

Parameters

string	$field	the name of the reference field
BaseObject\|null	$object	the object for the field to reference
bool	$notification	true if this is a notification from another object that cross-references this one (internal only!)

Return Value

bool	true if this object was modified

Exceptions

if the property name is invalid

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

Same as BoolSetObject() but returns $this

Parameters

string	$field
BaseObject\|null	$object
bool	$notification

Return Value

CounterOverLimitException

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

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

Parameters

string	$field	the name of the field of the collection
BaseObject	$object	the object to add to the collection
bool	$notification	true if this is a notification from another object that cross-references this one (internal only!)

Return Value

bool	true if this object was modified

Exceptions

if the limit exists and is exceeded

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

Removes the given object from a collection of referenced objects

Parameters

string	$field	the name of the field of the collection
BaseObject	$object	the object to add to the collection
bool	$notification	true if this is a notification from another object that cross-references this one (internal only!)

Return Value

bool	true if this object was modified

Exceptions

if the property name is invalid

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

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

Parameters

ObjectDatabase	$database	Reference to the database
array	$data	array of columns from the DB in the form of name=>value

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

Adds the given field object to the correct internal array

Parameters

string	$key
Scalar	$field

in BaseObject at line 763
`protected void SubConstruct()`

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

Return Value

void

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

Collects fields that have changed and saves them to the database

Parameters

bool

Return Value