ScopeEntity
in package
implements
ScopeEntityInterface
Uses
EntityTrait, ScopeTrait
OAuth2 scope entity implementation.
Tags
Interfaces, Classes, Traits and Enums
- ScopeEntityInterface
Table of Contents
- $description : string
- Scope description
- $hidden : bool
- Whether the scope is hidden from the scope list
- $ilsNeeded : bool
- Whether the scope requires data from an ILS account
- __construct() : mixed
- Constructor
- getDescription() : string
- Get description
- getHidden() : bool
- Get hidden flag
- getILSNeeded() : bool
- Get ILS needed flag
- setDescription() : void
- Set description
- setHidden() : void
- Set hidden flag
- setILSNeeded() : void
- Set ILS needed flag
Properties
$description
Scope description
protected
string
$description
$hidden
Whether the scope is hidden from the scope list
protected
bool
$hidden
$ilsNeeded
Whether the scope requires data from an ILS account
protected
bool
$ilsNeeded
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $config) : mixed
Parameters
- $config : array<string|int, mixed>
-
Scope configuration
Return values
mixed —getDescription()
Get description
public
getDescription() : string
Return values
string —getHidden()
Get hidden flag
public
getHidden() : bool
Return values
bool —getILSNeeded()
Get ILS needed flag
public
getILSNeeded() : bool
Return values
bool —setDescription()
Set description
public
setDescription(string $description) : void
Parameters
- $description : string
-
Description
Return values
void —setHidden()
Set hidden flag
public
setHidden(bool $value) : void
Parameters
- $value : bool
-
New value
Return values
void —setILSNeeded()
Set ILS needed flag
public
setILSNeeded(bool $value) : void
Parameters
- $value : bool
-
New value