Merge pull request #3 from byjg/2.0

3.0

Author: byjg

.travis.yml

@@ -1,5 +1,6 @@
 language: php
 php:
+  - "7.2"
   - "7.1"
   - "7.0"
   - "5.6"

README.md

@@ -208,6 +208,7 @@ you can use the UserDefinition and UserPropertiesDefinition classes for customiz
 <?php
 $userDefinition = new \ByJG\Authenticate\Definition\UserDefinition(
     'users',    // $table
+    \ByJG\Authenticate\Model\UserModel::class, // Model class
     \ByJG\Authenticate\Definition\UserDefinition::LOGIN_IS_EMAIL,
     [
         'userid'   => 'fieldname of userid',

composer.json

@@ -16,9 +16,12 @@
     "prefer-stable": true,
     "require": {
         "php": ">=5.6.0",
-        "byjg/micro-orm": "2.1.*",
-        "byjg/cache-engine": "3.0.*",
+        "byjg/micro-orm": "2.2.*",
+        "byjg/cache-engine": "4.0.*",
         "byjg/jwt-wrapper": "1.0.*"
     },
+    "require-dev": {
+        "phpunit/phpunit": "5.7.*|6.5.*"
+    },
     "license": "MIT"
 }

src/Definition/UserDefinition.php

@@ -4,30 +4,22 @@
 
 use ByJG\Authenticate\Model\UserModel;
 use ByJG\MicroOrm\Mapper;
+use ByJG\Serializer\BinderObject;
 
 /**
  * Structure to represent the users
  */
 class UserDefinition
 {
-
-    protected $table = 'users';
-    protected $userid = 'userid';
-    protected $name = 'name';
-    protected $email = 'email';
-    protected $username = 'username';
-    protected $password = 'password';
-    protected $created = 'created';
-    protected $admin = 'admin';
+    protected $__table = 'users';
+    protected $__closures = ["select" => [], "update" => [] ];
+    protected $__loginField;
+    protected $__model;
+    protected $__properties = [];
 
     const UPDATE="update";
     const SELECT="select";
 
-    protected $closures = [ "select" => [], "update" => [] ];
-
-    protected $loginField;
-
-    protected $model;
 
     const LOGIN_IS_EMAIL="email";
     const LOGIN_IS_USERNAME="username";
@@ -36,109 +28,102 @@ class UserDefinition
      * Define the name of fields and table to store and retrieve info from database
      *
      * @param string $table
+     * @param string $model
      * @param string $loginField
      * @param array $fieldDef
+     * @throws \Exception
      */
     public function __construct(
         $table = 'users',
+        $model = UserModel::class,
         $loginField = self::LOGIN_IS_USERNAME,
         $fieldDef = []
     ) {
-        $this->table = $table;
+        $this->__table = $table;
+        $this->__model = $model;
+
+        // Set Default User Definition
+        $modelInstance = $this->modelInstance();
+        $modelProperties = BinderObject::toArrayFrom($modelInstance);
+        foreach (array_keys($modelProperties) as $property) {
+            $this->__properties[$property] = $property;
+        }
 
+        // Set custom Properties
         foreach ($fieldDef as $property => $value) {
             $this->checkProperty($property);
-            $this->{$property} = $value;
+            $this->__properties[$property] = $value;
         }
 
-        $this->model = UserModel::class;
-
         $this->defineClosureForUpdate('password', function ($value) {
-            return strtoupper(sha1($value));
+            // Already have a SHA1 password
+            if (strlen($value) === 40) {
+                return $value;
+            }
+
+            // Leave null
+            if (empty($value)) {
+                return null;
+            }
+
+            // Return the hash password
+            return strtolower(sha1($value));
         });
 
         if ($loginField !== self::LOGIN_IS_USERNAME && $loginField !== self::LOGIN_IS_EMAIL) {
             throw new \InvalidArgumentException('Login field is invalid. ');
         }
-        $this->loginField = $loginField;
-    }
+        $this->__loginField = $loginField;
 
-    /**
-     * @return string
-     */
-    public function table()
-    {
-        return $this->table;
-    }
-
-    /**
-     * @return string
-     */
-    public function getUserid()
-    {
-        return $this->userid;
+        $this->beforeInsert = function ($instance) {
+            return $instance;
+        };
+        $this->beforeUpdate = function ($instance) {
+            return $instance;
+        };
     }
 
     /**
      * @return string
      */
-    public function getName()
+    public function table()
     {
-        return $this->name;
+        return $this->__table;
     }
 
-    /**
-     * @return string
-     */
-    public function getEmail()
-    {
-        return $this->email;
-    }
 
-    /**
-     * @return string
-     */
-    public function getUsername()
+    public function __get($name)
     {
-        return $this->username;
+        $this->checkProperty($name);
+        return $this->__properties[$name];
     }
 
-    /**
-     * @return string
-     */
-    public function getPassword()
+    public function __call($name, $arguments)
     {
-        return $this->password;
-    }
-
-    /**
-     * @return string
-     */
-    public function getCreated()
-    {
-        return $this->created;
+        if (strpos($name, 'get') === 0) {
+            $name = strtolower(substr($name, 3));
+            return $this->{$name};
+        }
+        throw new \InvalidArgumentException("Method '$name' does not exists'");
     }
 
-    /**
-     * @return string
-     */
-    public function getAdmin()
+    public function toArray()
     {
-        return $this->admin;
+        return $this->__properties;
     }
 
     /**
      * @return string
      */
     public function loginField()
     {
-        return $this->{"get" . $this->loginField}();
+        return $this->{$this->__loginField};
     }
 
     private function checkProperty($property)
     {
-        if (!isset($this->{$property})) {
-            throw new \InvalidArgumentException('Invalid property');
+        if (!isset($this->__properties[$property])) {
+            throw new \InvalidArgumentException("Property '$property' does not exists'");
         }
     }
 
@@ -150,24 +135,33 @@ private function checkProperty($property)
     private function updateClosureDef($event, $property, $closure)
     {
         $this->checkProperty($property);
-        $this->closures[$event][$property] = $closure;
+        $this->__closures[$event][$property] = $closure;
     }
 
     private function getClosureDef($event, $property)
     {
         $this->checkProperty($property);
 
-        // If does no exists event returns the default closure
-        if (!isset($this->closures[$event])) {
+        if (!$this->existsClosure($event, $property)) {
             return Mapper::defaultClosure();
         }
 
-        // If event exists but does no exists the property returns the default closure
-        if (!array_key_exists($property, $this->closures[$event])) {
-            return Mapper::defaultClosure();
+        return $this->__closures[$event][$property];
+    }
+
+    public function existsClosure($event, $property)
+    {
+        // Event not set
+        if (!isset($this->__closures[$event])) {
+            return false;
         }
 
-        return $this->closures[$event][$property];
+        // Event is set but there is no property
+        if (!array_key_exists($property, $this->__closures[$event])) {
+            return false;
+        }
+
+        return true;
     }
 
     public function markPropertyAsReadOnly($property)
@@ -201,12 +195,48 @@ public function getClosureForSelect($property)
 
     public function model()
     {
-        return $this->model;
+        return $this->__model;
     }
 
     public function modelInstance()
     {
-        $model = $this->model;
+        $model = $this->__model;
         return new $model();
     }
+
+    protected $beforeInsert;
+
+    /**
+     * @return mixed
+     */
+    public function getBeforeInsert()
+    {
+        return $this->beforeInsert;
+    }
+
+    /**
+     * @param mixed $beforeInsert
+     */
+    public function setBeforeInsert($beforeInsert)
+    {
+        $this->beforeInsert = $beforeInsert;
+    }
+
+    protected $beforeUpdate;
+
+    /**
+     * @return mixed
+     */
+    public function getBeforeUpdate()
+    {
+        return $this->beforeUpdate;
+    }
+
+    /**
+     * @param mixed $beforeUpdate
+     */
+    public function setBeforeUpdate($beforeUpdate)
+    {
+        $this->beforeUpdate = $beforeUpdate;
+    }
 }

src/Interfaces/UsersInterface.php

@@ -36,7 +36,7 @@ public function addUser($name, $userName, $email, $password);
      * @param $model
      * @return bool
      */
-    public function add($model);
+    public function canAddUser($model);
 
     /**
      * @desc Get the user based on a filter
@@ -60,6 +60,13 @@ public function getById($userid);
      */
     public function getByEmail($email);
 
+    /**
+     * @desc Get the user based on his username.
+     * @param $username
+     * @return Row if user was found; null, otherwise
+     */
+    public function getByUsername($username);
+
     /**
      * @desc Get the user based on his login
      * @param string $login
@@ -174,8 +181,8 @@ public function getUserDefinition();
     public function getUserPropertiesDefinition();
 
     /**
-     * Return the ID for the user id (if it is not autoincrement)
-     * @return mixed
+     * @param $userid
+     * @return void
      */
-    public function generateUserId();
+    public function removeUserById($userid);
 }