Neuron-PHP

User extends Model

in package

• Neuron
• Cms
• Models

User entity representing a CMS user.

Table of Contents

Constants

ROLE_ADMIN  = 'admin'

User roles

ROLE_AUTHOR  = 'author'

ROLE_EDITOR  = 'editor'

ROLE_SUBSCRIBER  = 'subscriber'

STATUS_ACTIVE  = 'active'

User statuses

STATUS_INACTIVE  = 'inactive'

STATUS_SUSPENDED  = 'suspended'

Properties

$_loadedRelations  : array<string|int, mixed>

Loaded relations cache

$_pdo  : PDO|null

Database connection

$_relationCache  : array<string|int, mixed>

Relation metadata cache

$_createdAt  : DateTimeImmutable|null

$_email  : string

$_emailVerified  : bool

$_events  : array<string|int, mixed>

$_failedLoginAttempts  : int

$_id  : int|null

$_lastLoginAt  : DateTimeImmutable|null

$_lockedUntil  : DateTimeImmutable|null

$_pages  : array<string|int, mixed>

$_passwordHash  : string

$_posts  : array<string|int, mixed>

$_rememberToken  : string|null

$_role  : string

$_status  : string

$_timezone  : string

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

$_twoFactorSecret  : string|null

$_updatedAt  : DateTimeImmutable|null

$_username  : string

Methods

__construct()  : mixed

__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 user from array

getAttribute()  : mixed

Get an attribute value from the model.

getCreatedAt()  : DateTimeImmutable|null

Get created at timestamp

getEmail()  : string

Get email

getFailedLoginAttempts()  : int

Get failed login attempts count

getId()  : int|null

Get user ID

getLastLoginAt()  : DateTimeImmutable|null

Get last login at timestamp

getLockedUntil()  : DateTimeImmutable|null

Get locked until timestamp

getPasswordHash()  : string

Get password hash

getPrimaryKey()  : string

Get the primary key column name.

getRememberToken()  : string|null

Get remember token

getRole()  : string

Get user role

getStatus()  : string

Get user status

getTableName()  : string

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

getTimezone()  : string

Get user timezone

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

Get two-factor recovery codes

getTwoFactorSecret()  : string|null

Get two-factor secret

getUpdatedAt()  : DateTimeImmutable|null

Get updated at timestamp

getUsername()  : string

Get username

hasTwoFactorEnabled()  : bool

Check if two-factor authentication is enabled

incrementFailedLoginAttempts()  : self

Increment failed login attempts

inTransaction()  : bool

Check if currently inside a transaction.

isActive()  : bool

Check if user is active

isAdmin()  : bool

Check if user is admin

isAuthor()  : bool

Check if user is author

isEditor()  : bool

Check if user is editor

isEmailVerified()  : bool

Check if email is verified

isLockedOut()  : bool

Check if user is locked out

isSuspended()  : bool

Check if user is suspended

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

resetFailedLoginAttempts()  : self

Reset failed login attempts

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.

setCreatedAt()  : self

Set created at timestamp

setEmail()  : self

Set email

setEmailVerified()  : self

Set email verified status

setFailedLoginAttempts()  : self

Set failed login attempts count

setId()  : self

Set user ID

setLastLoginAt()  : self

Set last login at timestamp

setLoadedRelation()  : void

Set a loaded relation (used by eager loading).

setLockedUntil()  : self

Set locked until timestamp

setPasswordHash()  : self

Set password hash

setPdo()  : void

Set the PDO connection for all models.

setRememberToken()  : self

Set remember token

setRole()  : self

Set user role

setStatus()  : self

Set user status

setTimezone()  : self

Set user timezone

setTwoFactorRecoveryCodes()  : self

Set two-factor recovery codes

setTwoFactorSecret()  : self

Set two-factor secret

setUpdatedAt()  : self

Set updated at timestamp

setUsername()  : self

Set username

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

Convert user to 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.