EncryptedPassportElement
extends TelegramObject
in package
Describes documents or other Telegram Passport elements shared with the bot by the user.
Source: https://core.telegram.org/bots/api#encryptedpassportelement
Table of Contents
Properties
- $bot : Bot|null
- $data : string|null
- $email : string|null
- $files : array<string|int, mixed>|null
- $frontSide : PassportFile|null
- $hash : string
- $phoneNumber : string|null
- $reverseSide : PassportFile|null
- $selfie : PassportFile|null
- $translation : array<string|int, mixed>|null
- $type : string
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
$data read-only
public
string|null
$data
= null
$email read-only
public
string|null
$email
= null
$files read-only
public
array<string|int, mixed>|null
$files
= null
$frontSide read-only
public
PassportFile|null
$frontSide
= null
$hash read-only
public
string
$hash
$phoneNumber read-only
public
string|null
$phoneNumber
= null
$reverseSide read-only
public
PassportFile|null
$reverseSide
= null
$selfie read-only
public
PassportFile|null
$selfie
= null
$translation read-only
public
array<string|int, mixed>|null
$translation
= null
$type read-only
public
string
$type
Methods
__construct()
public
__construct(string $type, string $hash[, string|null $data = null ][, string|null $phoneNumber = null ][, string|null $email = null ][, null|array<int, PassportFile> $files = null ][, PassportFile|null $frontSide = null ][, PassportFile|null $reverseSide = null ][, PassportFile|null $selfie = null ][, null|array<int, PassportFile> $translation = null ][, Bot|null $bot = null ]) : mixed
Parameters
- $type : string
- $hash : string
- $data : string|null = null
- $phoneNumber : string|null = null
- $email : string|null = null
- $files : null|array<int, PassportFile> = null
- $frontSide : PassportFile|null = null
- $reverseSide : PassportFile|null = null
- $selfie : PassportFile|null = null
- $translation : null|array<int, PassportFile> = 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