Добавлено получение регалии

scope=regalia

README.md

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

composer.json

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

src/Provider/SeptemberFirstProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Sept\OAuth2\Client\Provider;
 
 use League\OAuth2\Client\Provider\AbstractProvider;

src/Provider/SeptemberFirstUser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Sept\OAuth2\Client\Provider;
 
 use League\OAuth2\Client\Provider\ResourceOwnerInterface;
@@ -113,6 +115,16 @@ class SeptemberFirstUser implements ResourceOwnerInterface
         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 Использовать версию аватарки для улучшенного кэширования
      * @return string|null
+     * 
+     * @example https://avatar.1sept.ru/12121212-3456-7243-2134-432432144221.jpeg?v=12345
      */
     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 bool $addVersion Использовать версию аватарки для улучшенного кэширования
@@ -188,6 +202,7 @@ class SeptemberFirstUser implements ResourceOwnerInterface
      *
      * @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
     {
@@ -217,23 +232,25 @@ class SeptemberFirstUser implements ResourceOwnerInterface
     }
 
     /**
-     * Query cтрока c версией аватарки (улучшает кэширование)
+     * Query строка c версией аватарки (улучшает кэширование)
      *
      * @return string
+     * @example ?v=12345;
      */
     public function getAvatarVersionQuery(): string
     {
-        $url = '';
+        $query = '';
         if ($version = $this->getField('avatar_version')) {
-            $url .= '?v=' . $version;
+            $query .= '?v=' . $version;
         }
-        return $url;
+        return $query;
     }
 
     /**
      * URL публичной страницы профиля
      *
      * @return string|null
+     * @example https://vk.com/hello
      */
     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
+     * @example 123-123-123 56
      */
-    public function getPhone(): ?string
+    public function getSnils(): ?string
     {
-        return $this->getField('phone');
+        return $this->getField('passport.snils');
     }
 
     /**
@@ -272,6 +308,227 @@ class SeptemberFirstUser implements ResourceOwnerInterface
         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');
+    }
+
     /**
      * Элемент массива данных о пользователе
      *