Documentation

Group
in package

Table of Contents

$description  : string|null
$ldapGroupReference  : string|null
$name  : string
$roles  : array<string|int, mixed>|null
__construct()  : mixed
build()  : Group
Static helper to keep code more readable
description()  : string|null
Gets the description of the group.
ldapGroupReference()  : string|null
Gets the ldap reference of the group.
name()  : string
Gets the name of the group.
roles()  : array<string|int, mixed>|null
Gets the roles for the group.
setDescription()  : Group
Sets the description of the group.
setLdapGroupReference()  : Group
Sets the ldap reference of the group.
setName()  : Group
Sets the name of the group.
setRoles()  : Group
Sets the roles for the group.

Properties

$description

private string|null $description = null

$ldapGroupReference

private string|null $ldapGroupReference = null

$name

private string $name = ""

$roles

private array<string|int, mixed>|null $roles = null

Methods

__construct()

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

build()

Static helper to keep code more readable

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

description()

Gets the description of the group.

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

ldapGroupReference()

Gets the ldap reference of the group.

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

name()

Gets the name of the group.

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

roles()

Gets the roles for the group.

public roles() : array<string|int, mixed>|null
Tags
see
Role
since
4.0.0
Return values
array<string|int, mixed>|null

setDescription()

Sets the description of the group.

public setDescription(string $description) : Group
Parameters
$description : string

the description of the group

Tags
since
4.0.0
Return values
Group

setLdapGroupReference()

Sets the ldap reference of the group.

public setLdapGroupReference(string $reference) : Group
Parameters
$reference : string

the ldap reference of the group

Tags
since
4.0.0
Return values
Group

setName()

Sets the name of the group.

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

the name of the group

Tags
since
4.0.0
Return values
Group

setRoles()

Sets the roles for the group.

public setRoles(array<string|int, mixed> $roles) : Group
Parameters
$roles : array<string|int, mixed>

the roles for the group

Tags
since
4.0.0
Return values
Group

        

Search results