Documentation

PA_Puzzle
in package

The PuzzleAnywhere Puzzle class. It allows for an easy way to display puzzle data.

Table of Contents

$attachments  : array<string|int, PA_Attachments>
All associated puzzle file attachments.
$author  : string|null
The puzzle author name.
$copyright  : string|null
The puzzle copyright data.
$cryptic  : bool
Denotes whether the puzzle is a cryptic.
$date  : string
The published date of the puzzle.
$diagramless  : bool
Denotes whether the puzzle is a diagramless puzzle.
$difficulty  : int
The raw difficulty score (0-100) of the puzzle.
$difficulty_score  : float|int
The humanized difficulty score of the puzzle.
$encrypted  : bool
Denotes whether the puzzle has an encrypted or currently unavailable solution. Encrypted puzzles can -- but not always -- be updated with a solution in the future.
$free  : bool
Denotes whether the puzzle is free.
$height  : int
The puzzle height by cell count.
$id  : int
The puzzle ID.
$locked  : bool
Denotes whether the puzzle is a `locked` puzzle.
$name  : string|null
The puzzle name/title.
$newsletter  : PA_Newsletter|null
The associated newsletter/email for the puzzle.
$provider_id  : int|null
The associated `PA_Provider` ID for the puzzle.
$purchasable_item  : PA_PurchasableItem
The associated purchasable item for the puzzle.
$purchasable_item_id  : PA_PurchasableItem
The associated purchasable item ID for the puzzle.
$width  : int
The puzzle width by cell count.
has_newsletter()  : bool
Denotes whether the puzzle has an associated newsletter.
human_difficulty()  : int
Returns a friendly five-star/ten-point system

Properties

$attachments

All associated puzzle file attachments.

public array<string|int, PA_Attachments> $attachments

All associated puzzle file attachments.

$diagramless

Denotes whether the puzzle is a diagramless puzzle.

public bool $diagramless

Denotes whether the puzzle is a diagramless puzzle.

$difficulty

The raw difficulty score (0-100) of the puzzle.

public int $difficulty

The difficulty score (0-100) of the puzzle.

$difficulty_score

The humanized difficulty score of the puzzle.

public float|int $difficulty_score

The humanized difficulty score of the puzzle.

$encrypted

Denotes whether the puzzle has an encrypted or currently unavailable solution. Encrypted puzzles can -- but not always -- be updated with a solution in the future.

public bool $encrypted

Denotes whether the puzzle has an encrypted or unavailable solution.

$locked

Denotes whether the puzzle is a `locked` puzzle.

public bool $locked

Locked puzzles are puzzles in which we expect to never receive solution.

Denotes whether the puzzle is a locked puzzle.

$provider_id

The associated `PA_Provider` ID for the puzzle.

public int|null $provider_id

The associated PA_Provider ID for the puzzle.

Methods

has_newsletter()

Denotes whether the puzzle has an associated newsletter.

public has_newsletter() : bool
Return values
bool —

Returns true if the puzzle has an associated newsletter.

human_difficulty()

Returns a friendly five-star/ten-point system

public human_difficulty() : int
Return values
int —

The puzzle difficulty score.

Search results