DiscordPHP-MTG Documentation

Endpoint

in package

• Application

implements EndpointInterface uses EndpointTrait

The route table for the "Magic: The Gathering Developers" API — one constant per endpoint (`cards`, `sets`, `sets/:id/booster`, `types`, `formats`, …), with `:param` placeholders bound via {@see EndpointTrait}. Same mechanics as DiscordPHP's own `Endpoint`, pointed at `api.magicthegathering.io`.

Tags

see

EndpointInterface

The contract this implements

since

0.1.0

Table of Contents

Interfaces

EndpointInterface

Constants

CARD  : mixed = self::CARDS . '/:id'

CARDS  : mixed = 'cards'

FORMATS  : mixed = 'formats'

REGEX  : string = '/:([^\/]*)/'

Regex to identify parameters in endpoints.

SET  : mixed = self::SETS . '/:id'

SETS  : mixed = 'sets'

SETS_BOOSTER  : mixed = self::SETS . '/:id/booster'

SUBTYPES  : mixed = 'subtypes'

SUPERTYPES  : mixed = 'supertypes'

TYPES  : mixed = 'types'

Properties

$args  : array<string|int, string>

Array of arguments to substitute into the endpoint.

$endpoint  : string

The string version of the endpoint, including all parameters.

$query  : array<string|int, mixed>

Array of query data to be appended to the end of the endpoint with `http_build_query`.

$vars  : array<string|int, string>

Array of placeholders to be replaced in the endpoint.

Methods

__construct()  : mixed

Creates an endpoint class.