Link Search Menu Expand Document
⭐️ 1.8k 🌞 🌚

danog\MadelineProto\Tools

Back to index

Author: Daniil Gentili daniil@daniil.it

Some tools.

Constants

  • danog\MadelineProto\Tools::ALL_MIMES:

Method list:

Methods:

testFibers(int $fiberCount = 100000): array{maxFibers: int, realMemoryMb: int, maps: ?int, maxMaps: ?int}

Test fibers.

Parameters:

  • $fiberCount: int

getMaps(): ?int

Get current number of memory-mapped regions, UNIX only.

getMaxMaps(): ?int

Get maximum number of memory-mapped regions, UNIX only. Use testFibers to get the maximum number of fibers on any platform.

stringToStream(string $str): \Amp\ByteStream\ReadableBuffer

Converts a string into an async amphp stream.

Parameters:

  • $str: string

See also:

  • \Amp\ByteStream\ReadableBuffer

genVectorHash(array<(string|int)> $longs): string

Generate MTProto vector hash.

Returns a vector hash.

Parameters:

  • $longs: array<(string|int)> IDs

randomInt(integer $modulus = 0): int

Get random integer.

Parameters:

  • $modulus: integer Modulus

random(integer $length): string

Get secure random string of specified length.

Parameters:

  • $length: integer Length

posmod(int $a, int $b): int

Positive modulo Works just like the % (modulus) operator, only returns always a postive number.

Parameters:

  • $a: int A
  • $b: int B

unpackSignedInt(string $value): int

Unpack base256 signed int.

Parameters:

  • $value: string base256 int

unpackSignedLong(string $value): int

Unpack base256 signed long.

Parameters:

  • $value: string base256 long

unpackSignedLongString((string|int|array) $value): string

Unpack base256 signed long to string.

Parameters:

  • $value: (string|int|array) base256 long

packSignedInt(integer $value): string

Convert integer to base256 signed int.

Parameters:

  • $value: integer Value to convert

packSignedLong(int $value): string

Convert integer to base256 long.

Parameters:

  • $value: int Value to convert

packUnsignedInt(int $value): string

Convert value to unsigned base256 int.

Parameters:

  • $value: int Value

packDouble(float $value): string

Convert double to binary version.

Parameters:

  • $value: float Value to convert

unpackDouble(string $value): float

Unpack binary double.

Parameters:

  • $value: string Value to unpack

isArrayOrAlike(mixed $var): bool

Check if is array or similar (traversable && countable && arrayAccess).

Parameters:

  • $var: mixed Value to check

arr(mixed ...$params): array

Create array.

Parameters:

  • ...$params: mixed Params

base64urlDecode(string $data): string

base64URL decode.

Parameters:

  • $data: string Data to decode

base64urlEncode(string $data): string

Base64URL encode.

Parameters:

  • $data: string Data to encode

rleDecode(string $string): string

null-byte RLE decode.

Parameters:

  • $string: string Data to decode

rleEncode(string $string): string

null-byte RLE encode.

Parameters:

  • $string: string Data to encode

inflateStripped(string $stripped): string

Inflate stripped photosize to full JPG payload.

Parameters:

  • $stripped: string Stripped photosize

closeConnection(string $message): void

Close connection with client, connected via web.

Parameters:

  • $message: string Message

end(array<T> $what): T

Get final element of array.

Parameters:

  • $what: array<T> Array

isAltervista(): bool

Whether this is altervista.

openFileAppendOnly(string $path): \Amp\File\File

Opens a file in append-only mode.

Parameters:

  • $path: string File path.

See also:

  • \Amp\File\File

getStreamPipe(): \Amp\ByteStream\Pipe

Obtains a pipe that can be used to upload a file from a stream.

See also:

  • \Amp\ByteStream\Pipe

openBuffered(\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $stream, ?\Amp\Cancellation $cancellation = NULL): Closure(int): ?string

Provide a buffered reader for a file, URL or amp stream.

Parameters:

  • $stream: \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream
  • $cancellation: ?\Amp\Cancellation

See also:

validateEventHandlerClass(class-string<\danog\MadelineProto\EventHandler> $class): list<\danog\MadelineProto\EventHandlerIssue>

Perform static analysis on a certain event handler class, to make sure it satisfies some performance requirements.

Parameters:

  • $class: class-string<\danog\MadelineProto\EventHandler> Class name

See also:

canConvertOgg(): bool

Whether we can convert any audio/video file to a VoIP OGG OPUS file, or the files must be preconverted using @libtgvoipbot.

canUseFFmpeg(?\Amp\Cancellation $cancellation = NULL): bool

Whether we can convert any audio/video file using ffmpeg.

Parameters:

  • $cancellation: ?\Amp\Cancellation

See also:

  • \Amp\Cancellation

rethrow(\Throwable $e): void

Rethrow exception into event loop.

Parameters:

  • $e: \Throwable

See also:

  • \Throwable

callFork(\Generator|\Amp\Future|callable $callable, mixed ...$args): \Amp\Future<T>

Fork a new green thread and execute the passed function in the background.

Parameters:

  • $callable: \Generator|\Amp\Future|callable
  • ...$args: mixed Arguments forwarded to the function when forking the thread.

See also:

  • \Generator
  • \Amp\Future

flock(string $file, integer $operation, float $polling = 0.1, ?\Amp\Cancellation $token = NULL, ?\Closure $failureCb = NULL): ($token is null ? Closure(): void : (Closure(): void | null))

Asynchronously lock a file Resolves with a callbable that MUST eventually be called in order to release the lock.

Parameters:

  • $file: string File to lock
  • $operation: integer Locking mode
  • $polling: float Polling interval
  • $token: ?\Amp\Cancellation Cancellation token
  • $failureCb: ?\Closure Failure callback, called only once if the first locking attempt fails.

See also:

  • \Amp\Cancellation
  • \Closure

sleep(float $time): void

Asynchronously sleep.

Parameters:

  • $time: float Number of seconds to sleep for

readLine(string $prompt = '', ?\Amp\Cancellation $cancel = NULL): string

Asynchronously read line.

Parameters:

  • $prompt: string Prompt
  • $cancel: ?\Amp\Cancellation

See also:

  • \Amp\Cancellation

echo(string $string): void

Asynchronously write to stdout/browser.

Parameters:

  • $string: string Message to echo

mbStrlen(string $text): int

Get Telegram UTF-8 length of string.

Parameters:

  • $text: string Text

mbSubstr(string $text, integer $offset, (null|int) $length = NULL): string

Telegram UTF-8 multibyte substring.

Parameters:

  • $text: string Text to substring
  • $offset: integer Offset
  • $length: (null|int) Length

mbStrSplit(string $text, integer $length): array<string>

Telegram UTF-8 multibyte split.

Parameters:

  • $text: string Text
  • $length: integer Length

htmlToMessageEntities(string $html): \danog\MadelineProto\TextEntities

Manually convert HTML to a message and a set of entities.

NOTE: You don’t have to use this method to send HTML messages.

This method is already called automatically by using parse_mode: “HTML” in messages.sendMessage, messages.sendMedia, et cetera…

Parameters:

  • $html: string

Return value: Object containing message and entities

See also:

markdownToMessageEntities(string $markdown): \danog\MadelineProto\TextEntities

Manually convert markdown to a message and a set of entities.

NOTE: You don’t have to use this method to send Markdown messages.

This method is already called automatically by using parse_mode: “Markdown” in messages.sendMessage, messages.sendMedia, et cetera…

Parameters:

  • $markdown: string

Return value: Object containing message and entities

See also:

entitiesToHtml(string $message, list<(\danog\MadelineProto\EventHandler\Message\Entities\MessageEntity|array{_: string, offset: int, length: int})> $entities, bool $allowTelegramTags = false): string

Convert a message and a set of entities to HTML.

Parameters:

  • $message: string
  • $entities: list<(\danog\MadelineProto\EventHandler\Message\Entities\MessageEntity|array{_: string, offset: int, length: int})>
  • $allowTelegramTags: bool Whether to allow telegram-specific tags like tg-spoiler, tg-emoji, mention links and so on…

See also:

toCamelCase(string $input): string

Convert to camelCase.

Parameters:

  • $input: string String

toSnakeCase(string $input): string

Convert to snake_case.

Parameters:

  • $input: string String

htmlEscape(string $what): string

Escape string for MadelineProto’s HTML entity converter.

Parameters:

  • $what: string String to escape

markdownEscape(string $what): string

Escape string for markdown.

Parameters:

  • $what: string String to escape

markdownCodeblockEscape(string $what): string

Escape string for markdown codeblock.

Parameters:

  • $what: string String to escape

markdownCodeEscape(string $what): string

Escape string for markdown code section.

Parameters:

  • $what: string String to escape

markdownUrlEscape(string $what): string

Escape string for URL.

Parameters:

  • $what: string String to escape

getMimeFromExtension(string $extension, string $default): string

Get mime type from file extension.

Parameters:

  • $extension: string File extension
  • $default: string Default mime type

getExtensionFromMime(string $mime): string

Get extension from mime type.

Parameters:

  • $mime: string MIME type

getExtensionFromLocation(mixed $location, string $default): string

Get extension from file location.

Parameters:

  • $location: mixed File location
  • $default: string Default extension

getMimeFromFile(string $file): string

Get mime type of file.

Parameters:

  • $file: string File

getMimeFromBuffer(string $buffer): string

Get mime type from buffer.

Parameters:

  • $buffer: string Buffer

Generated by danog/phpdoc