Cleanup

.editorconfig

@@ -0,0 +1,11 @@
+# @see http://EditorConfig.org
+
+root = true
+
+[src/**]
+charset = utf-8
+end_of_line = lf
+tab_width = 4
+indent_style = space
+trim_trailing_whitespace = true
+insert_final_newline = true

src/Provider/SeptemberFirstProvider.php

@@ -6,6 +6,7 @@ namespace Sept\OAuth2\Client\Provider;
 
 use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
 use League\OAuth2\Client\Provider\GenericProvider;
+use League\OAuth2\Client\Provider\ResourceOwnerInterface;
 use League\OAuth2\Client\Token\AccessToken;
 use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
 use Psr\Http\Message\ResponseInterface;
@@ -28,35 +29,71 @@ class SeptemberFirstProvider extends GenericProvider
     const API_BASE = 'https://api.1sept.ru';
 
     /**
-     * @var string Версия API
+     * @var string[] Разрешения (scopes) по умолчанию
      */
-    const API_VERSION = '2.0';
+    const SCOPES_DEFAULT = ['profile'];
 
+    /**
+     * @var string Разделитель перечня запрашиваемых разрешений
+     */
+    const SCOPES_SEPARATOR = ' ';
+
+    /**
+     * @var string Путь авторизации
+     */
+    const AUTHORIZE_PATH = '/oauth/authorize';
+
+    /**
+     * @var string Путь получения токена
+     */
+    const ACCESS_TOKEN_PATH = '/oauth/access_token';
+
+    /**
+     * @var string Путь получения данных пользователя
+     */
+    const USERINFO_PATH = '/2.0/userinfo';
+
+    /**
+     * Undocumented function
+     *
+     * @param mixed[] $options
+     * @param object[] $collaborators
+     */
     public function __construct(array $options = [], array $collaborators = [])
     {
         $defaultOptions = [
-            'urlAuthorize' => static::AUTH_BASE.'/oauth/authorize',
+            'urlAuthorize' => static::AUTH_BASE.static::AUTHORIZE_PATH,
-            'urlAccessToken' => static::API_BASE.'/oauth/access_token',
+            'urlAccessToken' => static::API_BASE.static::ACCESS_TOKEN_PATH,
-            'urlResourceOwnerDetails' => static::API_BASE.'/'.static::API_VERSION.'/userinfo',
+            'urlResourceOwnerDetails' => static::API_BASE.static::USERINFO_PATH,
-            'scopes' => ['profile'],
+            'scopes' => static::SCOPES_DEFAULT,
-            'scopeSeparator' => ' ',
+            'scopeSeparator' => static::SCOPES_SEPARATOR,
         ];
 
         parent::__construct(array_merge($defaultOptions, $options), $collaborators);
     }
 
     /**
-     * @inheritDoc
+     * Checks a provider response for errors.
+     *
+     * @param ResponseInterface $response
+     * @param mixed[]|string $data — Parsed response data
+     * @return void
+     *
+     * @throws IdentityProviderException
      */
     protected function checkResponse(ResponseInterface $response, $data): void
     {
         if (! empty($data['error'])) {
-            throw new IdentityProviderException($data['error'].': '.$data['message'], null, $response);
+            throw new IdentityProviderException($data['error'].': '.$data['message'], 0, $response);
         }
     }
 
     /**
-     * @inheritDoc
+     * Generates a resource owner object from a successful resource owner details request.
+     *
+     * @param mixed[] $response
+     * @param AccessToken $token
+     * @return SeptemberFirstUser
      */
     protected function createResourceOwner(array $response, AccessToken $token): SeptemberFirstUser
     {

src/Provider/SeptemberFirstUser.php

@@ -14,10 +14,13 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     const AVATAR_BASE = 'https://avatar.1sept.ru';
 
     /**
-     * @var array Массив с данными о пользователе
+     * @var mixed[] Массив с данными о пользователе
      */
-    protected $data;
+    protected array $data;
 
+    /**
+     * @param mixed[] $response
+     */
     public function __construct(array $response)
     {
         $this->data = $response;
@@ -26,7 +29,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     /**
      * Массив с данными о пользователе
      *
-     * @return array
+     * @return mixed[]
      */
     public function toArray(): array
     {
@@ -58,7 +61,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     /**
      * Фамилия
      *
-     * @var string|null
+     * @return string|null
      */
     public function getLastName(): ?string
     {
@@ -68,7 +71,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     /**
      * Имя
      *
-     * @var string|null
+     * @return string|null
      */
     public function getFirstName(): ?string
     {
@@ -78,7 +81,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     /**
      * Отчество
      *
-     * @var string|null
+     * @return string|null
      */
     public function getMiddleName(): ?string
     {
@@ -158,14 +161,14 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     /**
      * URL аватарки (150x150)
      *
-     * @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
+     * @param bool $rejectDefaultAvatar
      * @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 $rejectDefaultAvatar = false): ?string
     {
-        return $this->getField('avatar') . ($addVersion ? $this->getAvatarVersionQuery() : '');
+        return ($rejectDefaultAvatar && $this->isDefaultAvatar()) ? null : $this->getField('avatar');
     }
 
     /**
@@ -200,8 +203,9 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     /**
      * URL аватарки c максимальным размером
      *
-     * @param bool $useVersion Использовать версию аватарки для улучшенного кэширования
+     * @param bool $addVersion Использовать версию аватарки для улучшенного кэширования
      * @return string|null
+     *
      * @example https://avatar.1sept.ru/12121212-3456-7243-2134-432432144221.max.jpeg?v=12345
      */
     public function getAvatarMaxUrl(bool $addVersion = false): ?string
@@ -224,9 +228,9 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     /**
      * Является ли аватарка заглушкой
      *
-     * @return boolean
+     * @return bool|null
      */
-    public function isDefaultAvatar(): bool
+    public function isDefaultAvatar(): ?bool
     {
         return (bool) $this->getField('avatar_default');
     }
@@ -260,7 +264,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     /**
      * Номера телефонов
      *
-     * @return array|null
+     * @return array<int, array<string, string>>
      * @example [
      *   [
      *     "canonical" => "+79161234567",
@@ -279,7 +283,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
      * СНИЛС
      *
      * @return string|null
-     * @example 123-123-123 56
+     * @example 123-456-789 01
      */
     public function getSnils(): ?string
     {
@@ -533,9 +537,9 @@ class SeptemberFirstUser implements ResourceOwnerInterface
      * Элемент массива данных о пользователе
      *
      * @param string $key Ключ поля (например: email или name.first — вложенность оформляется точкой)
-     * @return mixed|null
+     * @return mixed
      */
-    protected function getField(string $key)
+    protected function getField(string $key): mixed
     {
         return static::getFieldFromArray($key, $this->data);
     }
@@ -544,9 +548,10 @@ class SeptemberFirstUser implements ResourceOwnerInterface
      * Значение массива (многомерного)
      *
      * @param string $key Ключ поля (например: `email` или `name.first` — вложенность оформляется точкой)
-     * @return mixed|null
+     * @param mixed[] $array
+     * @return mixed
      */
-    public static function getFieldFromArray(string $key, ?array $array)
+    public static function getFieldFromArray(string $key, ?array $array): mixed
     {
         if (strpos($key, '.')) { // key.subKey.subSubKey
             list ($key, $subKey) = explode('.', $key, 2);