Neuron-PHP

Model
in package

Neuron

Orm

AbstractYes

Base model class with attribute-based relation support.

Models extending this class can use PHP 8 attributes to define database relations in a Rails-like manner.

Properties

$_loadedRelations : array<string|int, mixed>: Loaded relations cache
$_pdo : PDO|null: Database connection
$_relationCache : array<string|int, mixed>: Relation metadata cache

Methods

__get() : mixed: Magic method to access relations.
all() : array<string|int, mixed>: Get all models.
beginTransaction() : bool: Begin a database transaction.
commit() : bool: Commit the current transaction.
create() : static: Create a new model and save it to the database.
delete() : bool: Delete the model without handling dependents (simple delete).
destroy() : bool: Delete the model from the database with dependent cascade.
destroyMany() : int: Delete one or more models by ID.
exists() : bool: Check if the model exists in the database.
fill() : self: Fill the model with an array of attributes.
find() : static|null: Find a model by primary key.
fromArray() : static: Create model instance from array data.
getAttribute() : mixed: Get an attribute value from the model.
getPrimaryKey() : string: Get the primary key column name.
getTableName() : string: Get the table name for this model from the Table attribute.
inTransaction() : bool: Check if currently inside a transaction.
limit() : QueryBuilder: Set result limit.
loadRelations() : void: Eager load relations.
offset() : QueryBuilder: Set result offset.
orderBy() : QueryBuilder: Add an order by clause.
query() : QueryBuilder: Create a new query builder for this model.
relation() : BelongsToRelation|HasManyRelation|HasOneRelation|BelongsToManyRelation: Get a relation instance (for calling sync/attach/detach methods).
rollBack() : bool: Roll back the current transaction.
save() : bool: Save the model to the database (insert or update).
setAttribute() : void: Set an attribute value on the model.
setLoadedRelation() : void: Set a loaded relation (used by eager loading).
setPdo() : void: Set the PDO connection for all models.
toArray() : array<string|int, mixed>: Convert the model to an array.
transaction() : mixed: Execute a closure within a database transaction.
update() : bool: Update the model's attributes and save to database.
where() : QueryBuilder: Start a query with a where clause.
whereIn() : QueryBuilder: Start a query with a where in clause.
with() : QueryBuilder: Eager load relations.
createRelation() : BelongsToRelation|HasManyRelation|HasOneRelation|BelongsToManyRelation: Create a relation instance.
getForeignKeyName() : string: Get the foreign key name for this model.
getPdo() : PDO: Get the PDO connection.
getPivotTableName() : string: Get the pivot table name for a many-to-many relationship.
getRelatedForeignKeyName() : string: Get the foreign key name for a related model.
getRelationMetadata() : array<string|int, mixed>|null: Get relation metadata for a property.
handleDependentRelations() : void: Handle dependent relations before destroying the model.
performInsert() : bool: Perform an insert operation.
performUpdate() : bool: Perform an update operation.
propertyToColumn() : string: Convert property name to database column name.

$_loadedRelations

Loaded relations cache


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

$_pdo

Database connection


    protected
    static    PDO|null
    $_pdo
     = null

$_relationCache

Relation metadata cache


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

__get()

Magic method to access relations.


    public
                    __get(string $name) : mixed

Parameters

$name : string

all()

Get all models.


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

Return values

array<string|int, mixed>

beginTransaction()

Begin a database transaction.


    public
            static        beginTransaction() : bool

Return values

bool —

True on success

commit()

Commit the current transaction.


    public
            static        commit() : bool

Return values

bool —

True on success

create()

Create a new model and save it to the database.


    public
            static        create(array<string|int, mixed> $attributes) : static

Parameters

$attributes : array<string|int, mixed>

Return values

static

delete()

Delete the model without handling dependents (simple delete).


    public
                    delete() : bool

Return values

bool

destroy()

Delete the model from the database with dependent cascade.


    public
                    destroy() : bool

Return values

bool

destroyMany()

Delete one or more models by ID.


    public
            static        destroyMany(int|array<string|int, mixed> $ids) : int

Parameters

$ids : int|array<string|int, mixed>

Return values

int —

Number of records deleted

exists()

Check if the model exists in the database.


    public
                    exists() : bool

Return values

bool

fill()

Fill the model with an array of attributes.


    public
                    fill(array<string|int, mixed> $attributes) : self

Parameters

$attributes : array<string|int, mixed>

Return values

self

find()

Find a model by primary key.


    public
            static        find(int $id) : static|null

Parameters

$id : int

Return values

static|null

fromArray()

Create model instance from array data.


    public
    abstract        static        fromArray(array<string|int, mixed> $data) : static

This should be implemented by child classes.

Parameters

$data : array<string|int, mixed>

Return values

static

getAttribute()

Get an attribute value from the model.


    public
                    getAttribute(string $key) : mixed

Parameters

$key : string

getPrimaryKey()

Get the primary key column name.


    public
            static        getPrimaryKey() : string

Return values

string

getTableName()

Get the table name for this model from the Table attribute.


    public
            static        getTableName() : string

Return values

string

inTransaction()

Check if currently inside a transaction.


    public
            static        inTransaction() : bool

Return values

bool —

True if inside a transaction

limit()

Set result limit.


    public
            static        limit(int $limit) : QueryBuilder

Parameters

$limit : int

Return values

QueryBuilder

loadRelations()

Eager load relations.


    public
            static        loadRelations(array<string|int, mixed> $relations, array<string|int, mixed> $models) : void

Parameters

$relations : array<string|int, mixed>: Relation names to load
$models : array<string|int, mixed>: Array of models to load relations for

offset()

Set result offset.


    public
            static        offset(int $offset) : QueryBuilder

Parameters

$offset : int

Return values

QueryBuilder

orderBy()

Add an order by clause.


    public
            static        orderBy(string $column[, string $direction = 'ASC' ]) : QueryBuilder

Parameters

$column : string
$direction : string = 'ASC'

Return values

QueryBuilder

query()

Create a new query builder for this model.


    public
            static        query() : QueryBuilder

Return values

QueryBuilder

relation()

Get a relation instance (for calling sync/attach/detach methods).


    public
                    relation(string $name) : BelongsToRelation|HasManyRelation|HasOneRelation|BelongsToManyRelation

Parameters

$name : string: Relation name

Return values

BelongsToRelation|HasManyRelation|HasOneRelation|BelongsToManyRelation

rollBack()

Roll back the current transaction.


    public
            static        rollBack() : bool

Return values

bool —

True on success

save()

Save the model to the database (insert or update).


    public
                    save() : bool

Return values

bool

setAttribute()

Set an attribute value on the model.


    public
                    setAttribute(string $key, mixed $value) : void

Parameters

$key : string
$value : mixed

setLoadedRelation()

Set a loaded relation (used by eager loading).


    public
                    setLoadedRelation(string $name, mixed $value) : void

Parameters

$name : string
$value : mixed

setPdo()

Set the PDO connection for all models.


    public
            static        setPdo(PDO $pdo) : void

Parameters

$pdo : PDO

toArray()

Convert the model to an array.


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

Return values

array<string|int, mixed>

transaction()

Execute a closure within a database transaction.


    public
            static        transaction(callable $callback) : mixed

If the closure executes successfully, the transaction is committed. If an exception is thrown, the transaction is rolled back and the exception is re-thrown.

Parameters

$callback : callable: Function to execute within transaction

Return values

mixed —

The return value of the callback

update()

Update the model's attributes and save to database.


    public
                    update(array<string|int, mixed> $attributes) : bool

Parameters

$attributes : array<string|int, mixed>

Return values

bool

where()

Start a query with a where clause.


    public
            static        where(string $column, mixed $operator[, mixed|null $value = null ]) : QueryBuilder

Parameters

$column : string
$operator : mixed
$value : mixed|null = null

Return values

QueryBuilder

whereIn()

Start a query with a where in clause.


    public
            static        whereIn(string $column, array<string|int, mixed> $values) : QueryBuilder

Parameters

$column : string
$values : array<string|int, mixed>

Return values

QueryBuilder

with()

Eager load relations.


    public
            static        with(array<string|int, mixed>|string $relations) : QueryBuilder

Parameters

$relations : array<string|int, mixed>|string

Return values

QueryBuilder

createRelation()

Create a relation instance.


    protected
                    createRelation(string $propertyName, array<string|int, mixed> $metadata) : BelongsToRelation|HasManyRelation|HasOneRelation|BelongsToManyRelation

Parameters

$propertyName : string
$metadata : array<string|int, mixed>

Return values

BelongsToRelation|HasManyRelation|HasOneRelation|BelongsToManyRelation

getForeignKeyName()

Get the foreign key name for this model.


    protected
                    getForeignKeyName() : string

Return values

string

getPdo()

Get the PDO connection.


    protected
            static        getPdo() : PDO

Return values

PDO

getPivotTableName()

Get the pivot table name for a many-to-many relationship.


    protected
                    getPivotTableName(string $relatedModel) : string

Parameters

$relatedModel : string

Return values

string

getRelatedForeignKeyName()

Get the foreign key name for a related model.


    protected
                    getRelatedForeignKeyName(string $relatedModel) : string

Parameters

$relatedModel : string

Return values

string

getRelationMetadata()

Get relation metadata for a property.


    protected
                    getRelationMetadata(string $propertyName) : array<string|int, mixed>|null

Parameters

$propertyName : string

Return values

array<string|int, mixed>|null

handleDependentRelations()

Handle dependent relations before destroying the model.


    protected
                    handleDependentRelations() : void

performInsert()

Perform an insert operation.


    protected
                    performInsert() : bool

Return values

bool

performUpdate()

Perform an update operation.


    protected
                    performUpdate() : bool

Return values

bool

propertyToColumn()

Convert property name to database column name.


    protected
                    propertyToColumn(string $propertyName) : string

Parameters

$propertyName : string

Return values

string

Model in package Neuron Orm

Table of Contents

Properties

Methods

Properties

$_loadedRelations

$_pdo

$_relationCache

Methods

__get()

Parameters

Tags

all()

Return values

beginTransaction()

Tags

Return values

commit()

Tags

Return values

create()

Parameters

Tags

Return values

delete()

Tags

Return values

destroy()

Tags

Return values

destroyMany()

Parameters

Tags

Return values

exists()

Return values

fill()

Parameters

Return values

find()

Parameters

Return values

fromArray()

Parameters

Return values

getAttribute()

Parameters

getPrimaryKey()

Return values

getTableName()

Tags

Return values

inTransaction()

Tags

Return values

limit()

Parameters

Return values

loadRelations()

Parameters

offset()

Parameters

Return values

orderBy()

Parameters

Return values

query()

Return values

relation()

Parameters

Tags

Return values

rollBack()

Tags

Return values

save()

Tags

Return values

setAttribute()

Parameters

Model
in package

Neuron

Orm