ApiOpenStudio PHPDoc

Role
in package

Class Role.

DB class for storing role row data.

Table of Contents

$name  : string|null
Role name.
$rid  : int|null
Role ID.
__construct()  : mixed
Role constructor.
dump()  : array<string|int, mixed>
Return the values as an associative array.
getName()  : string
Get the role name.
getRid()  : int
Get the role ID.
setName()  : void
Set the role name.
setRid()  : void
Set the role ID.

Properties

$name

Role name.

protected string|null $name

Role name.

$rid

Role ID.

protected int|null $rid

Role ID.

Methods

__construct()

Role constructor.

public __construct([int|null $rid = null ][, string|null $name = null ]) : mixed
Parameters
$rid : int|null = null

Role ID.

$name : string|null = null

Role name.

Return values
mixed

dump()

Return the values as an associative array.

public dump() : array<string|int, mixed>
Return values
array<string|int, mixed>

Role object.

getName()

Get the role name.

public getName() : string
Return values
string

Name

getRid()

Get the role ID.

public getRid() : int
Return values
int

Role ID.

setName()

Set the role name.

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

Role name.

Return values
void

setRid()

Set the role ID.

public setRid(int $rid) : void
Parameters
$rid : int

Role ID.

Return values
void

Search results