Checklist
in package
Checklist class (used for checking off a list of values)
Tags
Table of Contents
- $checked : array<string|int, mixed>
- Checked values
- $unchecked : array<string|int, mixed>
- Unchecked values
- __construct() : mixed
- Constructor
- check() : bool
- Check off a value, returning true if the value was found in the unchecked list and false if it was not.
- getChecked() : array<string|int, mixed>
- Get list of checked values.
- getUnchecked() : array<string|int, mixed>
- Get list of unchecked values.
- hasChecked() : bool
- Are there checked items?
- hasUnchecked() : bool
- Are there unchecked items?
- uncheck() : bool
- Uncheck a value, returning true if the value was found in the checked list and false if it was not.
Properties
$checked
Checked values
protected
array<string|int, mixed>
$checked
= []
$unchecked
Unchecked values
protected
array<string|int, mixed>
$unchecked
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $values) : mixed
Parameters
- $values : array<string|int, mixed>
-
Values for list (all begin unchecked)
Return values
mixed —check()
Check off a value, returning true if the value was found in the unchecked list and false if it was not.
public
check(mixed $value) : bool
Parameters
- $value : mixed
-
Value to check
Return values
bool —getChecked()
Get list of checked values.
public
getChecked() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUnchecked()
Get list of unchecked values.
public
getUnchecked() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasChecked()
Are there checked items?
public
hasChecked() : bool
Return values
bool —hasUnchecked()
Are there unchecked items?
public
hasUnchecked() : bool
Return values
bool —uncheck()
Uncheck a value, returning true if the value was found in the checked list and false if it was not.
public
uncheck(mixed $value) : bool
Parameters
- $value : mixed
-
Value to uncheck