7 Commits

Author SHA1 Message Date
1fe3ca9cd9 Добавлены телефоны и СНИЛС 2021-04-29 11:57:08 +03:00
7a7723a140 Update composer.json 2021-03-24 12:10:38 +03:00
5ad486f920 Добавлены методы получения почтового адреса
scope = address
2020-08-17 17:51:52 +03:00
927601d0e0 Update README.md 2020-07-24 12:27:31 +03:00
4d5db6e092 Add Packagist 2020-07-24 12:16:30 +03:00
5a22804f38 Fix Если не задан параметр о заглушке 2020-07-24 11:43:07 +03:00
7384e5aa50 Доработана работа с аватаркой пользователя
[feature] Добавлена возможность получения URL аватарки произвольных размеров.
[feature] Поддержка версий аватарок для улучшенного кэширования.
[bugfix] Исправлено определение заглушечных аватарок.
2020-06-03 13:14:41 +03:00
3 changed files with 113 additions and 26 deletions

View File

@@ -5,15 +5,7 @@ This package provides [September First](https://api.1sept.ru) integration for [O
## Installation ## Installation
Add to `composer.json`: Just execute:
```
"repositories": [{
"type": "vcs",
"url": "https://github.com/1sept/oauth2-1sept"
}],
```
Then execute:
```sh ```sh
composer require 1sept/oauth2-1sept composer require 1sept/oauth2-1sept
``` ```
@@ -21,7 +13,7 @@ composer require 1sept/oauth2-1sept
## Usage ## Usage
```php ```php
$provider = new Sept\OAuth2\Client\Provider\SeptemberFirst([ $provider = new \Sept\OAuth2\Client\Provider\SeptemberFirstProvider([
'clientId' => 'client_id', 'clientId' => 'client_id',
'clientSecret' => 'secret', 'clientSecret' => 'secret',
'redirectUri' => 'https://example.org/oauth-endpoint', 'redirectUri' => 'https://example.org/oauth-endpoint',

View File

@@ -17,7 +17,7 @@
"1sept" "1sept"
], ],
"require": { "require": {
"php": "^7.0", "php": "^7.3 || ^8",
"league/oauth2-client": "^2.0" "league/oauth2-client": "^2.0"
}, },
"require-dev": { "require-dev": {

View File

@@ -9,6 +9,8 @@ use League\OAuth2\Client\Provider\ResourceOwnerInterface;
*/ */
class SeptemberFirstUser implements ResourceOwnerInterface class SeptemberFirstUser implements ResourceOwnerInterface
{ {
const AVATAR_BASE = 'https://avatar.1sept.ru';
/** /**
* @var array Массив с данными о пользователе * @var array Массив с данными о пользователе
*/ */
@@ -142,29 +144,90 @@ class SeptemberFirstUser implements ResourceOwnerInterface
} }
/** /**
* URL картинки * URL аватарки (150x150)
* *
* @param bool $rejectEmptyAvatar Если true, то пустые аватарки (заглушки) не отдаются * @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
* @return string|null * @return string|null
*/ */
public function getAvatarUrl(bool $rejectEmptyAvatar = false): ?string public function getAvatarUrl(bool $addVersion = true): ?string
{ {
if (empty($this->data['avatar']) or ((!isset($this->data['has_avatar']) or !$this->data['has_avatar']) and $rejectEmptyAvatar)) { return $this->getField('avatar') . ($addVersion ? $this->getAvatarVersionQuery() : '');
return null;
}
return $this->getField('avatar');
} }
/** /**
* Адрес аватарки 50x50 * URL аватарки определённого размера (<img src="…" width="size" height="size">)
* *
* @param bool $rejectEmptyAvatar Если true, то пустые аватарки (заглушки) не отдаются * @param int $size Размер от 1 до 1990 ($size x $size — квадрат)
* @param int $ratioMultiplier Множитель разрешения картинки: 1 (по умолчанию), 2 или 3
* @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
* @return string|null * @return string|null
*/ */
public function getAvatar50Url(bool $rejectEmptyAvatar = false): ?string public function getAvatarSizeUrl(int $size, int $ratioMultiplier = 1, bool $addVersion = true): ?string
{ {
return $this->getAvatarUrl($rejectEmptyAvatar); $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
*/
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трока c версией аватарки (улучшает кэширование)
*
* @return string
*/
public function getAvatarVersionQuery(): string
{
$url = '';
if ($version = $this->getField('avatar_version')) {
$url .= '?v=' . $version;
}
return $url;
} }
/** /**
@@ -178,13 +241,23 @@ class SeptemberFirstUser implements ResourceOwnerInterface
} }
/** /**
* Номер телефона * Номера телефонов
*
* @return array|null
*/
public function getPhones(): ?array
{
return $this->getField('phones');
}
/**
* СНИЛС
* *
* @return string|null * @return string|null
*/ */
public function getPhone(): ?string public function getSnils(): ?string
{ {
return $this->getField('phone'); return $this->getField('passport.snils');
} }
/** /**
@@ -209,6 +282,28 @@ class SeptemberFirstUser implements ResourceOwnerInterface
return $this->getField('timezone'); return $this->getField('timezone');
} }
/**
* Почтовый адрес в строку
*
* @return string|null
* @example ул. Гагарина, д.5, кв. 21, Нижний Новгород
*/
public function getAddressInline(): ?string
{
return $this->getField('address.inline');
}
/**
* Почтовый индекс
*
* @return string|null
* @example 123456
*/
public function getAddressPostalcode(): ?string
{
return $this->getField('address.postal_code');
}
/** /**
* Элемент массива данных о пользователе * Элемент массива данных о пользователе
* *