abstract class Item extends StandardObject

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

Like other objects, items are generally referred to by ID, not name path. It is therefore somewhat like an object storage, except that every item must have exactly one parent (other than the root folder).

Constants

IDLength

Properties

protected $database

The object's primary reference to the database

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

whether or not this object has been modified

from  BaseObject
private $deleted

whether or not this object has been deleted

from  BaseObject
private $dbDeleted

whether or not this object has been deleted by DB

from  BaseObject
private $deleteLater from  BaseObject
private $created

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

from  BaseObject

Methods

static array
GetFieldTemplate()

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

static string
GetDBClass()

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

static string
GetObjClass(array $row)

No description

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

Counts objects in the DB matching the given query

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

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

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

Deletes objects from the DB matching the given query

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

Loads a unique object matching the given query

static BaseObject
NotNull(BaseObject|null $obj)

Asserts that the given object is not null

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

Loads a unique object by its ID

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

Deletes a unique object by its ID

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

Loads all objects of this type from the database

static int
DeleteAll(ObjectDatabase $database)

Deletes all objects of this type from the database

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

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

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

Loads a unique object matching the given field

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

Deletes a unique object matching the given field

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

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

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

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

string
ID()

Returns the unique ID of the object

string
__toString()

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

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

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

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

Gets a scalar field

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

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

int
GetScalarDelta(string $field)

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

GetObject(string $field)

Gets a single object reference

BaseObject|null
TryGetObject(string $field)

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

bool
HasObject(string $field)

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

string
GetObjectID(string $field)

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

string|null
TryGetObjectID(string $field)

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

string
GetObjectType(string $field)

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

string|null
TryGetObjectType(string $field)

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

DeleteObject(string $field)

Deletes the object referenced in the field

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

Gets an array of objects that reference this object

int
CountObjectRefs(string $field)

Gets the counter of objects referencing this object

GetJoinObject(string $field, BaseObject $obj)

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

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

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

DeleteObjects(string $field)

Deletes all objects that reference this object

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

Sets a scalar field to the given value

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

Increment a counter by the given value

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

Sets a field to reference the given object

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

Same as BoolSetObject() but returns $this

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

__construct(ObjectDatabase $database, array $data)

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

AddField(string $key, Scalar $field)

Adds the given field object to the correct internal array

void
SubConstruct()

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

Save(bool $onlyMandatory = false)

Collects fields that have changed and saves them to the database

bool
isDeleted()

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

void
NotifyDBDeleted()

Deletes this object without sending to the DB

void
Delete()

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

void
DeleteLater()

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

bool
isCreated()

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

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

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)

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

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

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

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

Refresh()

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

Account|null
GetOwner()

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

string|null
GetOwnerID()

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

string|null
GetName()

Returns the name of this item

int
GetSize()

Returns the size of this item in bytes

Folder|null
GetParent()

Returns the parent folder of this item

string|null
GetParentID()

Returns the parent ID of this item

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

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

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

SetDescription(string|null $val)

Sets this item's description to the given value

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.

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

Item|null
CheckParent(Folder $parent, bool $overwrite, bool $reuse)

Asserts that this item can be moved to the given parent

SetOwner(Account $account)

Sets this item's owner to the given account

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

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

GetFilesystem()

Returns the filesystem manager that stores this object

string
GetFilesystemID()

Returns the ID of the object's filesystem manager

GetFSImpl(bool $requireExist = true)

Returns the filesystem manager's implementor that stores this object

bool
isWorldAccess()

Returns true if this file should be accessible by all accounts

SetAccessed(float|null $time = null)

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

SetCreated(float|null $time = null)

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

SetModified(float|null $time = null)

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

int
GetBandwidth()

Returns the bandwidth used by the item in bytes

int
GetPublicDownloads()

Returns the public download count of the item

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

Returns the like objects for this item

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

Returns the comment objects for this item

array
GetTags()

Returns the tag objects for this item

array
GetShares()

Returns the share objects for this item

int
GetNumShares()

Returns the number of shares on this object

CountCreate()

Registers a new item with all limit objects

CountPublicDownload()

Counts a public download on the item and its parents

CountBandwidth(int $bytes)

Counts the given bandwidth on the item and its parents

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

Increments the item's like counter

CountShare(bool $count = true)

Increments the item's share counter

MapToLimits(callable $func)

Maps the given function to all applicable limit objects

MapToTotalLimits(callable $func)

Maps the given function to all applicable total limit objects

MapToTimedLimits(callable $func)

Maps the given function to all applicable timed limit objects

AddStatsToOwner(bool $add = true)

Adds this item's stats to all owner limits

AddStatsToFilesystem(bool $add = true)

Adds this item's stats to all filesystem limits

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

bool
GetAllowPublicModify()

Returns true if the item should allow public modifications

bool
GetAllowPublicUpload()

Returns true if the item should allow public uploading

bool
GetAllowRandomWrite(Account $account)

Returns true if the item should allow random/partial writes

bool
GetAllowItemSharing(Account $account)

Returns true if the item should allow sharing

bool
GetAllowShareToGroups(Account $account)

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

bool
GetAllowShareToEveryone(Account $account)

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

void
NotifyFSDeleted()

Deletes the item from the DB only

static Item|null
TryLoadByParentAndName(ObjectDatabase $database, Folder $parent, string $name)

Attemps to load this item by the given info

static array
LoadByOwner(ObjectDatabase $database, Account $account)

Returns an array of all items belonging to the given owner

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

array
GetClientObject(bool $owner = false, bool $full = false)

No description

array|null
TryGetClientObject(bool $owner = false, bool $full = false)

No description

Details

at line 38
static array GetFieldTemplate()

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

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

Return Value

array

array of FieldTypes indexed by field names

in BaseObject at line 52
static string GetDBClass()

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

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

Return Value

string

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

No description

Parameters

array $row

Return Value

string

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

Counts objects in the DB matching the given query

Parameters

ObjectDatabase $database

Reference to the database

QueryBuilder $query

The query to use for matching objects

Return Value

int

count of matched objects

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

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

Parameters

ObjectDatabase $database

Reference to the database

QueryBuilder $query

The query to use for matching objects

Return Value

array

array of objects indexed by their IDs

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

Deletes objects from the DB matching the given query

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

Parameters

ObjectDatabase $database

Reference to the database

QueryBuilder $query

The query to use for matching objects

Return Value

int

number of objects deleted

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

Loads a unique object matching the given query

Parameters

ObjectDatabase $database

Reference to the database

QueryBuilder $query

the query to uniquely identify the object

Return Value

BaseObject|null

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

Asserts that the given object is not null

Parameters

BaseObject|null $obj

the object to check for null

Return Value

BaseObject

object if not null

Exceptions

ObjectNotFoundException

if the object is null

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

Loads a unique object by its ID

Parameters

ObjectDatabase $database

Reference to the database

string $id

the ID of the object

Return Value

BaseObject|null

object or null if not found

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

Deletes a unique object by its ID

Parameters

ObjectDatabase $database

Reference to the database

string $id

the ID of the object

Return Value

void

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

Loads all objects of this type from the database

Parameters

ObjectDatabase $database

Reference to the database

int|null $limit

the maximum number of objects to load

int|null $offset

the number of objects to skip loading

Return Value

array

array of objects indexed by their IDs

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

Deletes all objects of this type from the database

Parameters

ObjectDatabase $database

Reference to the database

Return Value

int

number of deleted objects

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

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

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

Parameters

ObjectDatabase $database

Reference to the database

string $field

The name of the field to check

string $id

The ID of the object referenced

string|null $class

optionally, the class to match if this column is polymorphic

Return Value

array

array of objects indexed by their IDs

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

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

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

Parameters

ObjectDatabase $database

Reference to the database

string $field

The name of the field to check

string $id

The ID of the object referenced

string|null $class

optionally, the class to match if this column is polymorphic

Return Value

int

number of rows deleted

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

Loads a unique object matching the given field

Parameters

ObjectDatabase $database

Reference to the database

string $field

the name of the field to check

string $key

the value of the field that uniquely identifies the object

Return Value

BaseObject|null

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

Deletes a unique object matching the given field

Parameters

ObjectDatabase $database

Reference to the database

string $field

the name of the field to check

string $key

the value of the field that uniquely identifies the object

Return Value

bool

true if an object was deleted

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

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

Parameters

ObjectDatabase $database

Reference to the database

string $field

The name of the field to check

BaseObject $object

the object referenced by the field

bool $isPoly

whether or not this field is polymorphic

Return Value

array

array of objects indexed by their IDs

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

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

Parameters

ObjectDatabase $database

Reference to the database

string $field

The name of the field to check

BaseObject $object

the object referenced by the field

bool $isPoly

whether or not this field is polymorphic

Return Value

int

number of deleted objects

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

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

Parameters

ObjectDatabase $database

Reference to the database

string $field

The name of the field to check

BaseObject $object

the object referenced by the field

bool $isPoly

whether or not this field is polymorphic

Return Value

BaseObject|null

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

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

Parameters

ObjectDatabase $database

Reference to the database

string $field

The name of the field to check

BaseObject $object

the object referenced by the field

bool $isPoly

whether or not this field is polymorphic

Return Value

bool

true if an object was deleted

in BaseObject at line 284
string ID()

Returns the unique ID of the object

Return Value

string

in BaseObject at line 287
string __toString()

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

Return Value

string

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

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

Parameters

BaseObject|null $obj

Return Value

string|null

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

Gets a scalar field

Parameters

string $field

the field name of the scalar

bool $allowTemp

whether to allow returning a value that was set as temporary

Return Value

mixed

any non-null scalar value

Exceptions

KeyNotFoundException

if the field name is invalid

NullValueException

if the field value is null

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

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

Parameters

string $field
bool $allowTemp

See also

BaseObject::GetScalar

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

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

Parameters

string $field

the field name of the scalar

Return Value

int

of times modified for scalars, delta for counters

Exceptions

KeyNotFoundException

if the field name is invalid

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

Gets a single object reference

Parameters

string $field

the field name holding the reference

Return Value

BaseObject

any object value

Exceptions

KeyNotFoundException

if the field name is invalid

NullValueException

if the field value is null

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

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

Parameters

string $field

Return Value

BaseObject|null

See also

BaseObject::GetObject

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

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

Parameters

string $field

the field name holding the reference

Return Value

bool

true if the object reference is not null

Exceptions

KeyNotFoundException

if the field name is invalid

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

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

Parameters

string $field

the field name holding the reference

Return Value

string

the ID of the referenced object

Exceptions

KeyNotFoundException

if the field name is invalid

NullValueException

if the field value is null

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

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

Parameters

string $field

Return Value

string|null

See also

BaseObject::GetObjectID

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

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

Parameters

string $field

the field name holding the reference

Return Value

string

the class name of the referenced object

Exceptions

KeyNotFoundException

if the field name is invalid

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

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

Parameters

string $field

the field name holding the reference

Return Value

string|null

the class name of the referenced object

Exceptions

KeyNotFoundException

if the field name is invalid

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

Deletes the object referenced in the field

Parameters

string $field

the field name holding the reference

Return Value

BaseObject

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

Gets an array of objects that reference this object

Parameters

string $field

the field name of the collection

int|null $limit

the maximum number of objects to load

int|null $offset

the number of objects to skip loading

Return Value

array

array of objects indexed by their IDs

Exceptions

KeyNotFoundException

if the field name is invalid

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

Gets the counter of objects referencing this object

Parameters

string $field

the field name of the collection

Return Value

int

the number of objects

Exceptions

KeyNotFoundException

if the field name is invalid

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

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

Parameters

string $field

the field name using the join reference

BaseObject $obj

the object that is joined together with this one

Return Value

StandardObject

the join object that connects us to $obj

Exceptions

KeyNotFoundException

if the field name is invalid

NullValueException

if the given object is not joined to us

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

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

Parameters

string $field
BaseObject $obj

Return Value

StandardObject|null

See also

BaseObject::GetJoinObject

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

Deletes all objects that reference this object

Parameters

string $field

the field name of the collection

Return Value

BaseObject

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

Sets a scalar field to the given value

Parameters

string $field

the name of the field

mixed $value

the value of the scalar to set

bool $temp

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

Return Value

BaseObject

Exceptions

KeyNotFoundException

if the property name is invalid

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

Increment a counter by the given value

Parameters

string $name

the name of the counter field to increment

int $delta

the value to increment by

bool $ignoreLimit

if true, ignore the counter's limit

Return Value

BaseObject

Exceptions

CounterOverLimitException

if the counter's limit exists and is exceeded

See also

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

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

Sets a field to reference the given object

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

Parameters

string $field

the name of the reference field

BaseObject|null $object

the object for the field to reference

bool $notification

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

Return Value

bool

true if this object was modified

Exceptions

KeyNotFoundException

if the property name is invalid

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

Same as BoolSetObject() but returns $this

Parameters

string $field
BaseObject|null $object
bool $notification

Return Value

BaseObject

See also

BaseObject::BoolSetObject

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

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

Parameters

string $field

the name of the field of the collection

BaseObject $object

the object to add to the collection

bool $notification

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

Return Value

bool

true if this object was modified

Exceptions

CounterOverLimitException

if the limit exists and is exceeded

See also

BaseObject::AddObjectRef

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

Removes the given object from a collection of referenced objects

Parameters

string $field

the name of the field of the collection

BaseObject $object

the object to add to the collection

bool $notification

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

Return Value

bool

true if this object was modified

Exceptions

KeyNotFoundException

if the property name is invalid

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

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

Parameters

ObjectDatabase $database

Reference to the database

array $data

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

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

Adds the given field object to the correct internal array

Parameters

string $key
Scalar $field

in BaseObject at line 763
protected void SubConstruct()

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

Return Value

void

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

Collects fields that have changed and saves them to the database

Parameters

bool $onlyMandatory

true if only required fields should be saved

Return Value

BaseObject

Exceptions

RowInsertFailedException

if the insert fails (duplicate?)

in BaseObject at line 814
bool isDeleted()

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

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

Return Value

bool

in BaseObject at line 820
void NotifyDBDeleted()

Deletes this object without sending to the DB

Return Value

void

at line 442
void Delete()

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

Return Value

void

in BaseObject at line 849
protected void DeleteLater()

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

Return Value

void

in BaseObject at line 855
bool isCreated()

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

Return Value

bool

in StandardObject at line 51
static protected BaseObject BaseCreate(ObjectDatabase $database)

Create the object by setting its created date

Parameters

ObjectDatabase $database

Return Value

BaseObject

See also

BaseObject::BaseCreate

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

Returns the timestamp value stored in the given date field

Parameters

string $name

Return Value

float

See also

BaseObject::GetScalar

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

Returns the timestamp value stored in the given date field

Parameters

string $name

Return Value

float|null

See also

BaseObject::TryGetScalar

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

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

Parameters

string $name

the name of the date field to set

float|null $value

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

Return Value

StandardObject

See also

BaseObject::SetScalar

in StandardObject at line 44
float GetDateCreated()

Returns the timestamp when this object was created

Return Value

float

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

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

Parameters

string $name
bool $allowTemp

Return Value

int

See also

BaseObject::GetScalar

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

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

Parameters

string $name
bool $allowTemp

Return Value

int|null

See also

BaseObject::GetScalar

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

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

Parameters

string $name
bool $allowTemp

Return Value

bool

See also

BaseObject::GetScalar

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

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

Parameters

string $name
bool $allowTemp

Return Value

bool|null

See also

BaseObject::GetScalar

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

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

Parameters

string $name
int|null $value
bool $temp

Return Value

StandardObject

See also

BaseObject::SetScalar

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

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

Parameters

string $name
bool|null $value
bool $temp

Return Value

StandardObject

See also

BaseObject::SetScalar

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

Returns true if the given feature has been modified

Parameters

string $name

Return Value

bool

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

Gets the value of the given counter field

Parameters

string $name

Return Value

int

See also

BaseObject::GetScalar

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

Gets the value of the given counter limit field

Parameters

string $name

Return Value

int

See also

BaseObject::GetScalar

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

Gets the value of the given counter limit field

Parameters

string $name

Return Value

int|null

See also

BaseObject::TryGetScalar

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

Sets the value of the given counter limit field

Parameters

string $name
int|null $value
bool $temp

Return Value

StandardObject

See also

BaseObject::SetScalar

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

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

Parameters

string $name

the name of the counter and counter limit field to check

int $delta

the value to try incrementing the counter by

bool $except

if true, throw an exception instead of returning false

Return Value

bool

if true, the limit exists and is not exceeded

Exceptions

CounterOverLimitException

if $except and retval is false

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

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

Parameters

string|null $prefix

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

Return Value

array

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

See also

BaseObject::TryGetScalar

at line 59
abstract Item Refresh()

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

Return Value

Item

at line 62
Account|null GetOwner()

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

Return Value

Account|null

at line 65
string|null GetOwnerID()

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

Return Value

string|null

at line 68
abstract string|null GetName()

Returns the name of this item

Return Value

string|null

at line 71
abstract int GetSize()

Returns the size of this item in bytes

Return Value

int

at line 74
abstract Folder|null GetParent()

Returns the parent folder of this item

Return Value

Folder|null

at line 77
abstract string|null GetParentID()

Returns the parent ID of this item

Return Value

string|null

at line 80
abstract Item SetName(string $name, bool $overwrite = false)

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

Parameters

string $name
bool $overwrite

Return Value

Item

at line 83
abstract Item SetParent(Folder $parent, bool $overwrite = false)

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

Parameters

Folder $parent
bool $overwrite

Return Value

Item

at line 86
string|null GetDescription()

Returns this item's description

Return Value

string|null

at line 89
Item SetDescription(string|null $val)

Sets this item's description to the given value

Parameters

string|null $val

Return Value

Item

at line 97
abstract 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.

Parameters

Account|null $owner

the owner of the new item

string $name

the name of the new item

bool $overwrite

if true, reuse the duplicate object

Return Value

Item

at line 105
abstract 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.

Parameters

Account|null $owner

the owner of the new item

Folder $parent

the parent folder of the new item

bool $overwrite

if true, reuse the duplicate object

Return Value

Item

at line 115
protected Item|null CheckName(string $name, bool $overwrite, bool $reuse)

Asserts that this item can be moved to the given name

Parameters

string $name

the item name to check for

bool $overwrite

if true, delete the duplicate item

bool $reuse

if true, return the duplicate item for reuse instead of deleting

Return Value

Item|null

existing item to be re-used

Exceptions

DuplicateItemException

if a duplicate item exists and not $overwrite

at line 140
protected Item|null CheckParent(Folder $parent, bool $overwrite, bool $reuse)

Asserts that this item can be moved to the given parent

Parameters

Folder $parent

parent folder to check

bool $overwrite

if true, delete the duplicate item

bool $reuse

if true, return the duplicate item for reuse instead of deleting

Return Value

Item|null

existing item to be re-used

Exceptions

CrossFilesystemException

if the parent is on a different filesystem

DuplicateItemException

if a duplicate item exists and not $overwrite

at line 160
Item SetOwner(Account $account)

Sets this item's owner to the given account

Parameters

Account $account

Return Value

Item

at line 179
abstract static Item NotifyCreate(ObjectDatabase $database, Folder $parent, Account|null $account, string $name)

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

Parameters

ObjectDatabase $database

database reference

Folder $parent

the item's parent folder

Account|null $account

the account owning this item

string $name

the name of the item

Return Value

Item

newly created object

at line 182
protected FSManager GetFilesystem()

Returns the filesystem manager that stores this object

Return Value

FSManager

at line 185
protected string GetFilesystemID()

Returns the ID of the object's filesystem manager

Return Value

string

at line 194
protected FSImpl GetFSImpl(bool $requireExist = true)

Returns the filesystem manager's implementor that stores this object

Parameters

bool $requireExist

if true the item must not be deleted

Refreshes the item from storage first to make sure it's ready to use.

Return Value

FSImpl

Exceptions

DeletedByStorageException

if requreExist and the item has been deleted

at line 206
bool isWorldAccess()

Returns true if this file should be accessible by all accounts

Return Value

bool

at line 214
Item SetAccessed(float|null $time = null)

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

Parameters

float|null $time

Return Value

Item

at line 222
Item SetCreated(float|null $time = null)

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

Parameters

float|null $time

Return Value

Item

at line 225
Item SetModified(float|null $time = null)

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

Parameters

float|null $time

Return Value

Item

at line 228
int GetBandwidth()

Returns the bandwidth used by the item in bytes

Return Value

int

at line 231
int GetPublicDownloads()

Returns the public download count of the item

Return Value

int

at line 239
array GetLikes(int|null $limit = null, int|null $offset = null)

Returns the like objects for this item

Parameters

int|null $limit

max # to load

int|null $offset

index to load from

Return Value

array

likes indexed by ID

at line 247
array GetComments(int|null $limit = null, int|null $offset = null)

Returns the comment objects for this item

Parameters

int|null $limit

max # to load

int|null $offset

index to load from

Return Value

array

comments indexed by ID

at line 253
array GetTags()

Returns the tag objects for this item

Return Value

array

tags indexed by ID

at line 259
array GetShares()

Returns the share objects for this item

Return Value

array

shares indexed by ID

at line 262
int GetNumShares()

Returns the number of shares on this object

Return Value

int

at line 268
protected Item CountCreate()

Registers a new item with all limit objects

Return Value

Item

at line 278
protected Item CountPublicDownload()

Counts a public download on the item and its parents

Return Value

Item

at line 289
Item CountBandwidth(int $bytes)

Counts the given bandwidth on the item and its parents

Parameters

int $bytes

Return Value

Item

at line 302
Item CountLike(bool $value, bool $count = true)

Increments the item's like counter

Parameters

bool $value

if true, count a like, else count a dislike

bool $count

if false, decrement, if true increment

Return Value

Item

at line 314
Item CountShare(bool $count = true)

Increments the item's share counter

Parameters

bool $count

if true, increment, if false, decrement

Return Value

Item

at line 326
protected Item MapToLimits(callable $func)

Maps the given function to all applicable limit objects

Parameters

callable $func

Return Value

Item

at line 335
protected Item MapToTotalLimits(callable $func)

Maps the given function to all applicable total limit objects

Parameters

callable $func

Return Value

Item

at line 348
protected Item MapToTimedLimits(callable $func)

Maps the given function to all applicable timed limit objects

Parameters

callable $func

Return Value

Item

at line 364
protected Item AddStatsToOwner(bool $add = true)

Adds this item's stats to all owner limits

Parameters

bool $add

if true add, else subtract

Return Value

Item

at line 384
protected Item AddStatsToFilesystem(bool $add = true)

Adds this item's stats to all filesystem limits

Parameters

bool $add

if true add, else subtract

Return Value

Item

at line 399
abstract protected void AddStatsToLimit(Base $limit, bool $add = true)

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

Parameters

Base $limit
bool $add

Return Value

void

at line 407
protected bool GetLimitsBool(callable $func, Account|null $account)

Returns a config bool for the item by checking applicable limits

Parameters

callable $func

the function returning the desired bool

Account|null $account

the account to check the permission for, or null for defaults

Return Value

bool

true if (the FS value is null or true) and the account value is true

at line 415
bool GetAllowPublicModify()

Returns true if the item should allow public modifications

Return Value

bool

at line 419
bool GetAllowPublicUpload()

Returns true if the item should allow public uploading

Return Value

bool

at line 423
bool GetAllowRandomWrite(Account $account)

Returns true if the item should allow random/partial writes

Parameters

Account $account

Return Value

bool

at line 427
bool GetAllowItemSharing(Account $account)

Returns true if the item should allow sharing

Parameters

Account $account

Return Value

bool

at line 431
bool GetAllowShareToGroups(Account $account)

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

Parameters

Account $account

Return Value

bool

at line 435
bool GetAllowShareToEveryone(Account $account)

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

Parameters

Account $account

Return Value

bool

at line 439
abstract void NotifyFSDeleted()

Deletes the item from the DB only

Return Value

void

at line 457
static Item|null TryLoadByParentAndName(ObjectDatabase $database, Folder $parent, string $name)

Attemps to load this item by the given info

Parameters

ObjectDatabase $database

database reference

Folder $parent

the parent folder of the item

string $name

the name of the item to load

Return Value

Item|null

loaded item or null if not found

at line 470
static array LoadByOwner(ObjectDatabase $database, Account $account)

Returns an array of all items belonging to the given owner

Parameters

ObjectDatabase $database

database reference

Account $account

the owner to load objects for

Return Value

array

items indexed by ID

at line 484
abstract static array LoadAdoptedByOwner(ObjectDatabase $database, Account $account)

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

Does not return items that are world accessible

Parameters

ObjectDatabase $database

database reference

Account $account

the account that owns the items

Return Value

array

items indexed by ID

at line 497
array|null SubGetClientObject(bool $owner = false, bool $details = false)

Returns a printable client object of this item

Parameters

bool $owner

if true, show owner-level details

bool $details

if true, show tag and share objects

Return Value

array|null

{id:id, name:?string, owner:?string, parent:?string, filesystem:string, \ dates:{created:float, modified:?float}, counters:{pubdownloads:int, bandwidth:int, likes:int, dislikes:int, tags:int, comments:int}} \ if $owner, add: {counters:{shares:int}, dates:{accessed:?float}}, \ if $details, add: {tags:[id:Tag]}, if $details && $owner, add {shares:[id:Share]}

See also

Tag::GetClientObject
Share::GetClientObject

at line 535
abstract array GetClientObject(bool $owner = false, bool $full = false)

No description

Parameters

bool $owner
bool $full

Return Value

array

at line 536
abstract array|null TryGetClientObject(bool $owner = false, bool $full = false)

No description

Parameters

bool $owner
bool $full

Return Value

array|null