Documentation

ApiUser
in package
implements IdentityInterface uses IdentifiableTrait

User model.

Attributes
#[Entity]

Table of Contents

Interfaces

IdentityInterface

Properties

$id  : int|null
The default value must be `null` to prevent issues with auto generating the value. The column is strictly not nullable.
$name  : string
Application name.
$token  : string
Authentication token.

Methods

getId()  : int|null
Get the identifier of the object.
getName()  : string
Get the name.
getResourceId()  : string
Get the API user's resource ID.
getRoleId()  : string
Get the API user's role ID.
getToken()  : string
Get the token.
setId()  : void
Setting the identifier manually will, in most instances, result in undefined behaviour. Use with caution!
setName()  : void
Set the name.
setToken()  : void
Set the token.

Properties

$id

The default value must be `null` to prevent issues with auto generating the value. The column is strictly not nullable.

protected int|null $id = null
Attributes
#[Column]
$type: 'integer'
#[GeneratedValue]
$strategy: 'IDENTITY'
#[Id]

$name

Application name.

protected string $name
Attributes
#[Column]
$type: 'string'

$token

Authentication token.

protected string $token
Attributes
#[Column]
$type: 'string'

Methods

getId()

Get the identifier of the object.

public getId() : int|null
Tags
psalm-ignore-nullable-return
Return values
int|null

getName()

Get the name.

public getName() : string
Return values
string

getResourceId()

Get the API user's resource ID.

public getResourceId() : string
Return values
string

getRoleId()

Get the API user's role ID.

public getRoleId() : string
Return values
string

getToken()

Get the token.

public getToken() : string
Return values
string

setId()

Setting the identifier manually will, in most instances, result in undefined behaviour. Use with caution!

public setId(int|null $id) : void
Parameters
$id : int|null

setName()

Set the name.

public setName(string $name) : void
Parameters
$name : string

setToken()

Set the token.

public setToken(string $token) : void
Parameters
$token : string

        
On this page

Search results