DiscordPHP-MTG Documentation

DeckRepository extends AbstractRepository
in package

Application

Preconstructed decks from the MTGJSON API: the deck list (`DeckList.json`) to search, and one deck with its cards (`decks/{fileName}.json`) to fetch, hydrating {@see Deck} parts.

Constants

LIST_TTL : int = 86400: How long a downloaded deck list is reused, in seconds.

Properties

$class : mixed
$database : Database: The local MTGJSON build.
$discord : mixed
$discrim : mixed
$endpoints : mixed
$list : array{0: object[], 1: int}|null: The last deck list downloaded, and when.
$mtg_http : Http: The extended HTTP client.

Methods

__call() : mixed: This method checks if a method with the name "__Collection__{$name}" exists within the class. If it does, it calls that method with the provided arguments.
__construct() : mixed: AbstractRepository constructor.
__get() : mixed: Exposes a small allow-list of otherwise-protected properties (`discrim`, `cache`) for read access; any other key returns null.
clear() : void: Clears the repository.
create() : Part: Builds a new, empty part.
delete() : PromiseInterface<string|int, Part>: Attempts to delete a part on the Discord servers.
fetch() : PromiseInterface<string|int, Deck>: Gets a deck with its cards.
filter() : ExCollectionInterface: Runs a filter callback over the repository and returns a new collection based on the response of the callback.
find() : Part|null: Runs a filter callback over the repository and returns the first part where the callback returns `true` when given the part.
first() : Part|null: Returns the first cached part.
fresh() : PromiseInterface<string|int, Deck>: Refills a deck with its cards.
freshen() : PromiseInterface<string|int, static>: Downloads the deck list again.
get() : Part|null: Gets a part from the repository.
getDecks() : PromiseInterface<string|int, ExCollectionInterface<string|int, Deck>>: Searches the deck list. Matches are Deck List entries, without cards; {@see fetch()} one by `fileName` for its cards.
getIterator() : Traversable: Returns an iterator for the cache.
has() : bool: Checks if the array has an object.
jsonSerialize() : array<string|int, mixed>
keys() : array<string|int, int>|array<string|int, string>: Get the keys of the items.
last() : Part|null: Returns the last cached part.
offsetExists() : bool: If the repository has an offset.
offsetGet() : Part|null: Gets a part from the repository.
offsetSet() : void: Sets a part into the repository.
offsetUnset() : void: Unsets an index from the repository.
pull() : Part|mixed: Pulls a part from the repository.
pushItem() : self: Pushes a single item to the repository.
save() : PromiseInterface<string|int, Part>: Attempts to save a part to the Discord servers.
set() : mixed: Sets a part in the repository.
toArray() : array<string|int, mixed>: Converts the weak caches to array.
values() : array<string|int, mixed>: Get the values of the items.
cacheFreshen() : PromiseInterface<string|int, static>
list() : PromiseInterface<string|int, array<string|int, object>>: The deck list, downloaded at most once per {@see LIST_TTL}.

LIST_TTL

How long a downloaded deck list is reused, in seconds.


    public
        int
    LIST_TTL
    = 86400

$class


        protected
            mixed
    $class
     = \MTG\Parts\Deck::class

$database

The local MTGJSON build.


        protected
            Database
    $database

$discord


        protected
            mixed
    $discord

$discrim


        protected
            mixed
    $discrim
     = 'fileName'

$endpoints


        protected
            mixed
    $endpoints
     = ['all' => \MTG\Http\Endpoint::DECK_LIST, 'get' => \MTG\Http\Endpoint::DECK]

$list

The last deck list downloaded, and when.


        protected
            array{0: object[], 1: int}|null
    $list
     = null

$mtg_http

The extended HTTP client.


        protected
            Http
    $mtg_http

Client.

__call()

This method checks if a method with the name "__Collection__{$name}" exists within the class. If it does, it calls that method with the provided arguments.


    public
                    __call(string $name, array<string|int, mixed> $arguments) : mixed

If the method does not exist, it throws a BadMethodCallException.

Previously, this class utilized parent::method to call methods from the parent class. This was changed to use the __Collection__method naming convention to avoid conflicts

Parameters

$name : string: The name of the method being called.
$arguments : array<string|int, mixed>: The arguments passed to the method.

Return values

mixed —

The result of the called method.

__construct()

AbstractRepository constructor.


    public
                    __construct(MTG|Discord $discord[, array<string|int, mixed> $vars = [] ]) : mixed

Parameters

$discord : MTG|Discord
$vars : array<string|int, mixed> = []: An array of variables used for the endpoint.

__get()

Exposes a small allow-list of otherwise-protected properties (`discrim`, `cache`) for read access; any other key returns null.


    public
                    __get(string $key) : mixed

Parameters

$key : string: Property name.

clear()

Clears the repository.


    public
                    clear() : void

Use async $repository->cache->clear()

create()

Builds a new, empty part.


    public
                    create([array<string|int, mixed>|object $attributes = [] ][, bool $created = false ]) : Part

Parameters

$attributes : array<string|int, mixed>|object = []: The attributes for the new part.
$created : bool = false

Return values

Part —

The new part.

delete()

Attempts to delete a part on the Discord servers.


    public
                    delete(Part|string $part[, string|null $reason = null ]) : PromiseInterface<string|int, Part>

Parameters

$part : Part|string: The part to delete.
$reason : string|null = null: Reason for Audit Log (if supported).

Return values

PromiseInterface<string|int, Part>

fetch()

Gets a deck with its cards.


    public
                    fetch(string $id[, bool $fresh = false ]) : PromiseInterface<string|int, Deck>

Parameters

$id : string: The deck's fileName, e.g. AbzanSiege_KTK.
$fresh : bool = false: Whether to skip the cache.

Return values

PromiseInterface<string|int, Deck> —

Rejects with a NotFoundException for an unknown file name.

filter()

Runs a filter callback over the repository and returns a new collection based on the response of the callback.


    public
                    filter(callable $callback) : ExCollectionInterface

Parameters

$callback : callable

Return values

ExCollectionInterface

find()

Runs a filter callback over the repository and returns the first part where the callback returns `true` when given the part.


    public
                    find(callable $callback) : Part|null

Parameters

$callback : callable

Return values

Part|null —

null if no items returns true when called in the callback.

first()

Returns the first cached part.


    public
                    first() : Part|null

Return values

Part|null

fresh()

Refills a deck with its cards.


    public
                    fresh(Part $part[, array<string|int, mixed> $queryparams = [] ]) : PromiseInterface<string|int, Deck>

Parameters

$part : Part: The deck.
$queryparams : array<string|int, mixed> = []: Unused.

Return values

PromiseInterface<string|int, Deck>

freshen()

Downloads the deck list again.


    public
                    freshen([array<string|int, mixed> $queryparams = [] ]) : PromiseInterface<string|int, static>

Parameters

$queryparams : array<string|int, mixed> = []: Unused.

Return values

PromiseInterface<string|int, static>

get()

Gets a part from the repository.


    public
                    get(string $discrim, mixed $key) : Part|null

Parameters

$discrim : string
$key : mixed

Return values

Part|null

getDecks()

Searches the deck list. Matches are Deck List entries, without cards; {@see fetch()} one by `fileName` for its cards.


    public
                    getDecks([array<string|int, mixed> $params = [] ]) : PromiseInterface<string|int, ExCollectionInterface<string|int, Deck>>

Filters: name (partial), code (or setCode), type, fileName and releaseDate (exact, case-insensitive). | separates alternatives.

Parameters

$params : array<string|int, mixed> = []: Filters.

Return values

PromiseInterface<string|int, ExCollectionInterface<string|int, Deck>> —

Keyed by fileName, newest first. Rejects with \InvalidArgumentException on an unknown filter.

getIterator()

Returns an iterator for the cache.


    public
                &    getIterator() : Traversable

Return values

Traversable

has()

Checks if the array has an object.


    public
                    has(string|int ...$keys) : bool

Use async $repository->cache->has()

Parameters

$keys : string|int

Return values

bool

jsonSerialize()


    public
                    jsonSerialize([bool $assoc = true ]) : array<string|int, mixed>

Parameters

$assoc : bool = true

Return values

array<string|int, mixed>

keys()

Get the keys of the items.


    public
                    keys() : array<string|int, int>|array<string|int, string>

Return values

array<string|int, int>|array<string|int, string>

last()

Returns the last cached part.


    public
                    last() : Part|null

Return values

Part|null

offsetExists()

If the repository has an offset.


    public
                    offsetExists(string|int $offset) : bool

Use async $repository->cache->has() This method is deprecated for userland code but can still be used internally within the library.

Parameters

$offset : string|int

Return values

bool

offsetGet()

Gets a part from the repository.


    public
                    offsetGet(string|int $offset) : Part|null

Use async $repository->cacheGet() or sync $repository->get() This method is deprecated for userland code but can still be used internally within the library.

Parameters

$offset : string|int

Return values

Part|null

offsetSet()

Sets a part into the repository.


    public
                    offsetSet(string|int $offset, ?Part $value) : void

Use async $repository->cache->set()

Parameters

$offset : string|int
$value : ?Part

offsetUnset()

Unsets an index from the repository.


    public
                    offsetUnset(string|int $offset) : void

Use async $repository->cache->delete()

Parameters

$offset : string|int

pull()

Pulls a part from the repository.


    public
                    pull(string|int $key[, mixed $default = null ]) : Part|mixed

Use async $repository->cachePull()

Parameters

$key : string|int
$default : mixed = null

Return values

Part|mixed

pushItem()

Pushes a single item to the repository.


    public
                    pushItem(Part $item) : self

Use async $repository->cache->set() This method is deprecated for userland code but can still be used internally within the library.

Parameters

$item : Part

Return values

self

save()

Attempts to save a part to the Discord servers.


    public
                    save(Part $part[, string|null $reason = null ]) : PromiseInterface<string|int, Part>

Use Part->save($reason) to ensure permissions are checked.

Parameters

$part : Part: The part to save.
$reason : string|null = null: Reason for Audit Log (if supported).

Return values

PromiseInterface<string|int, Part>

set()

Sets a part in the repository.


    public
                    set(string|int $offset, Part $value) : mixed

Parameters

$offset : string|int
$value : Part

toArray()

Converts the weak caches to array.


    public
                    toArray([bool $assoc = true ]) : array<string|int, mixed>

Use jsonSerialize

Parameters

$assoc : bool = true

Return values

array<string|int, mixed>

values()

Get the values of the items.


    public
                    values() : array<string|int, mixed>

Return values

array<string|int, mixed>

cacheFreshen()


    protected
                    cacheFreshen(object $response) : PromiseInterface<string|int, static>

Parameters

$response : object

Return values

PromiseInterface<string|int, static>

list()

The deck list, downloaded at most once per {@see LIST_TTL}.


    protected
                    list() : PromiseInterface<string|int, array<string|int, object>>

Return values

PromiseInterface<string|int, array<string|int, object>>

DeckRepository extends AbstractRepository in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

LIST_TTL

Properties

$class

Tags

$database

$discord

$discrim

Tags

$endpoints

Tags

$list

$mtg_http

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

__get()

Parameters

clear()

create()

Parameters

Tags

Return values

delete()

Parameters

Tags

Return values

fetch()

Parameters

Return values

filter()

Parameters

Tags

Return values

find()

Parameters

Return values

first()

Return values

fresh()

Parameters

Return values

freshen()

Parameters

Return values

get()

Parameters

Return values

getDecks()

Parameters

Return values

getIterator()

Return values

has()

Parameters

Return values

jsonSerialize()

Parameters

Tags

Return values

keys()

Return values

last()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Return values

DeckRepository extends AbstractRepository
in package

Application