1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Auths\Basics\Users;

/**
 * Responsibility - simply and only load user instance from configurable database table structure.
 */
class       Database
extends     \MvcCore\Ext\Auths\Basics\User
implements  \MvcCore\Ext\Auths\Basics\IDatabaseUser {

    /**
     * Users table nested database structure,
     * configured by method `SetUsersTableStructure()`
     * and used by method `GetByUserName()`.
     * @var array
     */
    protected static $usersTableStructure = [
        'table'     => 'users',
        'columns'   => [
            'id'            => 'id',
            'active'        => 'active',
            'userName'      => 'user_name',
            'passwordHash'  => 'password_hash',
            'fullName'      => 'full_name',
        ]
    ];

    /**
     * Set database table structure how to load user from db.
     * @param string|NULL   $tableName Database table name.
     * @param string[]|NULL $columnNames Keys are user class protected properties names in camel case, values are database columns names.
     */
    public static function SetUsersTableStructure ($tableName = NULL, $columnNames = NULL) {
        if ($tableName !== NULL) static::$usersTableStructure['table'] = $tableName;
        if ($columnNames !== NULL) {
            $columns = & static::$usersTableStructure['columns'];
            foreach ($columnNames as $propertyName => $columnName)
                $columns[$propertyName] = $columnName;
        }
    }

    /**
     * Get user model instance from database or any other users list
     * resource by submitted and cleaned `$userName` field value.
     * @param string $userName Submitted and cleaned username. Characters `' " ` < > \ = ^ | & ~` are automatically encoded to html entities by default `\MvcCore\Ext\Auths\Basic` sign in form.
     * @throws \RuntimeException
     * @return \MvcCore\Ext\Auths\Basics\User|\MvcCore\Model
     */
    public static function GetByUserName ($userName) {
        $table = static::$usersTableStructure['table'];
        $columns = (object) static::$usersTableStructure['columns'];
        $sql = implode("\n", [
            "SELECT                                         ",
            "   u.{$columns->id} AS id,                     ",
            "   u.{$columns->active} AS active,             ",
            "   u.{$columns->userName} AS userName,         ",
            "   u.{$columns->passwordHash} AS passwordHash, ",
            "   u.{$columns->fullName} AS fullName          ",
            "FROM                                           ",
            "   {$table} u                                  ",
            "WHERE                                          ",
            "   u.{$columns->userName} = :user_name AND     ",
            "   u.{$columns->active} = :active              ",
        ]);
        $conn = self::GetConnection();
        if ($conn instanceof \PDO) {
            $pdo = $conn;
        } else if (method_exists($conn, 'GetProvider')) {
            $pdo = $conn->GetProvider();
        } else {
            throw new \RuntimeException("Couldn't initialize `\PDO` connection.");
        }
        if (!$select = $pdo->prepare($sql))
            throw new \RuntimeException(
                implode(' ', $pdo->errorInfo()) . ': ' . $sql, intval($pdo->errorCode())
            );
        $select->execute([
            ":user_name"    => $userName,
            ":active"       => 1,
        ]);
        /** @var $user \MvcCore\Ext\Auths\Basics\User|\MvcCore\Model */
        $user = NULL;
        $data = $select->fetch(\PDO::FETCH_ASSOC);
        if ($data) {
            $user = (new static())->SetValues(
                $data, 
                \MvcCore\IModel::PROPS_INHERIT |
                \MvcCore\IModel::PROPS_PROTECTED |
                \MvcCore\IModel::PROPS_CONVERT_UNDERSCORES_TO_CAMELCASE | 
                \MvcCore\IModel::PROPS_INITIAL_VALUES
            );
            return $user;
        }
        return $user;
    }
}