ScopeSpec
in package
Table of Contents
- $collections : array<string|int, mixed>
- $name : string
- __construct() : mixed
- build() : ScopeSpec
- Static helper to keep code more readable
- collections() : array<string|int, mixed>
- Gets the array of collections
- export() : array<string|int, mixed>
- import() : ScopeSpec
- name() : string
- Gets the name of the scope
- setCollections() : $this
- Sets the collections included in the scope
- setName() : ScopeSpec
- Sets the name of the scope
Properties
$collections
private
array<string|int, mixed>
$collections
$name
private
string
$name
Methods
__construct()
public
__construct(string $name, array<string|int, mixed> $collections) : mixed
Parameters
- $name : string
- $collections : array<string|int, mixed>
Tags
Return values
mixed —build()
Static helper to keep code more readable
public
static build(string $name, array<string|int, mixed> $collections) : ScopeSpec
Parameters
- $name : string
- $collections : array<string|int, mixed>
Return values
ScopeSpec —collections()
Gets the array of collections
public
collections() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —export()
public
static export(ScopeSpec $spec) : array<string|int, mixed>
Parameters
- $spec : ScopeSpec
Return values
array<string|int, mixed> —import()
public
static import(array<string|int, mixed> $scope) : ScopeSpec
Parameters
- $scope : array<string|int, mixed>
Return values
ScopeSpec —name()
Gets the name of the scope
public
name() : string
Tags
Return values
string —scope name
setCollections()
Sets the collections included in the scope
public
setCollections(array<string|int, mixed> $collections) : $this
Parameters
- $collections : array<string|int, mixed>
Tags
Return values
$this —setName()
Sets the name of the scope
public
setName(string $name) : ScopeSpec
Parameters
- $name : string
-
scope name