DiscordPHP-MTG Documentation

CardQuery extends Query

in package

• Application

A card search against the AllPrintings build's `cards` table, joined to `sets` (for `setName`), `cardIdentifiers` and `cardLegalities` as filters need them. One row per card face per printing, as in MTGJSON.

Tags

link

Card (Set) model

since

1.0.0

Table of Contents

Constants

ALIASES  : array<string, string> = ['cmc' => 'manaValue', 'convertedManaCost' => '...

Old api.magicthegathering.io parameter names, mapped to MTGJSON's.

COLOR_COLUMNS  : array<string|int, string> = ['colors', 'colorIdentity', 'colorIndicator', '...

List columns holding colors, which accept color names.

COLORS  : array<string, string> = ['w' => 'W', 'white' => 'W', 'u' => 'U', 'blue'...

Color names and letters, mapped to MTGJSON's letters; colorless maps to an empty list.

MAX_PAGE_SIZE  : int = 100

The largest page a query may return.

PARTIAL  : array<string|int, string> = ['artist', 'asciiName', 'faceFlavorName', 'face...

Text columns matched partially rather than exactly.

REGULAR_SET_TYPES  : array<string|int, string> = ['core', 'expansion', 'masters', 'draft_innovat...

Set types whose printings are preferred when results are not ordered explicitly.

Properties

$bindings  : array<string|int, mixed>

Values bound to the conditions' placeholders, in order.

$database  : Database

$joins  : array<string, string>

Joined tables, by table name, as SQL fragments.

$limit  : int|null

Page size, or null for no limit.

$names  : array<string|int, string>

The name alternatives searched for, used to rank exact matches first.

$offset  : int

Rows to skip.

$order  : array<string|int, string>

`ORDER BY` terms.

$orderBindings  : array<string|int, mixed>

Values bound to the ordering's placeholders, in order.

$table  : string

The primary table.

$where  : array<string|int, string>

Conditions, combined with `AND`.

Methods

__construct()  : mixed

count()  : int

How many rows match, ignoring the page.

filter()  : static

Applies a set of filters and query modifiers.

get()  : array<string|int, array<string|int, mixed>>

Runs the compiled statement and decodes each row.

getBindings()  : array<string|int, mixed>

The values bound to the compiled statement's placeholders.

toSql()  : string

The compiled statement.

alternatives()  : array<string|int, array<string|int, string>>

Splits a filter value into alternatives (`|`), each a list of terms that must all hold (`,`) when `$and` is set.

colorRuns()  : mixed

Splits runs of color letters (`UR`, `wubrg`) into separate required terms (`U,R`), leaving color names alone.

column()  : array{0: ?string, 1: array}

The condition for one `cards` column, by its kind.

combine()  : array{0: ?string, 1: array}

Combines conditions with `OR` (or `AND`).

compare()  : array{0: ?string, 1: array}

Numeric match, with an optional comparison prefix per alternative.

contains()  : array{0: ?string, 1: array}

Matches a `", "`-joined list column: every term of an alternative must be in the list.

direction()  : array{0: string, 1: string}

Parses an `orderBy` value: a field, optionally prefixed with `-` or suffixed with ` desc`/` asc`.

equals()  : array{0: ?string, 1: array}

Exact, case-insensitive match.

exact()  : array{0: ?string, 1: array}

Exact match on a column stored in one case (set codes, UUIDs), so its index still applies.

flag()  : array{0: string, 1: array}

Matches a `BOOLEAN` column, where the build stores false as `0` or null.

has()  : void

Requires fields to hold a value.

identifier()  : string

Joins `cardIdentifiers` and qualifies one of its columns.

isEnglish()  : bool

Whether a language filter asks only for English.

legality()  : void

Filters on format legality.

like()  : array{0: ?string, 1: array}

Partial, case-insensitive text match against one or more columns; a value in double quotes matches exactly.

nameAndLanguage()  : void

Filters on name and the printing's language. With a non-English language, the name is searched among that language's printed names.

normalize()  : array<string|int, mixed>

Normalizes filter keys to camelCase (`color_identity` → `colorIdentity`) and drops empty values.

orderBy()  : void

Adds an `ORDER BY` term.

paginate()  : void

Applies `page` and `pageSize`.

placeholders()  : string

`?, ?, ?` for a list of values.

present()  : array{0: string, 1: array}

Requires a column to hold a value.

printingOrder()  : array<string|int, string>

The most regular printing first: English, from a regular set, not a promo, paper, not funny, newest, front face. No placeholders.

rank()  : void

The default ranking: exact name matches, shorter names, then the most regular printing, newest first.

scalar()  : string

Converts a scalar filter value to a string.

select()  : string

The select list.

sort()  : void

Orders by an explicit field.

terms()  : array<string|int, string>

The first term of each alternative, for single-valued fields.

truthy()  : bool

Reads a boolean-ish filter value.

unique()  : void

Keeps one row per card name — its most regular printing (see {@see printingOrder()}) among the rows the other filters match — so a search lists cards rather than every printing and face of them.

where()  : void

Adds a condition.