change interface adapter methods

sinbadxiii · Sep 2, 2022 · bdf0a69 · bdf0a69
1 parent 646b899
commit bdf0a69
Show file tree

Hide file tree

Showing 14 changed files with 177 additions and 237 deletions.
diff --git a/README.md b/README.md
@@ -121,6 +121,61 @@ return $auth;
 
 Предположительно Сессии вы будете использовать в веб-приложениях после логина в личный кабинет,а Токен, например, в микро приложениях в качестве api сервисов. Но ничего вам не мешает применять или комбинировать охранников в нестандартных приложениях.
 
+## Session Guard
+
+```php
+use Sinbadxiii\PhalconAuth\Manager;
+use App\Models\User;
+use Sinbadxiii\PhalconAuth\Adapter\Model;
+use Sinbadxiii\PhalconAuth\Guard\Session;
+
+$auth = new Manager();
+
+$configAdapter = [
+    'model' => User::class,
+];
+
+$adapter = new Model($this->getSecurity(), $configAdapter);
+$guard   = new Session(
+    $adapter,
+    $this->getSession(),
+    $this->getCookies(),
+    $this->getRequest(),
+    $this->getEventsManager()
+);
+
+$auth->addGuard("web", $guard, true);
+
+return $auth;
+```
+
+- public function <b>__construct</b>(AdapterInterface $adapter, SessionManagerInterface $session,
+  Cookies $cookies, Request $request, EventsManagerInterface $eventsManager)
+- public function <b>attempt</b>(array $credentials = [], $remember = false) - попытка аутентификации
+- public function <b>user</b>() - получить аутентифицированного пользователя
+- public function <b>validate</b>(array $credentials = []) - валидация входных данных
+- public function <b>getName</b>() - получение имени сессии
+- public function <b>getRememberName</b>() - имя куки при запомнить меня
+- public function <b>login</b>(AuthenticatableInterface $user, bool $remember = false) - логин экземпляра пользователя
+- public function <b>loginById</b>($id, bool $remember = false) - логин по Id пользователя
+- public function <b>once</b>(array $credentials = []) - логин без сохранения пользователя в сессию
+- public function <b>logout</b>() - выход 
+- public function <b>getLastUserAttempted</b>() - получение последнего попытавшегося залогиниться пользователя
+- public function <b>viaRemember</b>() - проверка что пользователь был вытащен из Запомнить меня
+- public function <b>getUser</b>() - получить пользователя
+- public function <b>setRequest</b>(Request $request)
+- public function <b>setSession</b>(SessionManagerInterface $session)
+- public function <b>setCookies</b>(Cookies $cookies)
+- public function <b>getAdapter</b>() - получить адаптер поставщика
+- public function <b>setAdapter</b>(AdapterInterface $adapter) - назначить адаптера поставшика
+
+Basic
+
+- public function <b>basic</b>(string $field = 'email', array $extraConditions = []) - аутентификация через Basic Auth
+- public function <b>onceBasic</b>(string $field = 'email', array $extraConditions = []) - аутентификация через Basic Auth без сохранения в сессию
+
+## Token Guard
+
 Чтобы воспользоваться `Sinbadxiii\PhalconAuth\Guard\Token`, необходимо в качестве второго аргумента передать конфиг с названиями имя параметра запроса и поля в хранилище данных пользователей, например, поле таблицы `users` в бд:
 
 ```php
@@ -131,7 +186,6 @@ return $auth;
     ...
 ]
 ```
-
 ```php
 use Sinbadxiii\PhalconAuth\Manager;
 use App\Models\User;
@@ -186,6 +240,15 @@ https://yourapidomain/api/v2/users
 
 > Помните, что каждый ваш запрос к приложению, должен сопровождаться параметром `auth_token` с токеном доступа.
 
+- public function <b>__construct</b>(AdapterInterface $adapter, array $config, Request $request)
+- public function <b>user</b>() - аутентифицированный пользователь
+- public function <b>validate</b>(array $credentials = []) - валидация
+- public function <b>getTokenForRequest</b>() - поулчить токен из запросов (GET, POST, Headers)
+- public function <b>setRequest</b>(Request $request)
+- public function <b>getRequest</b>()
+- public function <b>getAdapter</b>()
+- public function <b>setAdapter</b>(AdapterInterface $adapter)
+
 ## Создание своего Охранника
 
 ```php 
@@ -212,7 +275,7 @@ interface GuardInterface
 
 ## Access
 
-С помощью Доступов (Access) вы можете задавать определенный доступ к тем или иным областям приложения, например в контроллер профиля пользователя разрешен доступ только аутентифицированным пользователям.
+С помощью Доступов (Access) вы можете задавать и проверять требуемый доступ к тем или иным областям приложения, например в контроллер профиля пользователя разрешен доступ только аутентифицированным пользователям.
 
 ```php 
 <?php
@@ -306,7 +369,6 @@ class Guest extends AbstractAccess
     }
 }
 ```
-
 В случае если метод `allowedIf()` вернет `true`, то пользователь сможет идти дальше, если же результат будет равен `false`, то сработает метод неудачи `redirectTo()`, и приложение перенаправит пользователя, т.к. у каждого приложение логика перенаправлений может быть разная, то вам следует создать свои классы Access `auth` и `guest`, наследовав от дефолтных классов и переопределить метод `redirectTo()`:
 ```php 
 <?php
@@ -343,7 +405,6 @@ class Guest extends GuestAccess
     }
 }
 ```
-
 Чтобы создать свой Access, можно имплементировать интерфейс `Sinbadxiii\PhalconAuth\Access\AccessInterface`:
 
 ```php 
@@ -477,9 +538,7 @@ $di->setShared('dispatcher', function () use ($di) {
     return $dispatcher;
 });
 ```
-
 Свойство `$accessList` позволяет быстро добавлять новые уровни доступа в приложении, например, чтобы добавить новый доступ `admin`, достаточно создать класс с условием и добавить его в список `$accessList`:
-
 ```php 
 <?php
 
@@ -785,6 +844,52 @@ interface RememberingInterface
     return $manager;
 ```
 
+## Адаптер поставщика `memory`
+
+Используя `setData()` можно задать массив данных с пользователями, который имеет вид:
+
+```php 
+[
+    ["username" =>"admin", "name" => "admin", 'password' => 'admin', "email" => "[email protected]"],
+    ["username" => "user", "name" => "user", 'password' => 'user', "email" => "[email protected]"],
+]
+```
+
+```php 
+$di->setShared("auth", function () {
+
+    $security = $this->getSecurity();
+
+    $data = [
+        ["auth_token" => '1', "name" => "admin", "username" => "admin", 'password' => 'admin', "email" => "[email protected]"],
+        ["auth_token" => '2',  "name" => "admin1", "username" => "admin", 'password' => 'admin1', "email" => "[email protected]"],
+    ];
+
+    $adapter     = new \Sinbadxiii\PhalconAuth\Adapter\Memory($security);
+    $adapter->setModel(App\Models\UserSimple::class);
+    $adapter->setData($data);
+
+    $configGuard = [
+        'inputKey'   => 'auth_token',
+        'storageKey' => 'auth_token',
+    ];
+
+    $guard = new \Sinbadxiii\PhalconAuth\Guard\Token(
+        $adapter,
+        $configGuard,
+        $this->getRequest()
+    );
+
+    $manager = new Manager();
+    $manager->addGuard("api", $guard, true);
+
+    return $manager;
+});
+```
+
+- public <b>setData</b>(array $data) - массив с данными
+- public <b>getData</b>() - получить массив с данными
+
 ## Адаптер поставщика `Stream`
 
 Если взять в качестве адаптера поставщиков `users` не `Sinbadxiii\PhalconAuth\Adapter\Model`, а файл `Sinbadxiii\PhalconAuth\Adapter\Stream`:
@@ -896,52 +1001,10 @@ class UserSimple implements AuthenticatableInterface
 
 - public <b>setFileSource</b>(string $pathSrcFile) - указать путь к файлу
 - public <b>getFileSource</b>() - получить путь к файлу
+- public <b>setData</b>(array $data) - массив с данными пользователей
+- public <b>getData</b>() - получить массив с данными пользователей
 
-## Адаптер поставщика `memory`
-
-Используя `setData()` можно задать массив данных с пользователями, который имеет вид:
-
-```php 
-[
-    ["username" =>"admin", "name" => "admin", 'password' => 'admin', "email" => "[email protected]"],
-    ["username" => "user", "name" => "user", 'password' => 'user', "email" => "[email protected]"],
-]
-```
-
-```php 
-$di->setShared("auth", function () {
-
-    $security = $this->getSecurity();
-
-    $data = [
-        ["auth_token" => '1', "name" => "admin", "username" => "admin", 'password' => 'admin', "email" => "[email protected]"],
-        ["auth_token" => '2',  "name" => "admin1", "username" => "admin", 'password' => 'admin1', "email" => "[email protected]"],
-    ];
-
-    $adapter     = new \Sinbadxiii\PhalconAuth\Adapter\Memory($security);
-    $adapter->setModel(App\Models\UserSimple::class);
-    $adapter->setData($data);
-
-    $configGuard = [
-        'inputKey'   => 'auth_token',
-        'storageKey' => 'auth_token',
-    ];
 
-    $guard = new \Sinbadxiii\PhalconAuth\Guard\Token(
-        $adapter,
-        $configGuard,
-        $this->getRequest()
-    );
-
-    $manager = new Manager();
-    $manager->addGuard("api", $guard, true);
-
-    return $manager;
-});
-```
-
-- public <b>setData</b>(array $data) - массив с данными
-- public <b>getData</b>() - получить массив с данными
 
 > Не рекомендуется использовать адаптеры `stream` и `memory` в реальных приложениях из-за их функциональной ограниченности и сложности управления пользователями. Это может быть полезно в прототипах приложений и для ограниченных приложений, которые не хранят пользователей в базах данных.
 
@@ -958,8 +1021,8 @@ use Sinbadxiii\PhalconAuth\AuthenticatableInterface;
 
 interface AdapterInterface
 {
-    public function retrieveByCredentials(array $credentials);
-    public function retrieveById($id);
+    public function findFirstByCredentials(array $credentials);
+    public function findFirstById($id);
     public function validateCredentials(AuthenticatableInterface $user, array $credentials): bool;
 }
 ```
@@ -979,7 +1042,7 @@ use Sinbadxiii\PhalconAuth\RememberTokenInterface;
 
 interface AdapterWithRememberTokenInterface
 {
-    public function retrieveByToken($identifier, $token, $user_agent): ?AuthenticatableInterface;
+    public function findFirstByToken($identifier, $token, $user_agent): ?AuthenticatableInterface;
     public function createRememberToken(RememberingInterface $user): RememberTokenInterface;
 }
 ```

diff --git a/src/Adapter/AdapterInterface.php b/src/Adapter/AdapterInterface.php
@@ -8,7 +8,7 @@
 
 interface AdapterInterface
 {
-    public function retrieveByCredentials(array $credentials): ?AuthenticatableInterface;
-    public function retrieveById($id): ?AuthenticatableInterface;
+    public function findFirstByCredentials(array $credentials): ?AuthenticatableInterface;
+    public function findFirstById($id): ?AuthenticatableInterface;
     public function validateCredentials(AuthenticatableInterface $user, array $credentials): bool;
 }
diff --git a/src/Adapter/AdapterWithRememberTokenInterface.php b/src/Adapter/AdapterWithRememberTokenInterface.php
@@ -10,6 +10,6 @@
 
 interface AdapterWithRememberTokenInterface
 {
-    public function retrieveByToken($identifier, $token, $user_agent): ?AuthenticatableInterface;
+    public function findFirstByToken($identifier, $token, $user_agent): ?AuthenticatableInterface;
     public function createRememberToken(RememberingInterface $user): RememberTokenInterface;
 }
diff --git a/src/Adapter/Memory.php b/src/Adapter/Memory.php
@@ -9,7 +9,6 @@
 
 use function array_column;
 use function array_search;
-use function var_dump;
 
 /**
  * Class Memory
@@ -26,7 +25,7 @@ class Memory extends AbstractAdapter
      * @param array $credentials
      * @return AuthenticatableInterface|null
      */
-    public function retrieveByCredentials(array $credentials): ?AuthenticatableInterface
+    public function findFirstByCredentials(array $credentials): ?AuthenticatableInterface
     {
         $providerStorage = $this->getProviderStorage();
 
@@ -37,7 +36,7 @@ public function retrieveByCredentials(array $credentials): ?AuthenticatableInter
      * @param $identifier
      * @return AuthenticatableInterface|null
      */
-    public function retrieveById($identifier): ?AuthenticatableInterface
+    public function findFirstById($identifier): ?AuthenticatableInterface
     {
         if (empty($this->model)) {
             throw new InvalidArgumentException("Сonfig with key 'model' is empty");

diff --git a/src/Adapter/Model.php b/src/Adapter/Model.php
@@ -32,7 +32,7 @@ protected function getProviderStorage(): mixed
      * @param array $credentials
      * @return AuthenticatableInterface|null
      */
-    public function retrieveByCredentials(array $credentials): ?AuthenticatableInterface
+    public function findFirstByCredentials(array $credentials): ?AuthenticatableInterface
     {
         $builder = Di::getDefault()->get('modelsManager')
             ->createBuilder()
@@ -53,7 +53,7 @@ public function retrieveByCredentials(array $credentials): ?AuthenticatableInter
      * @param $identifier
      * @return AuthenticatableInterface|null
      */
-    public function retrieveById($identifier): ?AuthenticatableInterface
+    public function findFirstById($identifier): ?AuthenticatableInterface
     {
         return $this->getProviderStorage()::findFirst($identifier);
     }
@@ -64,7 +64,7 @@ public function retrieveById($identifier): ?AuthenticatableInterface
      * @param $user_agent
      * @return AuthenticatableInterface|null
      */
-    public function retrieveByToken($identifier, $token, $user_agent): ?AuthenticatableInterface
+    public function findFirstByToken($identifier, $token, $user_agent): ?AuthenticatableInterface
     {
         $retrievedModel = $this->getProviderStorage()::findFirst($identifier);
 

diff --git a/src/Guard/BasicHelper.php b/src/Guard/BasicHelper.php
@@ -5,7 +5,6 @@
 namespace Sinbadxiii\PhalconAuth\Guard;
 
 use Phalcon\Http\Request;
-use function var_dump;
 
 /**
  * Trait BasicHelper

diff --git a/src/Guard/Session.php b/src/Guard/Session.php
@@ -16,7 +16,6 @@
 use Phalcon\Events\ManagerInterface as EventsManagerInterface;
 
 use function is_null;
-use function var_dump;
 
 /**
  * Class Session
@@ -83,7 +82,7 @@ public function __construct(
      */
     public function attempt(array $credentials = [], $remember = false): bool
     {
-        $this->lastUserAttempted = $this->adapter->retrieveByCredentials($credentials);
+        $this->lastUserAttempted = $this->adapter->findFirstByCredentials($credentials);
 
         if ($this->hasValidCredentials($this->lastUserAttempted, $credentials)) {
             $this->login($this->lastUserAttempted, $remember);
@@ -107,7 +106,7 @@ public function user()
         $id = $this->session->get($this->getName());
 
         if (!is_null($id)) {
-            $this->user = $this->adapter->retrieveById($id);
+            $this->user = $this->adapter->findFirstById($id);
         }
 
         if (is_null($this->user) && !is_null($recaller = $this->recaller())) {
@@ -137,7 +136,7 @@ protected function hasValidCredentials($user, array $credentials): bool
      */
     public function validate(array $credentials = []): bool
     {
-        $this->lastUserAttempted = $this->adapter->retrieveByCredentials($credentials);
+        $this->lastUserAttempted = $this->adapter->findFirstByCredentials($credentials);
 
         return $this->hasValidCredentials($this->lastUserAttempted, $credentials);
     }
@@ -148,7 +147,7 @@ public function validate(array $credentials = []): bool
      */
     protected function userFromRecaller($recaller): ?AuthenticatableInterface
     {
-        $this->viaRemember = ! is_null($user = $this->adapter->retrieveByToken(
+        $this->viaRemember = ! is_null($user = $this->adapter->findFirstByToken(
             $recaller->id(), $recaller->token(), $recaller->userAgent()
         ));
 
@@ -226,7 +225,7 @@ public function login(AuthenticatableInterface $user, bool $remember = false): v
      */
     public function loginById($id, bool $remember = false)
     {
-        if ( ! is_null($user = $this->adapter->retrieveById($id))) {
+        if ( ! is_null($user = $this->adapter->findFirstById($id))) {
             $this->login($user, $remember);
 
             return $user;