Documentation

FlightAwareApiCall extends Model
in package

FinalYes

Abstract class representing database model from which all other models that are not a list inherit from.

Tags
author

Ramone Burrell ramone@ramoneburrell.com

since

Version 0.1.0

Table of Contents

Properties

$framework_class_names  : array<string|int, mixed>
$id  : string|int|null
$dsn_name  : string
The name of the data source name to use in reading, writing and performing database operations on this model. This property essentially descibes where data for instances of this model is stored. By default it is null which indicates that the data for the model is stored, or should be stored in the default database source /data source.
$marshall_field_exemptions  : array<string|int, mixed>
$candidate_id  : string
A type 5 UUID representing the id that would be used to insert a new record for this model if it were to be saved. If this model is one that has been instantiated from an existing database record then this property will be null
$hashCode  : int
$hashCounter  : int
$list_class  : string
$model_type  : string
$read_state  : array<string|int, mixed>
An array of key value pairs which represent the state of the record/object when it was last read from the data source

Methods

__call()  : mixed
__callStatic()  : mixed
__construct()  : mixed
__destruct()  : mixed
__get()  : mixed
__toString()  : string
Retrieves a string representation of this object
addMarshallFieldExemption()  : void
Adds a field that should be extempted when this object is marshalled
applyFieldValues()  : Model
delete()  : Model
Does a hard deleted on the database record this instance represents
extends()  : bool
getCandidateId()  : string|null
getDSNName()  : string|null
getId()  : string|int|null
getMarshallFieldExemptions()  : array<string|int, mixed>
Gets the fields that are exempted when object is marshalled
getModelType()  : string
getReflection()  : ReflectionClass
getRootBaseClass()  : ReflectionClass
getTable()  : ITable
marshall()  : mixed
postModelManagerPut()  : IModel
Called after the instance has been put into the model manager
purge()  : IModel
save()  : IModel
init()  : mixed
postInit()  : Model
postInitialSave()  : IModel
postSave()  : IModel
postSourceDataWrite()  : IModel
Called after data from the database has been written to this model
preInitialSave()  : IModel
preSave()  : IModel
setDSNName()  : IModel
sourceDataWrite()  : IModel
Writes data from the data source to this instance
getCalledClassSchema()  : ISchema
getListClass()  : string
getSchema()  : ISchema
saveAsHistory()  : IModel
update()  : IModel

Properties

$framework_class_names

public static array<string|int, mixed> $framework_class_names = ['FlightAwareApiCall', 'RecordHistory', 'Skin', 'SkinDomain', 'Timezone']

$dsn_name

The name of the data source name to use in reading, writing and performing database operations on this model. This property essentially descibes where data for instances of this model is stored. By default it is null which indicates that the data for the model is stored, or should be stored in the default database source /data source.

protected string $dsn_name

$marshall_field_exemptions

protected array<string|int, mixed> $marshall_field_exemptions = []

$candidate_id

A type 5 UUID representing the id that would be used to insert a new record for this model if it were to be saved. If this model is one that has been instantiated from an existing database record then this property will be null

private string $candidate_id

$read_state

An array of key value pairs which represent the state of the record/object when it was last read from the data source

private array<string|int, mixed> $read_state

Methods

__callStatic()

public static __callStatic(mixed $method, array<string|int, mixed> $arguments) : mixed
Parameters
$method : mixed
$arguments : array<string|int, mixed>

__get()

public __get(string $property) : mixed
Parameters
$property : string

__toString()

Retrieves a string representation of this object

public __toString() : string
Return values
string

$id

addMarshallFieldExemption()

Adds a field that should be extempted when this object is marshalled

public addMarshallFieldExemption(string $field) : void
Parameters
$field : string

applyFieldValues()

public applyFieldValues(array<string|int, mixed> $data[, array<string|int, mixed> $exceptions = array() ]) : Model
Parameters
$data : array<string|int, mixed>
$exceptions : array<string|int, mixed> = array()
Return values
Model

delete()

Does a hard deleted on the database record this instance represents

public delete() : Model
Return values
Model

A reference to this instance

extends()

public extends(ReflectionClass $reflector) : bool
Parameters
$reflector : ReflectionClass
Return values
bool

getCandidateId()

public getCandidateId() : string|null
Return values
string|null

getDSNName()

public getDSNName() : string|null
Return values
string|null

getMarshallFieldExemptions()

Gets the fields that are exempted when object is marshalled

public getMarshallFieldExemptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array of fields that are exempted when the object is marshalled

getReflection()

public getReflection() : ReflectionClass
Return values
ReflectionClass

getRootBaseClass()

public getRootBaseClass() : ReflectionClass
Return values
ReflectionClass

postModelManagerPut()

Called after the instance has been put into the model manager

public postModelManagerPut() : IModel
Return values
IModel

postSourceDataWrite()

Called after data from the database has been written to this model

protected postSourceDataWrite() : IModel
Return values
IModel

sourceDataWrite()

Writes data from the data source to this instance

protected sourceDataWrite(array<string|int, mixed> $data) : IModel
Parameters
$data : array<string|int, mixed>

The data to write to this instance

Return values
IModel

A reference to this instance


        
On this page

Search results