Documentation

Model extends Component

in package

• Application

implements IModel, IMarshallable Uses TMarshallable

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.0.1

Table of Contents

Interfaces

IModel

IMarshallable

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|null

__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()  : IModel

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