Documentation

Role
in package

Table of Contents

$bucket  : string|null
$collection  : string|null
$name  : string
$scope  : string|null
__construct()  : mixed
bucket()  : string|null
Gets the bucket name of the role.
build()  : Role
Static helper to keep code more readable
collection()  : string|null
Gets the collection name of the role.
name()  : string
Gets the name of the role.
scope()  : string|null
Gets the scope name of the role.
setBucket()  : Role
Sets the bucket name of the role.
setCollection()  : Role
Sets the collection name of the role.
setName()  : Role
Sets the name of the role.
setScope()  : Role
Sets the scope name of the role.

Properties

$bucket

private string|null $bucket = null

$collection

private string|null $collection = null

$name

private string $name = ""

$scope

private string|null $scope = null

Methods

__construct()

public __construct() : mixed
Tags
since
4.0.0
Return values
mixed

bucket()

Gets the bucket name of the role.

public bucket() : string|null
Tags
since
4.0.0
Return values
string|null

build()

Static helper to keep code more readable

public static build() : Role
Tags
since
4.0.0
Return values
Role

collection()

Gets the collection name of the role.

public collection() : string|null
Tags
since
4.0.0
Return values
string|null

name()

Gets the name of the role.

public name() : string
Tags
since
4.0.0
Return values
string

scope()

Gets the scope name of the role.

public scope() : string|null
Tags
since
4.0.0
Return values
string|null

setBucket()

Sets the bucket name of the role.

public setBucket(string $bucket) : Role
Parameters
$bucket : string

the name of the bucket

Tags
since
4.0.0
Return values
Role

setCollection()

Sets the collection name of the role.

public setCollection(string $collection) : Role
Parameters
$collection : string

the name of the collection

Tags
since
4.0.0
Return values
Role

setName()

Sets the name of the role.

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

the name of the role

Tags
since
4.0.0
Return values
Role

setScope()

Sets the scope name of the role.

public setScope(string $scope) : Role
Parameters
$scope : string

the name of the scope

Tags
since
4.0.0
Return values
Role

        

Search results