mirror of
https://github.com/1sept/oauth2-1sept.git
synced 2024-05-30 17:38:52 +03:00
559 lines
14 KiB
PHP
Executable File
559 lines
14 KiB
PHP
Executable File
<?php
|
||
|
||
declare(strict_types=1);
|
||
|
||
namespace Sept\OAuth2\Client\Provider;
|
||
|
||
use League\OAuth2\Client\Provider\ResourceOwnerInterface;
|
||
|
||
/**
|
||
* Пользователь Первого сентября
|
||
*/
|
||
class SeptemberFirstUser implements ResourceOwnerInterface
|
||
{
|
||
const AVATAR_BASE = 'https://avatar.1sept.ru';
|
||
|
||
/**
|
||
* @var array Массив с данными о пользователе
|
||
*/
|
||
protected $data;
|
||
|
||
public function __construct(array $response)
|
||
{
|
||
$this->data = $response;
|
||
}
|
||
|
||
/**
|
||
* Массив с данными о пользователе
|
||
*
|
||
* @return array
|
||
*/
|
||
public function toArray(): array
|
||
{
|
||
return $this->data;
|
||
}
|
||
|
||
/**
|
||
* ID пользователя (UUID)
|
||
*
|
||
* @return string
|
||
* @example '1cc1632f-2349-4d00-8302-5c4c188469cc'
|
||
*/
|
||
public function getId(): string
|
||
{
|
||
return $this->getField('id');
|
||
}
|
||
|
||
/**
|
||
* Устаревшие ID пользователя (UUID)
|
||
* (остаются после объединения уч. записей)
|
||
*
|
||
* @return array<string>
|
||
*/
|
||
public function getIdAlt(): array
|
||
{
|
||
return $this->getField('id_alt') ?? [];
|
||
}
|
||
|
||
/**
|
||
* Фамилия
|
||
*
|
||
* @var string|null
|
||
*/
|
||
public function getLastName(): ?string
|
||
{
|
||
return $this->getField('personal_name.surname');
|
||
}
|
||
|
||
/**
|
||
* Имя
|
||
*
|
||
* @var string|null
|
||
*/
|
||
public function getFirstName(): ?string
|
||
{
|
||
return $this->getField('personal_name.name');
|
||
}
|
||
|
||
/**
|
||
* Отчество
|
||
*
|
||
* @var string|null
|
||
*/
|
||
public function getMiddleName(): ?string
|
||
{
|
||
return $this->getField('personal_name.patronymic');
|
||
}
|
||
|
||
/**
|
||
* Девичья фамилия
|
||
*
|
||
* @return string|null
|
||
*/
|
||
public function getMaidenName(): ?string
|
||
{
|
||
return null;
|
||
}
|
||
|
||
/**
|
||
* Отображаемое имя
|
||
*
|
||
* @return string|null
|
||
*/
|
||
public function getDisplayName(): ?string
|
||
{
|
||
return $this->getField('display_name');
|
||
}
|
||
|
||
/**
|
||
* Пол
|
||
*
|
||
* @return 'male'|'female'|null
|
||
*/
|
||
public function getSex(): ?string
|
||
{
|
||
return $this->getField('sex');
|
||
}
|
||
|
||
/**
|
||
* Регалии
|
||
*
|
||
* @return string|null
|
||
*/
|
||
public function getRegalia(): string|null
|
||
{
|
||
return $this->getField('regalia');
|
||
}
|
||
|
||
/**
|
||
* Умер
|
||
*
|
||
* @return bool|null
|
||
*/
|
||
public function isDied(): ?bool
|
||
{
|
||
return $this->getField('is_died');
|
||
}
|
||
|
||
/**
|
||
* Эл. адрес
|
||
*
|
||
* @return string|null
|
||
*/
|
||
public function getEmail(): ?string
|
||
{
|
||
return $this->getField('email');
|
||
}
|
||
|
||
/**
|
||
* Дата рождения
|
||
*
|
||
* @return \DateTime|null
|
||
*/
|
||
public function getBirthday(): ?\DateTime
|
||
{
|
||
return !empty($this->data['birthday']) ? new \DateTime($this->data['birthday']) : null;
|
||
}
|
||
|
||
/**
|
||
* URL аватарки (150x150)
|
||
*
|
||
* @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
|
||
* @return string|null
|
||
*
|
||
* @example https://avatar.1sept.ru/12121212-3456-7243-2134-432432144221.jpeg?v=12345
|
||
*/
|
||
public function getAvatarUrl(bool $addVersion = true): ?string
|
||
{
|
||
return $this->getField('avatar') . ($addVersion ? $this->getAvatarVersionQuery() : '');
|
||
}
|
||
|
||
/**
|
||
* URL аватарки определённого размера (<img src="…" width="size" height="size">)
|
||
*
|
||
* @param int $size Размер от 1 до 1990 ($size x $size — квадрат)
|
||
* @param int $ratioMultiplier Множитель разрешения картинки: 1 (по умолчанию), 2 или 3
|
||
* @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
|
||
* @return string|null
|
||
*/
|
||
public function getAvatarSizeUrl(int $size, int $ratioMultiplier = 1, bool $addVersion = true): ?string
|
||
{
|
||
$ratio = ($ratioMultiplier > 1) ? '@' . $ratioMultiplier . 'x' : '';
|
||
$url = static::AVATAR_BASE .'/'. $this->getId() . ($size ? '.' : '') . $size . $ratio . '.jpeg';
|
||
return $url . ($addVersion ? $this->getAvatarVersionQuery() : '');
|
||
}
|
||
|
||
/**
|
||
* URL аватарки для экранов разных разрешений (для <img srcset="…" width="size" height="size">)
|
||
*
|
||
* @param int $size Размер от 1 до 1990 ($size x $size — квадрат)
|
||
* @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
|
||
* @return string
|
||
*/
|
||
public function getAvatarSetSizeUrl(int $size, bool $addVersion = true): string
|
||
{
|
||
return $this->getAvatarSizeUrl($size, 1, $addVersion) . ' 1x, '
|
||
. $this->getAvatarSizeUrl($size, 2, $addVersion) . ' 2x, '
|
||
. $this->getAvatarSizeUrl($size, 3, $addVersion) . ' 3x';
|
||
}
|
||
|
||
/**
|
||
* URL аватарки c максимальным размером
|
||
*
|
||
* @param bool $useVersion Использовать версию аватарки для улучшенного кэширования
|
||
* @return string|null
|
||
* @example https://avatar.1sept.ru/12121212-3456-7243-2134-432432144221.max.jpeg?v=12345
|
||
*/
|
||
public function getAvatarMaxUrl(bool $addVersion = false): ?string
|
||
{
|
||
return $this->getField('avatar_max') . ($addVersion ? $this->getAvatarVersionQuery() : '');
|
||
}
|
||
|
||
/**
|
||
* Версия аватарки
|
||
* Изменение версии сигнализирует об обновлении аватарки.
|
||
*
|
||
* @return int|null
|
||
*/
|
||
|
||
public function getAvatarVersion(): ?int
|
||
{
|
||
return $this->getField('avatar_version');
|
||
}
|
||
|
||
/**
|
||
* Является ли аватарка заглушкой
|
||
*
|
||
* @return boolean
|
||
*/
|
||
public function isDefaultAvatar(): bool
|
||
{
|
||
return (bool) $this->getField('avatar_default');
|
||
}
|
||
|
||
/**
|
||
* Query строка c версией аватарки (улучшает кэширование)
|
||
*
|
||
* @return string
|
||
* @example ?v=12345;
|
||
*/
|
||
public function getAvatarVersionQuery(): string
|
||
{
|
||
$query = '';
|
||
if ($version = $this->getField('avatar_version')) {
|
||
$query .= '?v=' . $version;
|
||
}
|
||
return $query;
|
||
}
|
||
|
||
/**
|
||
* URL публичной страницы профиля
|
||
*
|
||
* @return string|null
|
||
* @example https://vk.com/hello
|
||
*/
|
||
public function getProfileUrl(): ?string
|
||
{
|
||
return $this->getField('link');
|
||
}
|
||
|
||
/**
|
||
* Номера телефонов
|
||
*
|
||
* @return array|null
|
||
* @example [
|
||
* [
|
||
* "canonical" => "+79161234567",
|
||
* "number" => "+7 (916) 123-45-67",
|
||
* "type" => "mobile"
|
||
* ],
|
||
* …
|
||
* ]
|
||
*/
|
||
public function getPhones(): ?array
|
||
{
|
||
return $this->getField('phones');
|
||
}
|
||
|
||
/**
|
||
* СНИЛС
|
||
*
|
||
* @return string|null
|
||
* @example 123-123-123 56
|
||
*/
|
||
public function getSnils(): ?string
|
||
{
|
||
return $this->getField('passport.snils');
|
||
}
|
||
|
||
/**
|
||
* Локаль (языковые и др. настройки)
|
||
*
|
||
* @return string|null
|
||
* @example ru_RU
|
||
*/
|
||
public function getLocale(): ?string
|
||
{
|
||
return $this->getField('locale');
|
||
}
|
||
|
||
/**
|
||
* Имя временной зоны
|
||
*
|
||
* @return string|null
|
||
* @example Europe/Moscow
|
||
*/
|
||
public function getTimezone(): ?string
|
||
{
|
||
return $this->getField('timezone');
|
||
}
|
||
|
||
/**
|
||
* ID адреса
|
||
*
|
||
* @return int|null
|
||
* @example 12345
|
||
*/
|
||
public function getAddressID(): ?int
|
||
{
|
||
$id = $this->getField('address.id');
|
||
return $id ? (int) $id : null;
|
||
}
|
||
|
||
/**
|
||
* ID страны адреса
|
||
*
|
||
* @return string|null
|
||
* @example RU
|
||
*/
|
||
public function getAddressCountryID(): ?string
|
||
{
|
||
return $this->getField('address.country_id');
|
||
}
|
||
|
||
/**
|
||
* ID региона страны адреса
|
||
*
|
||
* @return string|null
|
||
* @example MOW
|
||
*/
|
||
public function getAddressRegionID(): ?string
|
||
{
|
||
return $this->getField('address.region_id');
|
||
}
|
||
|
||
/**
|
||
* Почтовый индекс
|
||
*
|
||
* @return string|null
|
||
* @example 123456
|
||
*/
|
||
public function getAddressPostalcode(): ?string
|
||
{
|
||
return $this->getField('address.postal_code');
|
||
}
|
||
|
||
/**
|
||
* Район
|
||
*
|
||
* @return string|null
|
||
* @example Октябрьский район
|
||
*/
|
||
public function getAddressArea(): ?string
|
||
{
|
||
return $this->getField('address.area');
|
||
}
|
||
|
||
/**
|
||
* Город
|
||
*
|
||
* @return string|null
|
||
* @example Муром
|
||
*/
|
||
public function getAddressCity(): ?string
|
||
{
|
||
return $this->getField('address.city');
|
||
}
|
||
|
||
/**
|
||
* Улица
|
||
*
|
||
* @return string|null
|
||
* @example ул. Профсоюзная
|
||
*/
|
||
public function getAddressStreet(): ?string
|
||
{
|
||
return $this->getField('address.street');
|
||
}
|
||
|
||
/**
|
||
* Здание, сооружение, дом, владение, объект незавершенного строительства
|
||
*
|
||
* @return string|null
|
||
* @example д. 5
|
||
*/
|
||
public function getAddressHouse(): ?string
|
||
{
|
||
return $this->getField('address.house');
|
||
}
|
||
|
||
/**
|
||
* Строение
|
||
*
|
||
* @return string|null
|
||
* @example стр. 5
|
||
*/
|
||
public function getAddressBuilding(): ?string
|
||
{
|
||
return $this->getField('address.building');
|
||
}
|
||
|
||
/**
|
||
* Помещение в пределах здания, сооружения (Квартира, офис, помещение и т.д.)
|
||
*
|
||
* @return string|null
|
||
* @example кв. 1б | оф. 13 | помещ. 17
|
||
*/
|
||
public function getAddressFlat(): ?string
|
||
{
|
||
return $this->getField('address.flat');
|
||
}
|
||
|
||
/**
|
||
* До востребования
|
||
*
|
||
* @return boolean
|
||
* @example true
|
||
*/
|
||
public function isAddressGeneralDelivery(): bool
|
||
{
|
||
return (bool) $this->getField('address.general_delivery');
|
||
}
|
||
|
||
/**
|
||
* Абонентский ящик (А/Я)
|
||
*
|
||
* @return string|null
|
||
* @example а/я 123
|
||
*/
|
||
public function getAddressPostalBox(): ?string
|
||
{
|
||
return $this->getField('address.postal_box');
|
||
}
|
||
|
||
/**
|
||
* Организация по адресу
|
||
*
|
||
* @return string|null
|
||
* @example Школа №5
|
||
*/
|
||
public function getAddressOrganization(): ?string
|
||
{
|
||
return $this->getField('address.organization');
|
||
}
|
||
|
||
/**
|
||
* Почтовый адрес в строку (без индекса)
|
||
*
|
||
* @return string|null
|
||
* @example ул. Гагарина, д.5, кв. 21, Нижний Новгород
|
||
*/
|
||
public function getAddressInline(): ?string
|
||
{
|
||
return $this->getField('address.inline');
|
||
}
|
||
|
||
/**
|
||
* ID страны (анкета)
|
||
*
|
||
* @return string|null
|
||
* @example RU
|
||
*/
|
||
public function getLocationCountryID(): ?string
|
||
{
|
||
return $this->getField('location.country_id');
|
||
}
|
||
|
||
/**
|
||
* Название страны (анкета)
|
||
*
|
||
* @return string|null
|
||
* @example Россия
|
||
*/
|
||
public function getLocationCountryName(): ?string
|
||
{
|
||
return $this->getField('location.country_name');
|
||
}
|
||
|
||
/**
|
||
* Название страны по английски (анкета)
|
||
*
|
||
* @return string|null
|
||
* @example Russia
|
||
*/
|
||
public function getLocationCountryNameEnglish(): ?string
|
||
{
|
||
return $this->getField('location.country_name_eng');
|
||
}
|
||
|
||
/**
|
||
* ID региона страны (анкета)
|
||
*
|
||
* @return string|null
|
||
* @example MOW
|
||
*/
|
||
public function getLocationRegionID(): ?string
|
||
{
|
||
return $this->getField('location.region_id');
|
||
}
|
||
|
||
/**
|
||
* Название региона страны (анкета)
|
||
*
|
||
* @return string|null
|
||
* @example Москва
|
||
*/
|
||
public function getLocationRegionName(): ?string
|
||
{
|
||
return $this->getField('location.region_name');
|
||
}
|
||
|
||
/**
|
||
* Название региона страны по английски (анкета)
|
||
*
|
||
* @return string|null
|
||
* @example Moscow
|
||
*/
|
||
public function getLocationRegionNameEnglish(): ?string
|
||
{
|
||
return $this->getField('location.region_name_eng');
|
||
}
|
||
|
||
/**
|
||
* Элемент массива данных о пользователе
|
||
*
|
||
* @param string $key Ключ поля (например: email или name.first — вложенность оформляется точкой)
|
||
* @return mixed|null
|
||
*/
|
||
protected function getField(string $key)
|
||
{
|
||
return static::getFieldFromArray($key, $this->data);
|
||
}
|
||
|
||
/**
|
||
* Значение массива (многомерного)
|
||
*
|
||
* @param string $key Ключ поля (например: `email` или `name.first` — вложенность оформляется точкой)
|
||
* @return mixed|null
|
||
*/
|
||
public static function getFieldFromArray(string $key, ?array $array)
|
||
{
|
||
if (strpos($key, '.')) { // key.subKey.subSubKey
|
||
list ($key, $subKey) = explode('.', $key, 2);
|
||
return isset($array[$key]) ? static::getFieldFromArray($subKey, $array[$key]) : null;
|
||
}
|
||
|
||
return isset($array[$key]) ? $array[$key] : null;
|
||
}
|
||
}
|