danog/tg-dialog-id
1
0
Fork 0
mirror of https://github.com/danog/tg-dialog-id.git synced 2024-11-30 04:39:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Mark entire API as immutable and pure

Browse Source
This commit is contained in:
Daniil Gentili 2024-05-10 14:25:19 +02:00
parent 78396d7856
commit 1bc37a5e59
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/DialogId.php
View File

@ -7,6 +7,8 @@ use AssertionError;
/** /**
* Represents the type of a bot API dialog ID. * Represents the type of a bot API dialog ID.
* *
* @psalm-immutable
*
* @api * @api
*/ */
enum DialogId enum DialogId
@ -39,6 +41,8 @@ enum DialogId
/** /**
* Get the type of a dialog using just its bot API dialog ID. * Get the type of a dialog using just its bot API dialog ID.
* *
* @psalm-pure
*
* @param integer $id Bot API ID. * @param integer $id Bot API ID.
*/ */
public static function getType(int $id): self public static function getType(int $id): self
@ -61,6 +65,8 @@ enum DialogId
/** /**
* Checks whether the provided bot API ID is a supergroup or channel ID. * Checks whether the provided bot API ID is a supergroup or channel ID.
*
* @psalm-pure
*/ */
public static function isSupergroupOrChannel(int $id): bool public static function isSupergroupOrChannel(int $id): bool
{ {
@ -69,6 +75,8 @@ enum DialogId
/** /**
* Checks whether the provided bot API ID is a chat ID. * Checks whether the provided bot API ID is a chat ID.
*
* @psalm-pure
*/ */
public static function isChat(int $id): bool public static function isChat(int $id): bool
{ {
@ -76,6 +84,8 @@ enum DialogId
} }
/** /**
* Checks whether the provided bot API ID is a user ID. * Checks whether the provided bot API ID is a user ID.
*
* @psalm-pure
*/ */
public static function isUser(int $id): bool public static function isUser(int $id): bool
{ {
@ -83,6 +93,8 @@ enum DialogId
} }
/** /**
* Checks whether the provided bot API ID is a secret chat ID. * Checks whether the provided bot API ID is a secret chat ID.
*
* @psalm-pure
*/ */
public static function isSecretChat(int $id): bool public static function isSecretChat(int $id): bool
{ {
@ -92,6 +104,8 @@ enum DialogId
/** /**
* Convert MTProto secret chat ID to bot API secret chat ID. * Convert MTProto secret chat ID to bot API secret chat ID.
* *
* @psalm-pure
*
* @param int $id MTProto secret chat ID * @param int $id MTProto secret chat ID
* *
* @return int Bot API secret chat ID * @return int Bot API secret chat ID
@ -108,6 +122,8 @@ enum DialogId
/** /**
* Convert bot API secret chat ID to MTProto secret chat ID. * Convert bot API secret chat ID to MTProto secret chat ID.
* *
* @psalm-pure
*
* @param int $id Bot API secret chat ID * @param int $id Bot API secret chat ID
* *
* @return int MTProto secret chat ID * @return int MTProto secret chat ID
@ -124,6 +140,8 @@ enum DialogId
/** /**
* Convert MTProto channel ID to bot API channel ID. * Convert MTProto channel ID to bot API channel ID.
* *
* @psalm-pure
*
* @param int $id MTProto channel ID * @param int $id MTProto channel ID
*/ */
public static function fromSupergroupOrChannelId(int $id): int public static function fromSupergroupOrChannelId(int $id): int
@ -138,6 +156,8 @@ enum DialogId
/** /**
* Convert bot API channel ID to MTProto channel ID. * Convert bot API channel ID to MTProto channel ID.
* *
* @psalm-pure
*
* @param int $id Bot API channel ID * @param int $id Bot API channel ID
*/ */
public static function toSupergroupOrChannelId(int $id): int public static function toSupergroupOrChannelId(int $id): int
@ -152,6 +172,8 @@ enum DialogId
/** /**
* Convert MTProto chat ID to bot API chat ID. * Convert MTProto chat ID to bot API chat ID.
* *
* @psalm-pure
*
* @param int $id MTProto chat ID * @param int $id MTProto chat ID
*/ */
public static function fromChatId(int $id): int public static function fromChatId(int $id): int
@ -166,6 +188,8 @@ enum DialogId
/** /**
* Convert bot API chat ID to MTProto chat ID. * Convert bot API chat ID to MTProto chat ID.
* *
* @psalm-pure
*
* @param int $id Bot API chat ID * @param int $id Bot API chat ID
*/ */
public static function toChatId(int $id): int public static function toChatId(int $id): int
@ -180,6 +204,8 @@ enum DialogId
/** /**
* Convert MTProto user ID to bot API user ID. * Convert MTProto user ID to bot API user ID.
* *
* @psalm-pure
*
* @param int $id MTProto user ID * @param int $id MTProto user ID
*/ */
public static function fromUserId(int $id): int public static function fromUserId(int $id): int
@ -193,6 +219,8 @@ enum DialogId
/** /**
* Convert bot API user ID to MTProto user ID. * Convert bot API user ID to MTProto user ID.
* *
* @psalm-pure
*
* @param int $id Bot API user ID * @param int $id Bot API user ID
*/ */
public static function toUserId(int $id): int public static function toUserId(int $id): int