Overview

Namespaces

  • MvcCore
    • Ext
      • Auth
        • Virtual
      • Debug
        • Tracy
      • Form
        • Core
        • Validators
      • Request
      • Router
        • Lang
      • View
        • Helpers
  • None

Classes

  • MvcCore
  • MvcCore\Config
  • MvcCore\Controller
  • MvcCore\Debug
  • MvcCore\Ext\Auth
  • MvcCore\Ext\Auth\Controller
  • MvcCore\Ext\Auth\SignInForm
  • MvcCore\Ext\Auth\SignOutForm
  • MvcCore\Ext\Auth\User
  • MvcCore\Ext\Auth\Virtual\Controller
  • MvcCore\Ext\Auth\Virtual\Form
  • MvcCore\Ext\Auth\Virtual\User
  • MvcCore\Ext\Debug\Tracy
  • MvcCore\Ext\Debug\Tracy\AuthPanel
  • MvcCore\Ext\Debug\Tracy\IncludePanel
  • MvcCore\Ext\Debug\Tracy\MvcCorePanel
  • MvcCore\Ext\Debug\Tracy\RoutingPanel
  • MvcCore\Ext\Debug\Tracy\SessionPanel
  • MvcCore\Ext\Form
  • MvcCore\Ext\Form\Button
  • MvcCore\Ext\Form\Checkbox
  • MvcCore\Ext\Form\CheckboxGroup
  • MvcCore\Ext\Form\Core\Base
  • MvcCore\Ext\Form\Core\Configuration
  • MvcCore\Ext\Form\Core\Field
  • MvcCore\Ext\Form\Core\FieldGroup
  • MvcCore\Ext\Form\Core\Helpers
  • MvcCore\Ext\Form\Core\Validator
  • MvcCore\Ext\Form\Core\View
  • MvcCore\Ext\Form\CountrySelect
  • MvcCore\Ext\Form\Date
  • MvcCore\Ext\Form\DateTime
  • MvcCore\Ext\Form\Email
  • MvcCore\Ext\Form\Hidden
  • MvcCore\Ext\Form\NoType
  • MvcCore\Ext\Form\Number
  • MvcCore\Ext\Form\Password
  • MvcCore\Ext\Form\RadioGroup
  • MvcCore\Ext\Form\Range
  • MvcCore\Ext\Form\ResetButton
  • MvcCore\Ext\Form\ResetInput
  • MvcCore\Ext\Form\Select
  • MvcCore\Ext\Form\SubmitButton
  • MvcCore\Ext\Form\SubmitInput
  • MvcCore\Ext\Form\Text
  • MvcCore\Ext\Form\Textarea
  • MvcCore\Ext\Form\Time
  • MvcCore\Ext\Form\Validators\CompanyId
  • MvcCore\Ext\Form\Validators\CompanyVatId
  • MvcCore\Ext\Form\Validators\Date
  • MvcCore\Ext\Form\Validators\Email
  • MvcCore\Ext\Form\Validators\FloatVal
  • MvcCore\Ext\Form\Validators\Integer
  • MvcCore\Ext\Form\Validators\Maxlength
  • MvcCore\Ext\Form\Validators\MaxSelectedOptions
  • MvcCore\Ext\Form\Validators\MinSelectedOptions
  • MvcCore\Ext\Form\Validators\NumberField
  • MvcCore\Ext\Form\Validators\Pattern
  • MvcCore\Ext\Form\Validators\Phone
  • MvcCore\Ext\Form\Validators\RangeField
  • MvcCore\Ext\Form\Validators\SafeString
  • MvcCore\Ext\Form\Validators\Time
  • MvcCore\Ext\Form\Validators\Url
  • MvcCore\Ext\Form\Validators\ValueInOptions
  • MvcCore\Ext\Form\Validators\ZipCode
  • MvcCore\Ext\Request\ApacheDpi
  • MvcCore\Ext\Request\Cli
  • MvcCore\Ext\Router\Lang
  • MvcCore\Ext\Router\Lang\Route
  • MvcCore\Ext\Router\Media
  • MvcCore\Ext\Router\MediaSiteKey
  • MvcCore\Ext\View\Helpers\Assets
  • MvcCore\Ext\View\Helpers\Css
  • MvcCore\Ext\View\Helpers\Js
  • MvcCore\Ext\View\Helpers\LineBreaks
  • MvcCore\Model
  • MvcCore\Request
  • MvcCore\Response
  • MvcCore\Route
  • MvcCore\Router
  • MvcCore\Session
  • MvcCore\Tool
  • MvcCore\View

Exceptions

  • MvcCore\Ext\Form\Core\Exception
  • Overview
  • Namespace
  • Class
  • Tree
  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: 
<?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 FlĂ­dr (https://github.com/mvccore/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/4.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Auth;

class User extends Virtual\User {

    /** @var bool */
    protected $autoInit = FALSE;

    /** @var \MvcCore\Session */
    protected static $session = NULL;

    /**
     * Try to get user model instance from 
     * any place by session username record 
     * if there is any or return null.
     * @return \MvcCore\Ext\Auth\User|null
     */
    public static function GetUserBySession () {
        $result = NULL;
        $session = static::getSession();
        if (!isset($session->uname)) return $result;
        $cfg = \MvcCore\Config::GetSystem();
        $allCredentials = $cfg->credentials;
        foreach ($allCredentials as & $credentials) {
            if ($credentials->username === $session->uname) {
                $result = new static();
                $result->setUp(array(
                    'UserName'  => $credentials->username,
                    'FullName'  => $credentials->fullname,
                ));
                break;
            }
        }
        return $result;
    }

    /**
     * Get user instance if the username exists and hashed password is the same
     * @param string $username
     * @param string $password 
     * @return \MvcCore\Ext\Auth\User|null
     */
    public static function Authenticate ($uniqueUserName = '', $password = '') {
        $result = NULL;
        $hashedPassword = static::GetPasswordHash($password);
        $cfg = \MvcCore\Config::GetSystem();
        $allCredentials = $cfg->credentials;
        foreach ($allCredentials as & $credentials) {
            if ($credentials->username === $uniqueUserName) {
                if ($credentials->password === $hashedPassword) {
                    $result = new static();
                    $result->setUp(array(
                        'UserName'  => $credentials->username,
                        'FullName'  => $credentials->fullname,
                    ));
                }
                break;
            }
        }
        return $result;
    }

    /**
     * Set up unique user name in session namespace
     * @param \MvcCore\Ext\Auth\User $user
     * @return void
     */
    public static function StoreInSession ($user = NULL) {
        static::GetSession()->uname = $user->UserName;
    }

    /**
     * Clear unique user name from session
     * @return void
     */
    public static function ClearFromSession () {
        static::GetSession()->Destroy();
    }

    /**
     * Get session to get/set/clear username,
     * is session is not started - start the session.
     * @return \MvcCore\Session
     */
    protected static function & getSession () {
        if (is_null(static::$session)) {
            \MvcCore::SessionStart(); // start session if not started or do nothing if session has been started already
            static::$session = \MvcCore\Session::GetNamespace(__CLASS__);
            static::$session->SetExpirationSeconds(
                \MvcCore\Ext\Auth::GetInstance()->GetConfig()->expirationSeconds
            );
        }
        return static::$session;
    }
}
MvcCore API documentation generated by ApiGen