Documentation

PA_Provider
in package

The PuzzleAnywhere Provider class. The provider taxonomy is a bit of a misnomer, as it basically just means 'a subset of puzzle groups'.

Weekly puzzles would be a provider. Monthly puzzles would be another.

Table of Contents

$auth_signup_url  : string
A public-facing URL to subscribe to a provider.
$author_name  : string
The primary provider's author name.
$authtype  : string
The provider authtype, allowing for different subscription group designations.
$description  : string
A description of the provider.
$difficulty  : int
Denotes the difficulty level on a scale from 1-100.
$end_date  : string
An end-date as to when the provider stopped posting puzzles.
$favicon  : string
The provider graphic icon as a blob.
$frequency  : mixed
Denotes the weekdays the provider is published.
$id  : int
The provider ID.
$inactive  : bool
Denotes whether the provider is inactive.
$last_updated_at  : string
The last updated at datetime for the provider.
$public  : bool
Denotes whether the provider is publicly available.
$purchasable  : bool
Denotes whether the provider requires a purchase.
$purchasable_item_id  : int
A reference to the default purchasable item for the provider.
$puzzles  : array<string|int, mixed>
A paged array of limited puzzle list data.
$rating  : string
An app-store specific rating for the provider.
$remote_favicon_url  : string
The provider's remotely hosted icon URL.
$rerun  : bool
Denotes whether the provider publishes previously published puzzles.
$short_title  : string
A truncated provider title to fit within puzzle lists.
$sort_by  : string
The string that apps and external clients should use to sort the provider.
$start_date  : string
A start-date as to when the provider started posting puzzles.
$style  : string
The provider puzzle style. [US|UK|cryptic]
$team_members  : mixed
An array of featured authors and editors that contribute to the provider.
$title  : string
The provider title.
$type  : string
Denotes the default puzzle type of the provider.
$url  : string
A `strftime` accessible URL to access provider puzzles.
$url_title  : string
A parameterized provider title.
is_active()  : bool
Whether the provider is active.
is_public()  : bool
Whether the provider is publicly visible.

Properties

$auth_signup_url

A public-facing URL to subscribe to a provider.

public string $auth_signup_url

A public-facing URL to subscribe to a provider.

$authtype

The provider authtype, allowing for different subscription group designations.

public string $authtype

The provider authtype, allowing for different subscription group designations.

$difficulty

Denotes the difficulty level on a scale from 1-100.

public int $difficulty

Denotes the difficulty level on a scale from 1-100, 100 being the hardest.

$end_date

An end-date as to when the provider stopped posting puzzles.

public string $end_date

An end-date as to when the provider stopped posting puzzles.

$frequency

Denotes the weekdays the provider is published.

public mixed $frequency

Denotes the weekdays the provider is published. If it's weekly, it's a wday int. If it's arbitrary, it's *. If it's a set schedule more than once a week, it's a CSV string of wday numbers.

$last_updated_at

The last updated at datetime for the provider.

public string $last_updated_at

The last updated at datetime for the provider.

$public

Denotes whether the provider is publicly available.

public bool $public

Denotes whether the provider is publicly available.

$purchasable

Denotes whether the provider requires a purchase.

public bool $purchasable

Denotes whether the provider requires a purchase.

$purchasable_item_id

A reference to the default purchasable item for the provider.

public int $purchasable_item_id

A reference to the default purchasable item for the provider.

$puzzles

A paged array of limited puzzle list data.

public array<string|int, mixed> $puzzles

A paged array of limited puzzle list data.

$rating

An app-store specific rating for the provider.

public string $rating

An app-store specific rating for the provider.

$remote_favicon_url

The provider's remotely hosted icon URL.

public string $remote_favicon_url

The provider's remotely hosted icon URL.

$rerun

Denotes whether the provider publishes previously published puzzles.

public bool $rerun

Denotes whether the provider publishes previously published puzzles.

$short_title

A truncated provider title to fit within puzzle lists.

public string $short_title

A truncated provider title to fit within puzzle lists.

$sort_by

The string that apps and external clients should use to sort the provider.

public string $sort_by

The string that apps and external clients should use to sort the provider.

$start_date

A start-date as to when the provider started posting puzzles.

public string $start_date

A start-date as to when the provider started posting puzzles.

$type

Denotes the default puzzle type of the provider.

public string $type

Denotes the default puzzle type of the provider. [US|UK|cryptic|variable]

$url

A `strftime` accessible URL to access provider puzzles.

public string $url

A strftime accessible URL to access provider puzzles.

Methods

is_active()

Whether the provider is active.

public is_active() : bool
Return values
bool —

Whether the provider is active.

is_public()

Whether the provider is publicly visible.

public is_public() : bool
Return values
bool —

Whether the provider is publicly visible.

Search results