Documentation

Roles extends Model
in package

Table of Contents

$errors  : array<string|int, mixed>
$instance  : array<string|int, mixed>
$pk  : string
$softDelete  : bool
$table  : string
$throw  : bool
__callStatic()  : mixed
append()  :
beginTransaction()  :
between()  :
bindingParams()  :
buildQuery()  :
commit()  :
cover()  :
database()  :
debug()  :
delete()  :
exists()  :
find()  :
findInSet()  :
first()  :
getErrors()  : array<string|int, mixed>
getLastError()  : string
getRoleFromID()  : array<string|int, mixed>|bool
getRoleFromName()  : array<string|int, mixed>|bool
getRolePermissions()  : array<string|int, mixed>|bool
permissions list for each group
group()  :
having()  :
in()  :
insert()  :
isNotNull()  :
isNull()  :
join()  :
last()  :
leftJoin()  :
like()  :
limit()  :
multiLineInsert()  :
notBetween()  :
notExists()  :
notFindInSet()  :
notIn()  :
order()  :
orHaving()  :
orWhere()  :
pk()  :
prepend()  :
rightJoin()  :
rollBack()  :
select()  :
softDelete()  :
static()  : mixed|static
subQuery()  :
table()  :
throw()  : $this
transaction()  :
update()  :
upsert()  :
where()  :
setError()  : false

Properties

$errors

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

$instance

protected static array<string|int, mixed> $instance

$pk

protected string $pk = 'r.roleID'

$softDelete

protected bool $softDelete = false

$table

protected string $table = 'user_roles r'

$throw

protected static bool $throw = false

Methods

__callStatic()

public final static __callStatic( $methods,  $arguments) : mixed
Parameters
$methods :
$arguments :
Tags
throws
Exception
Return values
mixed —

append()

public static append(string $raw, array<string|int, mixed> $bindings = []) :
Parameters
$raw : string
$bindings = [] : array<string|int, mixed>
Return values
—

beginTransaction()

public static beginTransaction() :
Return values
—

between()

public static between(string $column, mixed $param1, mixed $param2, string $andOR = 'AND') :
Parameters
$column : string
$param1 : mixed
$param2 : mixed
$andOR = 'AND' : string
Return values
—

bindingParams()

public static bindingParams() :
Return values
—

buildQuery()

public static buildQuery() :
Return values
—

commit()

public static commit() :
Return values
—

cover()

public static cover(mixed $condition, mixed $callback) :
Parameters
$condition : mixed
$callback : mixed
Return values
—

database()

public static database() :
Return values
—

debug()

public static debug() :
Return values
—

delete()

public static delete(mixed $columns, mixed $param, bool $force = false) :
Parameters
$columns : mixed
$param : mixed
$force = false : bool
Return values
—

exists()

public static exists(string $query, string $andOR = 'AND') :
Parameters
$query : string
$andOR = 'AND' : string
Return values
—

find()

public static find(mixed $param) :
Parameters
$param : mixed
Return values
—

findInSet()

public static findInSet(string $param1, mixed $param2, string $andOR = 'AND') :
Parameters
$param1 : string
$param2 : mixed
$andOR = 'AND' : string
Return values
—

first()

public static first(int $rowCount = 1) :
Parameters
$rowCount = 1 : int
Return values
—

getErrors()

public final getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getLastError()

public final getLastError() : string
Return values
string —

getRoleFromID()

public getRoleFromID(int $roleID) : array<string|int, mixed>|bool
Parameters
$roleID : int
Return values
array<string|int, mixed>|bool —

getRoleFromName()

public getRoleFromName(string $roleName) : array<string|int, mixed>|bool
Parameters
$roleName : string
Return values
array<string|int, mixed>|bool —

getRolePermissions()

permissions list for each group

public getRolePermissions() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —

group()

public static group(string $column) :
Parameters
$column : string
Return values
—

having()

public static having(string $column, string $operant, mixed $param) :
Parameters
$column : string
$operant : string
$param : mixed
Return values
—

in()

public static in(string $column, array<string|int, mixed> $params, string $andOR = 'AND') :
Parameters
$column : string
$params : array<string|int, mixed>
$andOR = 'AND' : string
Return values
—

insert()

public static insert(array<string|int, mixed> $columns) :
Parameters
$columns : array<string|int, mixed>
Return values
—

isNotNull()

public static isNotNull(string $column, mixed $andOR) :
Parameters
$column : string
$andOR : mixed
Return values
—

isNull()

public static isNull(string $column, mixed $andOR) :
Parameters
$column : string
$andOR : mixed
Return values
—

join()

public static join(string $table, string $matching) :
Parameters
$table : string
$matching : string
Return values
—

last()

public static last(int $rowCount = 1) :
Parameters
$rowCount = 1 : int
Return values
—

leftJoin()

public static leftJoin(string $table, string $matching) :
Parameters
$table : string
$matching : string
Return values
—

like()

public static like(mixed $column, mixed $param, string $andOR = 'AND') :
Parameters
$column : mixed
$param : mixed
$andOR = 'AND' : string
Return values
—

limit()

public static limit(int $length, int $start = 0) :
Parameters
$length : int
$start = 0 : int
Return values
—

multiLineInsert()

public static multiLineInsert(array<string|int, mixed> $columns, mixed $fraction) :
Parameters
$columns : array<string|int, mixed>
$fraction : mixed
Return values
—

notBetween()

public static notBetween(string $column, mixed $param1, mixed $param2, string $andOR = 'AND') :
Parameters
$column : string
$param1 : mixed
$param2 : mixed
$andOR = 'AND' : string
Return values
—

notExists()

public static notExists(string $query, string $andOR = 'AND') :
Parameters
$query : string
$andOR = 'AND' : string
Return values
—

notFindInSet()

public static notFindInSet(string $param1, mixed $param2, string $andOR = 'AND') :
Parameters
$param1 : string
$param2 : mixed
$andOR = 'AND' : string
Return values
—

notIn()

public static notIn(string $column, array<string|int, mixed> $params, string $andOR = 'AND') :
Parameters
$column : string
$params : array<string|int, mixed>
$andOR = 'AND' : string
Return values
—

order()

public static order(string $column, string $type = "ASC") :
Parameters
$column : string
$type = "ASC" : string
Return values
—

orHaving()

public static orHaving(string $column, string $operant, mixed $param) :
Parameters
$column : string
$operant : string
$param : mixed
Return values
—

orWhere()

public static orWhere(mixed $column, mixed $operant, mixed $param) :
Parameters
$column : mixed
$operant : mixed
$param : mixed
Return values
—

pk()

public static pk(mixed $primaryColumn) :
Parameters
$primaryColumn : mixed
Return values
—

prepend()

public static prepend(string $raw, array<string|int, mixed> $bindings = []) :
Parameters
$raw : string
$bindings = [] : array<string|int, mixed>
Return values
—

rightJoin()

public static rightJoin(string $table, string $matching) :
Parameters
$table : string
$matching : string
Return values
—

rollBack()

public static rollBack() :
Return values
—

select()

public static select(string $select = "*", mixed $overwrite) :
Parameters
$select = "*" : string
$overwrite : mixed
Return values
—

softDelete()

public static softDelete(mixed $columns) :
Parameters
$columns : mixed
Return values
—

static()

public final static static() : mixed|static
Return values
mixed|static —

subQuery()

public static subQuery(callable $callback) :
Parameters
$callback : callable
Return values
—

table()

public static table(string $table, mixed $overwrite) :
Parameters
$table : string
$overwrite : mixed
Return values
—

throw()

public final throw() : $this
Return values
$this —

transaction()

public static transaction(Closure $callback) :
Parameters
$callback : Closure
Return values
—

update()

public static update(mixed $column, mixed $param, bool $force = false) :
Parameters
$column : mixed
$param : mixed
$force = false : bool
Return values
—

upsert()

public static upsert(array<string|int, mixed> $columns) :
Parameters
$columns : array<string|int, mixed>
Return values
—

where()

public static where(mixed $column, mixed $operant, mixed $param) :
Parameters
$column : mixed
$operant : mixed
$param : mixed
Return values
—

setError()

protected final setError( $message[, string $key = '' ]) : false
Parameters
$message :
$key : string = ''
Tags
throws
ModelException
Return values
false —

Search results