5 Commits
v1.3.0 ... v1.4

3 changed files with 264 additions and 54 deletions

View File

@@ -13,7 +13,7 @@
"oauth2", "oauth2",
"client", "client",
"authorization", "authorization",
"authorisation", "authorization",
"1sept" "1sept"
], ],
"require": { "require": {

View File

@@ -1,17 +1,19 @@
<?php <?php
declare(strict_types=1);
namespace Sept\OAuth2\Client\Provider; namespace Sept\OAuth2\Client\Provider;
use League\OAuth2\Client\Provider\AbstractProvider; use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Provider\GenericProvider;
use League\OAuth2\Client\Token\AccessToken; use League\OAuth2\Client\Token\AccessToken;
use League\OAuth2\Client\Tool\BearerAuthorizationTrait; use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface;
/** /**
* Провайдер данных Первого сентября * Провайдер данных Первого сентября
*/ */
class SeptemberFirstProvider extends AbstractProvider class SeptemberFirstProvider extends GenericProvider
{ {
use BearerAuthorizationTrait; use BearerAuthorizationTrait;
@@ -30,44 +32,17 @@ class SeptemberFirstProvider extends AbstractProvider
*/ */
const API_VERSION = '2.0'; const API_VERSION = '2.0';
/** public function __construct(array $options = [], array $collaborators = [])
* @inheritDoc
*/
public function getBaseAuthorizationUrl(): string
{ {
return static::AUTH_BASE.'/oauth/authorize'; $defaultOptions = [
} 'urlAuthorize' => static::AUTH_BASE.'/oauth/authorize',
'urlAccessToken' => static::API_BASE.'/oauth/access_token',
'urlResourceOwnerDetails' => static::API_BASE.'/'.static::API_VERSION.'/userinfo',
'scopes' => ['profile'],
'scopeSeparator' => ' ',
];
/** parent::__construct(array_merge($defaultOptions, $options), $collaborators);
* @inheritDoc
*/
public function getBaseAccessTokenUrl(array $params): string
{
return static::API_BASE.'/oauth/access_token';
}
/**
* @inheritDoc
*/
public function getResourceOwnerDetailsUrl(AccessToken $token): string
{
return static::API_BASE.'/'.static::API_VERSION.'/userinfo';
}
/**
* @inheritDoc
*/
public function getDefaultScopes(): array
{
return ['profile'];
}
/**
* @inheritDoc
*/
protected function getScopeSeparator(): string
{
return ' ';
} }
/** /**

View File

@@ -1,5 +1,7 @@
<?php <?php
declare(strict_types=1);
namespace Sept\OAuth2\Client\Provider; namespace Sept\OAuth2\Client\Provider;
use League\OAuth2\Client\Provider\ResourceOwnerInterface; use League\OAuth2\Client\Provider\ResourceOwnerInterface;
@@ -113,6 +115,16 @@ class SeptemberFirstUser implements ResourceOwnerInterface
return $this->getField('sex'); return $this->getField('sex');
} }
/**
* Регалии
*
* @return string|null
*/
public function getRegalia(): string|null
{
return $this->getField('regalia');
}
/** /**
* Умер * Умер
* *
@@ -148,6 +160,8 @@ class SeptemberFirstUser implements ResourceOwnerInterface
* *
* @param bool $addVersion Использовать версию аватарки для улучшенного кэширования * @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
* @return string|null * @return string|null
*
* @example https://avatar.1sept.ru/12121212-3456-7243-2134-432432144221.jpeg?v=12345
*/ */
public function getAvatarUrl(bool $addVersion = true): ?string public function getAvatarUrl(bool $addVersion = true): ?string
{ {
@@ -170,7 +184,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
} }
/** /**
* URL аватарки для экранов разных разрешений (<img srcset="…" width="size" height="size">) * URL аватарки для экранов разных разрешений (для <img srcset="…" width="size" height="size">)
* *
* @param int $size Размер от 1 до 1990 ($size x $size — квадрат) * @param int $size Размер от 1 до 1990 ($size x $size — квадрат)
* @param bool $addVersion Использовать версию аватарки для улучшенного кэширования * @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
@@ -188,6 +202,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
* *
* @param bool $useVersion Использовать версию аватарки для улучшенного кэширования * @param bool $useVersion Использовать версию аватарки для улучшенного кэширования
* @return string|null * @return string|null
* @example https://avatar.1sept.ru/12121212-3456-7243-2134-432432144221.max.jpeg?v=12345
*/ */
public function getAvatarMaxUrl(bool $addVersion = false): ?string public function getAvatarMaxUrl(bool $addVersion = false): ?string
{ {
@@ -198,7 +213,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
* Версия аватарки * Версия аватарки
* Изменение версии сигнализирует об обновлении аватарки. * Изменение версии сигнализирует об обновлении аватарки.
* *
* @return int | null * @return int|null
*/ */
public function getAvatarVersion(): ?int public function getAvatarVersion(): ?int
@@ -217,23 +232,25 @@ class SeptemberFirstUser implements ResourceOwnerInterface
} }
/** /**
* Query cтрока c версией аватарки (улучшает кэширование) * Query строка c версией аватарки (улучшает кэширование)
* *
* @return string * @return string
* @example ?v=12345;
*/ */
public function getAvatarVersionQuery(): string public function getAvatarVersionQuery(): string
{ {
$url = ''; $query = '';
if ($version = $this->getField('avatar_version')) { if ($version = $this->getField('avatar_version')) {
$url .= '?v=' . $version; $query .= '?v=' . $version;
} }
return $url; return $query;
} }
/** /**
* URL публичной страницы профиля * URL публичной страницы профиля
* *
* @return string|null * @return string|null
* @example https://vk.com/hello
*/ */
public function getProfileUrl(): ?string public function getProfileUrl(): ?string
{ {
@@ -241,13 +258,32 @@ class SeptemberFirstUser implements ResourceOwnerInterface
} }
/** /**
* Номер телефона * Номера телефонов
*
* @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 * @return string|null
* @example 123-123-123 56
*/ */
public function getPhone(): ?string public function getSnils(): ?string
{ {
return $this->getField('phone'); return $this->getField('passport.snils');
} }
/** /**
@@ -273,14 +309,37 @@ class SeptemberFirstUser implements ResourceOwnerInterface
} }
/** /**
* Почтовый адрес в строку * ID адреса
*
* @return int|null
* @example 12345
*/
public function getAddressID(): ?int
{
$id = $this->getField('address.id');
return $id ? (int) $id : null;
}
/**
* ID страны адреса
* *
* @return string|null * @return string|null
* @example ул. Гагарина, д.5, кв. 21, Нижний Новгород * @example RU
*/ */
public function getAddressInline(): ?string public function getAddressCountryID(): ?string
{ {
return $this->getField('address.inline'); return $this->getField('address.country_id');
}
/**
* ID региона страны адреса
*
* @return string|null
* @example MOW
*/
public function getAddressRegionID(): ?string
{
return $this->getField('address.region_id');
} }
/** /**
@@ -294,6 +353,182 @@ class SeptemberFirstUser implements ResourceOwnerInterface
return $this->getField('address.postal_code'); 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');
}
/** /**
* Элемент массива данных о пользователе * Элемент массива данных о пользователе
* *