Documentation

ForeignNote
in package

FinalYes

One note from a foreign (non-LWT) Anki deck, with its fields left unmapped.

Carries the scheduling facts LWT needs to infer how well the user already knows the word, which is the whole point of importing a deck rather than reclassifying thousands of terms by hand.

Table of Contents

Properties

$fields  : array<string|int, mixed>
$interval  : int
$isNew  : bool
$suspended  : bool
$tags  : array<string|int, mixed>

Methods

__construct()  : mixed
field()  : string
Value of one field, or '' when the notetype has no such field.

Properties

$fields read-only

public array<string|int, mixed> $fields

$tags read-only

public array<string|int, mixed> $tags

Methods

__construct()

public __construct(array<string, string> $fields, array<int, string> $tags, int $interval, bool $suspended, bool $isNew) : mixed
Parameters
$fields : array<string, string>

Field name => value, as stored in Anki

$tags : array<int, string>

Anki tags on the note

$interval : int

Largest cards.ivl across the note's cards, in days. 0 for unseen cards.

$suspended : bool

Whether every card is suspended

$isNew : bool

Whether the note has never been studied

field()

Value of one field, or '' when the notetype has no such field.

public field(string $name) : string
Parameters
$name : string
Return values
string
On this page

Search results