Checklist
extends TelegramObject
in package
Describes a checklist.
Source: https://core.telegram.org/bots/api#checklist
Table of Contents
Properties
- $bot : Bot|null
- $othersCanAddTasks : bool|null
- $othersCanMarkTasksAsDone : bool|null
- $tasks : array<string|int, mixed>
- $title : string
- $titleEntities : array<string|int, mixed>|null
Methods
- __construct() : mixed
- as_() : static
- Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
- withBot() : static
- Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.
Properties
$bot read-only
public
Bot|null
$bot
= null
$othersCanAddTasks read-only
public
bool|null
$othersCanAddTasks
= null
$othersCanMarkTasksAsDone read-only
public
bool|null
$othersCanMarkTasksAsDone
= null
$tasks read-only
public
array<string|int, mixed>
$tasks
$title read-only
public
string
$title
$titleEntities read-only
public
array<string|int, mixed>|null
$titleEntities
= null
Methods
__construct()
public
__construct(string $title, array<int, ChecklistTask> $tasks[, null|array<int, MessageEntity> $titleEntities = null ][, bool|null $othersCanAddTasks = null ][, bool|null $othersCanMarkTasksAsDone = null ][, Bot|null $bot = null ]) : mixed
Parameters
- $title : string
- $tasks : array<int, ChecklistTask>
- $titleEntities : null|array<int, MessageEntity> = null
- $othersCanAddTasks : bool|null = null
- $othersCanMarkTasksAsDone : bool|null = null
- $bot : Bot|null = null
as_()
Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
public
as_(Bot|null $bot) : static
IMPORTANT: behaves DIFFERENTLY from upstream — upstream mutates self.bot in place and returns self. The PHP port can't mutate readonly, so this returns a clone. Callers must reassign: $msg = $msg->as($bot).
Parameters
- $bot : Bot|null
Return values
staticwithBot()
Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.
public
withBot(Bot|null $bot) : static
list<list<KeyboardButton>>) are walked element-wise. Plain values
(scalars, DateTime, enums, InputFile etc.) pass through untouched.
Mirrors upstream pydantic model_validate(context={"bot": bot}) (aiogram
ContextController.as_/model_dump_json+model_validate).
Scope note: PHP 8.5 treats public readonly as effectively
public protected(set) readonly for clone-with — only code running with
a scope in the property's declaring class hierarchy (declaring class plus
its ancestors and descendants) can use clone($obj, ['x' => ...]) against
it. Because this method lives on BotContextController and every
TelegramObject/TelegramMethod subclass extends it, the walker's
clone($this, [...]) call legally rewrites subclass-declared readonly
slots like Message::$chat. External callers cannot use the same syntax
— they must funnel through this method.
Parameters
- $bot : Bot|null