KeyboardButtonRequestUsers
extends TelegramObject
in package
This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed.
Source: https://core.telegram.org/bots/api#keyboardbuttonrequestusers
Table of Contents
Properties
- $bot : Bot|null
- $maxQuantity : int|null
- $requestId : int
- $requestName : bool|null
- $requestPhoto : bool|null
- $requestUsername : bool|null
- $userIsBot : bool|null
- $userIsPremium : bool|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
$maxQuantity read-only
public
int|null
$maxQuantity
= null
$requestId read-only
public
int
$requestId
$requestName read-only
public
bool|null
$requestName
= null
$requestPhoto read-only
public
bool|null
$requestPhoto
= null
$requestUsername read-only
public
bool|null
$requestUsername
= null
$userIsBot read-only
public
bool|null
$userIsBot
= null
$userIsPremium read-only
public
bool|null
$userIsPremium
= null
Methods
__construct()
public
__construct(int $requestId[, bool|null $userIsBot = null ][, bool|null $userIsPremium = null ][, int|null $maxQuantity = null ][, bool|null $requestName = null ][, bool|null $requestUsername = null ][, bool|null $requestPhoto = null ][, Bot|null $bot = null ]) : mixed
Parameters
- $requestId : int
- $userIsBot : bool|null = null
- $userIsPremium : bool|null = null
- $maxQuantity : int|null = null
- $requestName : bool|null = null
- $requestUsername : bool|null = null
- $requestPhoto : 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