Documentation

CollectionSpec
in package

Table of Contents

$history  : bool|null
$maxExpiry  : int|null
$name  : string
$scopeName  : string
__construct()  : mixed
build()  : CollectionSpec
Static helper to keep code more readable
export()  : array<string|int, mixed>
history()  : bool|null
Gets the history retention override setting on this collection.
import()  : CollectionSpec
maxExpiry()  : int|null
Get the max expiry of the collection
name()  : string
Get the name of the collection
scopeName()  : string
Get the name of the scope which the collection belongs to
setHistory()  : CollectionSpec
Sets the history retention override setting for this collection.
setMaxExpiry()  : CollectionSpec
Sets the max expiry of the collection
setName()  : CollectionSpec
Set the name of the collection
setScopeName()  : CollectionSpec
Sets the name of the scope which the collection belongs to

Properties

Methods

__construct()

public __construct(string $name, string $scopeName[, int|null $maxExpiry = null ][, bool $history = null ]) : mixed
Parameters
$name : string
$scopeName : string
$maxExpiry : int|null = null
$history : bool = null
Tags
since
4.1.3
Return values
mixed

build()

Static helper to keep code more readable

public static build(string $name, string $scopeName[, int|null $maxExpiry = null ][, bool $history = null ]) : CollectionSpec
Parameters
$name : string
$scopeName : string
$maxExpiry : int|null = null
$history : bool = null
Tags
since
4.1.3
Return values
CollectionSpec

history()

Gets the history retention override setting on this collection.

public history() : bool|null

Only supported for Magma buckets

Tags
since
4.1.6
Return values
bool|null

maxExpiry()

Get the max expiry of the collection

public maxExpiry() : int|null
Tags
since
4.1.3
Return values
int|null

name()

Get the name of the collection

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

collection name

scopeName()

Get the name of the scope which the collection belongs to

public scopeName() : string
Tags
since
4.1.3
Return values
string

scope name

setHistory()

Sets the history retention override setting for this collection.

public setHistory(bool $history) : CollectionSpec

Only supported for Magma buckets.

Parameters
$history : bool
Tags
since
4.1.6
Return values
CollectionSpec

setScopeName()

Sets the name of the scope which the collection belongs to

public setScopeName(string $scopeName) : CollectionSpec
Parameters
$scopeName : string

scope name

Tags
since
4.1.3
Return values
CollectionSpec

        

Search results