Added \TgBotLib\Objects > EncryptedPassportElement

This commit is contained in:
Netkas 2023-02-14 14:29:23 -05:00
parent bd6b40d2d2
commit 4f9644a078

View file

@ -0,0 +1,257 @@
<?php
/** @noinspection PhpMissingFieldTypeInspection */
namespace TgBotLib\Objects;
use TgBotLib\Interfaces\ObjectTypeInterface;
class EncryptedPassportElement implements ObjectTypeInterface
{
/**
* @var string
*/
private $type;
/**
* @var string|null
*/
private $data;
/**
* @var string|null
*/
private $phone_number;
/**
* @var string|null
*/
private $email;
/**
* @var PassportFile[]|null
*/
private $files;
/**
* @var PassportFile[]|null
*/
private $front_side;
/**
* @var PassportFile[]|null
*/
private $reverse_side;
/**
* @var PassportFile[]|null
*/
private $selfie;
/**
* @var PassportFile[]|null
*/
private $translation;
/**
* @var string
*/
private $hash;
/**
* Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”,
* “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”,
* “temporary_registration”, “phone_number”, “email”.
*
* @return string
*/
public function getType(): string
{
return $this->type;
}
/**
* Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for
* “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types.
* Can be decrypted and verified using the accompanying EncryptedCredentials.
*
* @see https://core.telegram.org/bots/api#encryptedcredentials
* @return string|null
*/
public function getData(): ?string
{
return $this->data;
}
/**
* Optional. User's verified phone number, available only for “phone_number” type
*
* @return string|null
*/
public function getPhoneNumber(): ?string
{
return $this->phone_number;
}
/**
* Optional. User's verified email address, available only for “email” type
*
* @return string|null
*/
public function getEmail(): ?string
{
return $this->email;
}
/**
* Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”,
* “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can
* be decrypted and verified using the accompanying EncryptedCredentials.
*
* @see https://core.telegram.org/bots/api#encryptedcredentials
* @return PassportFile[]|null
*/
public function getFiles(): ?array
{
return $this->files;
}
/**
* Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”,
* “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the
* accompanying EncryptedCredentials.
*
* @see https://core.telegram.org/bots/api#encryptedcredentials
* @return PassportFile[]|null
*/
public function getFrontSide(): ?array
{
return $this->front_side;
}
/**
* Optional. Encrypted file with the reverse side of the document, provided by the user. Available for
* “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying
* EncryptedCredentials.
*
* @see https://core.telegram.org/bots/api#encryptedcredentials
* @return PassportFile[]|null
*/
public function getReverseSide(): ?array
{
return $this->reverse_side;
}
/**
* Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for
* “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified
* using the accompanying EncryptedCredentials.
*
* @see https://core.telegram.org/bots/api#encryptedcredentials
* @return PassportFile[]|null
*/
public function getSelfie(): ?array
{
return $this->selfie;
}
/**
* Optional. Array of encrypted files with translated versions of documents provided by the user. Available if
* requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”,
* “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can
* be decrypted and verified using the accompanying EncryptedCredentials.
*
* @see https://core.telegram.org/bots/api#encryptedcredentials
* @return PassportFile[]|null
*/
public function getTranslation(): ?array
{
return $this->translation;
}
/**
* Base64-encoded element hash for using in PassportElementErrorUnspecified
*
* @see https://core.telegram.org/bots/api#passportelementerrorunspecified
* @return string
*/
public function getHash(): string
{
return $this->hash;
}
/**
* Returns an array representation of the object.
*
* @return array
*/
public function toArray(): array
{
return [
'type' => $this->type,
'data' => $this->data,
'phone_number' => $this->phone_number,
'email' => $this->email,
'files' => array_map(function (PassportFile $file)
{
return $file->toArray();
}, $this->files),
'front_side' => array_map(function (PassportFile $file)
{
return $file->toArray();
}, $this->front_side),
'reverse_side' => array_map(function (PassportFile $file)
{
return $file->toArray();
}, $this->reverse_side),
'selfie' => array_map(function (PassportFile $file)
{
return $file->toArray();
}, $this->selfie),
'translation' => array_map(function (PassportFile $file)
{
return $file->toArray();
}, $this->translation),
'hash' => $this->hash,
];
}
/**
* Constructs object from an array representation.
*
* @param array $data
* @return ObjectTypeInterface
*/
public static function fromArray(array $data): ObjectTypeInterface
{
$object = new static();
$object->type = $data['type'];
$object->data = $data['data'] ?? null;
$object->phone_number = $data['phone_number'] ?? null;
$object->email = $data['email'] ?? null;
$object->files = array_map(function (array $file)
{
return PassportFile::fromArray($file);
}, $data['files'] ?? []);
$object->front_side = array_map(function (array $file)
{
return PassportFile::fromArray($file);
}, $data['front_side'] ?? []);
$object->reverse_side = array_map(function (array $file)
{
return PassportFile::fromArray($file);
}, $data['reverse_side'] ?? []);
$object->selfie = array_map(function (array $file)
{
return PassportFile::fromArray($file);
}, $data['selfie'] ?? []);
$object->translation = array_map(function (array $file)
{
return PassportFile::fromArray($file);
}, $data['translation'] ?? []);
$object->hash = $data['hash'];
return $object;
}
}