Page MenuHomePhabricator (Chris)
Files F624915

Entity.php
No OneTemporary
Actions

Authored By
Unknown
Size
8 KB
Referenced Files
None
Subscribers
None

Entity.php
View Options

<?php
/**
* This file is part of the TelegramBot package.
*
* (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Longman\TelegramBot\Entities;
use Longman\TelegramBot\Entities\InlineQuery\InlineEntity;
use Longman\TelegramBot\Entities\InputMedia\InputMedia;
/**
* Class Entity
*
* This is the base class for all entities.
*
* @link https://core.telegram.org/bots/api#available-types
*
* @method array getRawData() Get the raw data passed to this entity
* @method string getBotUsername() Return the bot name passed to this entity
*/
abstract class Entity implements \JsonSerializable
{
public static $fixThumbnailRename = true;
public $bot_username = '';
public $raw_data = [];
private $fields = [];
/**
* Entity constructor.
*
* @todo Get rid of the $bot_username, it shouldn't be here!
*
* @param array $data
* @param string $bot_username
*/
public function __construct(array $data, string $bot_username = '')
{
$this->bot_username = $bot_username;
$this->raw_data = $data;
$this->assignMemberVariables($data);
$this->validate();
}
/**
* Dynamically set a field.
*
* @param string $name
* @param mixed $value
* @return void
*/
public function __set(string $name, $value): void
{
$this->fields[$name] = $value;
}
/**
* Gets a dynamic field.
*
* @param string $name
* @return mixed|null
*/
public function __get(string $name)
{
return $this->fields[$name] ?? null;
}
/**
* Return the data that should be serialized for Telegram.
*
* @return array
*/
public function jsonSerialize(): array
{
return $this->fields;
}
/**
* Perform to json
*
* @return string
*/
public function toJson(): string
{
return json_encode($this);
}
/**
* Perform to string
*
* @return string
*/
public function __toString()
{
return $this->toJson();
}
/**
* Helper to set member variables
*
* @param array $data
*/
protected function assignMemberVariables(array $data): void
{
foreach ($data as $key => $value) {
$key = $this->fixThumbnailRename($key);
$this->$key = $value;
}
}
/**
* Get the list of the properties that are themselves Entities
*
* @return array
*/
protected function subEntities(): array
{
return [];
}
/**
* Perform any special entity validation
*/
protected function validate(): void
{
}
/**
* Get a property from the current Entity
*
* @param string $property
* @param mixed $default
*
* @return mixed
*/
public function getProperty(string $property, $default = null)
{
return $this->$property ?? $default;
}
/**
* Return the variable for the called getter or magically set properties dynamically.
*
* @param $method
* @param $args
*
* @return mixed|null
*/
public function __call($method, $args)
{
$method = $this->fixThumbnailRename($method);
//Convert method to snake_case (which is the name of the property)
$property_name = mb_strtolower(ltrim(preg_replace('/[A-Z]/', '_$0', substr($method, 3)), '_'));
$property_name = $this->fixThumbnailRename($property_name);
$action = substr($method, 0, 3);
if ($action === 'get') {
$property = $this->getProperty($property_name);
if ($property !== null) {
//Get all sub-Entities of the current Entity
$sub_entities = $this->subEntities();
if (isset($sub_entities[$property_name])) {
$class = $sub_entities[$property_name];
if (is_array($class)) {
return $this->makePrettyObjectArray(reset($class), $property_name);
}
return Factory::resolveEntityClass($class, $property, $this->getProperty('bot_username'));
}
return $property;
}
} elseif ($action === 'set') {
// Limit setters to specific classes.
if ($this instanceof InlineEntity || $this instanceof InputMedia || $this instanceof Keyboard || $this instanceof KeyboardButton) {
$this->$property_name = $args[0];
$this->raw_data[$property_name] = $args[0];
return $this;
}
}
return null;
}
/**
* BC for renamed thumb -> thumbnail methods and fields
*
* @todo Remove after a few versions.
*
* @param string $name
* @return string
*/
protected function fixThumbnailRename(string $name): string
{
return self::$fixThumbnailRename ? preg_replace('/([Tt])humb(nail)?/', '$1humbnail', $name, -1, $count) : $name;
/*if ($count) {
// Notify user that there are still outdated method calls?
}*/
}
/**
* Return an array of nice objects from an array of object arrays
*
* This method is used to generate pretty object arrays
* mainly for PhotoSize and Entities object arrays.
*
* @param string $class
* @param string $property_name
*
* @return array
*/
protected function makePrettyObjectArray(string $class, string $property_name): array
{
$objects = [];
$bot_username = $this->getProperty('bot_username');
$properties = array_filter($this->getProperty($property_name) ?: []);
foreach ($properties as $property) {
$objects[] = Factory::resolveEntityClass($class, $property, $bot_username);
}
return $objects;
}
/**
* Escape markdown (v1) special characters
*
* @see https://core.telegram.org/bots/api#markdown-style
*
* @param string $string
*
* @return string
*/
public static function escapeMarkdown(string $string): string
{
return str_replace(
['[', '`', '*', '_',],
['\[', '\`', '\*', '\_',],
$string
);
}
/**
* Escape markdown (v2) special characters
*
* @see https://core.telegram.org/bots/api#markdownv2-style
*
* @param string $string
*
* @return string
*/
public static function escapeMarkdownV2(string $string): string
{
return str_replace(
['_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!'],
['\_', '\*', '\[', '\]', '\(', '\)', '\~', '\`', '\>', '\#', '\+', '\-', '\=', '\|', '\{', '\}', '\.', '\!'],
$string
);
}
/**
* Try to mention the user
*
* Mention the user with the username otherwise print first and last name
* if the $escape_markdown argument is true special characters are escaped from the output
*
* @todo What about MarkdownV2?
*
* @param bool $escape_markdown
*
* @return string
*/
public function tryMention($escape_markdown = false): string
{
// TryMention only makes sense for the User and Chat entity.
if (!($this instanceof User || $this instanceof Chat)) {
return '';
}
//Try with the username first...
$name = $this->getProperty('username');
$is_username = $name !== null;
if ($name === null) {
//...otherwise try with the names.
$name = $this->getProperty('first_name');
$last_name = $this->getProperty('last_name');
if ($last_name !== null) {
$name .= ' ' . $last_name;
}
}
if ($escape_markdown) {
$name = self::escapeMarkdown($name);
}
return ($is_username ? '@' : '') . $name;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Nov 14, 10:51 PM (1 d, 8 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
122847
Default Alt Text
Entity.php (8 KB)

Event Timeline