Documentation

ModelWithChildren extends BaseModel
in package

Degami

Sitebase

uses WithChildrenTrait

AbstractYes

A model with children

Properties

$table_name : string|null
$children : array<string|int, mixed>
$db_row : Row
$is_first_save : bool
$keyField : string|array<string|int, mixed>
$loadedObjects : array<string|int, mixed>
$original_data : array<string|int, mixed>|null

Methods

__call() : mixed: {@inheritdoc}
__construct() : mixed: {@inheritdoc}
__get() : mixed: {@inheritdoc}
__isset() : bool: {@inheritdoc}
__set() : void: {@inheritdoc}
__unset() : void: {@inheritdoc}
checkLoaded() : self: ensures model is loaded
current() : mixed: {@inheritdoc}
defaultTableName() : string: gets model table name
delete() : self: removes model from db
fill() : self: fills empty model with data
getChangedData() : array<string|int, mixed>|null: gets model's changed data
getChildren() : array<string|int, mixed>: gets children
getCollection() : BaseCollection: returns a Model collection
getData() : mixed: gets model's data
getDbRow() : Row
getDescendants() : array<string|int, static>: Gets all descendant objects recursively
getIterator() : Traversable|ArrayIterator: {@inheritdoc}
getKeyField() : string|array<string|int, mixed>
getKeyFieldValue() : mixed
getPosition() : int
getSearchCollection() : BaseCollection: returns a Model collection using SearchManager for finding elements
getTableColumns() : mixed
hydrateStatementResult() : array<string|int, mixed>: returns an array of models, starting from a statement Result
isFirstSave() : bool: is first save flag
isLoaded() : bool: checks if model is loaded
isNew() : bool: checks if model is new
key() : mixed: {@inheritdoc}
load() : self: loads model by id
loadBy() : self: loads model by field - value pair
loadByCondition() : self|null: loads model by condition
new() : static: gets new empty model
next() : mixed: {@inheritdoc}
offsetExists() : bool: {@inheritdoc}
offsetGet() : mixed: {@inheritdoc}
offsetSet() : void: {@inheritdoc}
offsetUnset() : void: {@inheritdoc}
persist() : self: saves model on db
postLoad() : self: post load hook
postPersist() : self: post persist hook
postRemove() : self: post remove hook
prePersist() : self: pre persist hook
preRemove() : BaseModel: pre remove hook
remove() : self: removes model from db
reset() : self: resets model
rewind() : mixed: {@inheritdoc}
save() : self: saves model on db
select() : PDOStatement: basic select statement
setData() : self: sets model's data
setDbRow() : self
setIsFirstSave() : $this: sets is first save flag
setPosition() : self
setTableName() : self
toJson() : string: gets Model json rapresentation
valid() : mixed: {@inheritdoc}
cmpPosition() : int
getModelBasicWhere() : Result: gets basic where statement for model
getModelName() : string: gets object model name
getOriginalData() : mixed: gets model's original data
getTableName() : string: gets table name
loadedObjectsIdentifier() : string
setOriginalData() : $this: sets model's original data
sortChildren() : void: sort children by position
checkDbName() : self: checks if Row object is from correct table

$table_name


    public
        string|null
    $table_name
     = null

table name

$children


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

children

$db_row


    protected
        Row
    $db_row
     = null

database row

$is_first_save


    protected
        bool
    $is_first_save

first save flag

$keyField


    protected
    static    string|array<string|int, mixed>
    $keyField
     = 'id'

$loadedObjects


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

objects cache

$original_data


    private
        array<string|int, mixed>|null
    $original_data
     = null

original model data

__call()

{@inheritdoc}


    public
                    __call(string $name, mixed $arguments) : mixed

Parameters

$name : string
$arguments : mixed

__construct()

{@inheritdoc}


    public
                    __construct([Row|null $db_row = null ]) : mixed

Parameters

$db_row : Row|null = null

__get()

{@inheritdoc}


    public
                    __get(mixed $key) : mixed

Parameters

$key : mixed

__isset()

{@inheritdoc}


    public
                    __isset(mixed $name) : bool

Parameters

$name : mixed

Return values

bool

__set()

{@inheritdoc}


    public
                    __set(mixed $key, mixed $value) : void

Parameters

$key : mixed
$value : mixed

__unset()

{@inheritdoc}


    public
                    __unset(mixed $name) : void

Parameters

$name : mixed

checkLoaded()

ensures model is loaded


    public
                    checkLoaded() : self

Return values

self

current()

{@inheritdoc}


    public
                    current() : mixed

defaultTableName()

gets model table name


    public
            static        defaultTableName() : string

Return values

string

delete()

removes model from db


    public
                    delete() : self

Return values

self

fill()

fills empty model with data


    public
                    fill(int|Row $id) : self

Parameters

$id : int|Row

Return values

self

getChangedData()

gets model's changed data


    public
                    getChangedData() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

getChildren()

gets children


    public
                    getChildren([string|null $locale = null ][, bool $reset = false ]) : array<string|int, mixed>

Parameters

$locale : string|null = null
$reset : bool = false

Return values

array<string|int, mixed>

getCollection()

returns a Model collection


    public
            static        getCollection() : BaseCollection

Return values

BaseCollection

getData()

gets model's data


    public
                    getData([mixed|null $column = null ]) : mixed

Parameters

$column : mixed|null = null

getDbRow()


    public
                    getDbRow() : Row

Return values

Row —

database row

getDescendants()

Gets all descendant objects recursively


    public
                    getDescendants() : array<string|int, static>

Return values

array<string|int, static>

getIterator()

{@inheritdoc}


    public
                    getIterator() : Traversable|ArrayIterator

Return values

Traversable|ArrayIterator

getKeyField()


    public
            static        getKeyField() : string|array<string|int, mixed>

Return values

string|array<string|int, mixed>

getKeyFieldValue()


    public
                    getKeyFieldValue() : mixed

getPosition()


    public
                    getPosition() : int

;

Return values

int

getSearchCollection()

returns a Model collection using SearchManager for finding elements


    public
            static        getSearchCollection([array<string|int, mixed> $conditions = [] ]) : BaseCollection

Parameters

$conditions : array<string|int, mixed> = []

Return values

BaseCollection

getTableColumns()


    public
            static        getTableColumns() : mixed

hydrateStatementResult()

returns an array of models, starting from a statement Result


    public
            static        hydrateStatementResult(Result $stmt) : array<string|int, mixed>

Parameters

$stmt : Result

Return values

array<string|int, mixed>

isFirstSave()

is first save flag


    public
                    isFirstSave() : bool

Return values

bool

isLoaded()

checks if model is loaded


    public
                    isLoaded() : bool

Return values

bool

isNew()

checks if model is new


    public
                    isNew() : bool

Return values

bool

key()

{@inheritdoc}


    public
                    key() : mixed

load()

loads model by id


    public
            static        load(mixed $id[, bool $reset = false ]) : self

Parameters

$id : mixed
$reset : bool = false

Return values

self

loadBy()

loads model by field - value pair


    public
            static        loadBy(string $field, mixed $value) : self

Parameters

$field : string
$value : mixed

Return values

self

loadByCondition()

loads model by condition


    public
            static        loadByCondition(array<string|int, mixed> $condition) : self|null

Parameters

$condition : array<string|int, mixed>

Return values

self|null

new()

gets new empty model


    public
            static        new([array<string|int, mixed> $initial_data = [] ]) : static

Parameters

$initial_data : array<string|int, mixed> = []

Return values

static

next()

{@inheritdoc}


    public
                    next() : mixed

offsetExists()

{@inheritdoc}


    public
                    offsetExists(mixed $offset) : bool

Parameters

$offset : mixed

Return values

bool

offsetGet()

{@inheritdoc}


    public
                    offsetGet(mixed $offset) : mixed

Parameters

$offset : mixed

offsetSet()

{@inheritdoc}


    public
                    offsetSet(mixed $offset, mixed $value) : void

Parameters

$offset : mixed
$value : mixed

offsetUnset()

{@inheritdoc}


    public
                    offsetUnset(mixed $offset) : void

Parameters

$offset : mixed

persist()

saves model on db


    public
                    persist([bool $recursive = true ]) : self

Parameters

$recursive : bool = true

Return values

self

postLoad()

post load hook


    public
                    postLoad() : self

Return values

self

postPersist()

post persist hook


    public
                    postPersist() : self

Return values

self

postRemove()

post remove hook


    public
                    postRemove() : self

Return values

self

prePersist()

pre persist hook


    public
                    prePersist() : self

Return values

self

preRemove()

pre remove hook


    public
                    preRemove() : BaseModel

Return values

BaseModel

remove()

removes model from db


    public
                    remove() : self

Return values

self

reset()

resets model


    public
                    reset() : self

Return values

self

rewind()

{@inheritdoc}


    public
                    rewind() : mixed

save()

saves model on db


    public
                    save() : self

Return values

self

select()

basic select statement


    public
            static        select([array<string|int, mixed> $options = [] ]) : PDOStatement

Parameters

$options : array<string|int, mixed> = []

Return values

PDOStatement

setData()

sets model's data


    public
                    setData(array<string|int, mixed> $data) : self

Parameters

$data : array<string|int, mixed>

Return values

self

setDbRow()


    public
                    setDbRow(Row $db_row) : self

Parameters

$db_row : Row

Return values

self

setIsFirstSave()

sets is first save flag


    public
                    setIsFirstSave(bool $is_first_save) : $this

Parameters

$is_first_save : bool

Return values

$this

setPosition()


    public
                    setPosition(int $position) : self

;

Parameters

$position : int

Return values

self

setTableName()


    public
                    setTableName(string $table_name) : self

Parameters

$table_name : string

Return values

self

toJson()

gets Model json rapresentation


    public
                    toJson([int $level = 0 ]) : string

Parameters

$level : int = 0: internally used

Return values

string

valid()

{@inheritdoc}


    public
                    valid() : mixed

cmpPosition()


    protected
                    cmpPosition(ModelWithChildren $a, ModelWithChildren $b) : int

Parameters

$a : ModelWithChildren
$b : ModelWithChildren

Return values

int

getModelBasicWhere()

gets basic where statement for model


    protected
            static        getModelBasicWhere([array<string|int, mixed>|null $condition = [] ][, array<string|int, mixed> $order = [] ]) : Result

Parameters

$condition : array<string|int, mixed>|null = []
$order : array<string|int, mixed> = []

Return values

Result

getModelName()

gets object model name


    protected
                    getModelName() : string

Return values

string

getOriginalData()

gets model's original data


    protected
                    getOriginalData([mixed|null $key = null ]) : mixed

Parameters

$key : mixed|null = null

getTableName()

gets table name


    protected
                    getTableName() : string

Return values

string

loadedObjectsIdentifier()


    protected
            static        loadedObjectsIdentifier(mixed $id) : string

Parameters

$id : mixed

Return values

string

setOriginalData()

sets model's original data


    protected
                    setOriginalData(array<string|int, mixed>|null $original_data) : $this

Parameters

$original_data : array<string|int, mixed>|null

Return values

$this

sortChildren()

sort children by position


    protected
                    sortChildren() : void

checkDbName()

checks if Row object is from correct table


    private
                    checkDbName(Row $db_row) : self

Parameters

$db_row : Row

Return values

self

ModelWithChildren extends BaseModel in package Degami Sitebase uses WithChildrenTrait

Table of Contents

Properties

Methods

Properties

$table_name

$children

$db_row

$is_first_save

$keyField

$loadedObjects

$original_data

Methods

__call()

Parameters

Tags

__construct()

Parameters

Tags

__get()

Parameters

__isset()

Parameters

Return values

__set()

Parameters

__unset()

Parameters

checkLoaded()

Tags

Return values

current()

defaultTableName()

Return values

delete()

Tags

Return values

fill()

Parameters

Tags

Return values

getChangedData()

Return values

getChildren()

Parameters

Return values

getCollection()

Return values

getData()

Parameters

getDbRow()

Return values

getDescendants()

Return values

getIterator()

Return values

getKeyField()

Return values

getKeyFieldValue()

getPosition()

Return values

getSearchCollection()

Parameters

Return values

getTableColumns()

hydrateStatementResult()

Parameters

Tags

Return values

isFirstSave()

Return values

isLoaded()

Return values

isNew()

Return values

key()

load()

Parameters

Return values

loadBy()

ModelWithChildren extends BaseModel
in package

Degami

Sitebase

uses WithChildrenTrait