phpbotgram

ChatInviteLink extends TelegramObject
in package

FinalYes

Represents an invite link for a chat.

Source: https://core.telegram.org/bots/api#chatinvitelink

Table of Contents

Properties

$bot  : Bot|null
$createsJoinRequest  : bool
$creator  : User
$expireDate  : DateTime|null
$inviteLink  : string
$isPrimary  : bool
$isRevoked  : bool
$memberLimit  : int|null
$name  : string|null
$pendingJoinRequestCount  : int|null
$subscriptionPeriod  : int|null
$subscriptionPrice  : int|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

$pendingJoinRequestCount read-only

public int|null $pendingJoinRequestCount = null

$subscriptionPeriod read-only

public int|null $subscriptionPeriod = null

$subscriptionPrice read-only

public int|null $subscriptionPrice = null

Methods

__construct()

public __construct(string $inviteLink, User $creator, bool $createsJoinRequest, bool $isPrimary, bool $isRevoked[, string|null $name = null ][, DateTime|null $expireDate = null ][, int|null $memberLimit = null ][, int|null $pendingJoinRequestCount = null ][, int|null $subscriptionPeriod = null ][, int|null $subscriptionPrice = null ][, Bot|null $bot = null ]) : mixed
Parameters
$inviteLink : string
$creator : User
$createsJoinRequest : bool
$isPrimary : bool
$isRevoked : bool
$name : string|null = null
$expireDate : DateTime|null = null
$memberLimit : int|null = null
$pendingJoinRequestCount : int|null = null
$subscriptionPeriod : int|null = null
$subscriptionPrice : int|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
static

withBot()

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
Return values
static
On this page

Search results