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: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: <?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;
/**
* Responsibility - base user model class.
*/
interface IUser {
/**
* User session namespace key to get username string.
*/
const SESSION_USERNAME_KEY = 'userName';
/**
* User session namespace key to get authenticated boolean.
*/
const SESSION_AUTHORIZED_KEY = 'authorized';
// trait: \MvcCore\Ext\Auths\Basics\Traits\UserAndRole\Base
/**
* User unique id, representing primary key in database
* or sequence number in system config.
* Example: `0 | 1 | 2...`
* @return int|NULL
*/
public function GetId () ;
/**
* Set user unique id, representing primary key in database
* or sequence number in system config.
* Example: `0 | 1 | 2...`
* @param int|NULL $id
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetId ($id);
/**
* Get user active state boolean. `TRUE` for active, `FALSE` otherwise.
* This function is only alias for `$user->GetActive();`.
* @return bool
*/
public function IsActive ();
/**
* Get user active state boolean. `TRUE` for active, `FALSE` otherwise.
* @return bool
*/
public function GetActive ();
/**
* Set user active state boolean. `TRUE` for active, `FALSE` otherwise.
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetActive ($active);
// trait: \MvcCore\Ext\Auths\Basics\Traits\User\Base
/**
* Unique user name to log in. It could be email,
* unique user name or anything uniquelse.
* Example: `"admin" | "john" | "tomflidr@gmail.com"`
* @var string
*/
public function GetUserName ();
/**
* Set unique user name to log in. It could be email,
* unique user name or anything uniquelse.
* Example: `"admin" | "john" | "tomflidr@gmail.com"`
* @param string $userName
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetUserName ($userName);
/**
* User full name string to display in application
* for authenticated user at sign out button.
* Example: `"Administrator" | "John" | "Tom Flidr"`
* @var string
*/
public function GetFullName ();
/**
* Set user full name string to display in application
* for authenticated user at sign out button.
* Example: `"Administrator" | "John" | "Tom"`
* @param string $fullName
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetFullName ($fullName);
/**
* Password hash, usually `NULL`. It exists only for authentication moment.
* From moment, when is user instance loaded with password hash by session username to
* moment, when is compared hashed sent password and stored password hash.
* After password hashes comparison, password hash is un-setted.
* @var string|NULL
*/
public function GetPasswordHash ();
/**
* Set password hash, usually `NULL`. It exists only for authentication moment.
* From moment, when is user instance loaded with password hash by session username to
* moment, when is compared hashed sent password and stored password hash.
* After password hashes comparison, password hash is un-setted.
* @param string|NULL $passwordHash
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetPasswordHash ($passwordHash);
// trait: \MvcCore\Ext\Auths\Basics\Traits\User\Auth
/**
* Try to get user model instance from application users list
* (it could be database table or system config) by user session namespace
* `userName` record if `authenticated` boolean in user session namespace is `TRUE`.
* Or return `NULL` for no user by user session namespace records.
* @return \MvcCore\Ext\Auths\Basics\User|NULL
*/
public static function SetUpUserBySession ();
/**
* Try to get user model instance from application users list
* (it could be database table or system config) by submitted
* and cleaned `$userName`, hash submitted and cleaned `$password` and try to compare
* hashed submitted password and user password hash from application users
* list. If password hashes are the same, set username and authenticated boolean
* into user session namespace. Then user is logged in.
* @param string $userName Submitted and cleaned username. Characters `' " ` < > \ = ^ | & ~` are automatically encoded to html entities by default `\MvcCore\Ext\Auths\Basic` sign in form.
* @param string $password Submitted and cleaned password. Characters `' " ` < > \ = ^ | & ~` are automatically encoded to html entities by default `\MvcCore\Ext\Auths\Basic` sign in form.
* @return \MvcCore\Ext\Auths\Basics\User|NULL
*/
public static function LogIn ($userName = '', $password = '');
/**
* Log out user. Set `authenticated` record in user session namespace to `FALSE`
* by default. User name should still remain in user session namespace.
* If First argument `$destroyWholeSession` is `TRUE`, destroy whole
* user session namespace with `authenticated` bool and with `userName` string record.
* @param bool $destroyWholeSession
* @return void
*/
public static function LogOut ($destroyWholeSession = FALSE);
/**
* Get password hash by `password_hash()` with salt
* by `\MvcCore\Ext\Auths\Basic` extension configuration or
* by custom salt in second argument `$options['salt'] = 'abcdefg';`.
* @see http://php.net/manual/en/function.password-hash.php
* @param string $password
* @param array $options An options for `password_hash()`.
* @return string
*/
public static function EncodePasswordToHash ($password = '', $options = []);
/**
* MvcCore session namespace instance
* to get/clear username record from session
* to load user for authentication.
* Session is automatically started if necessary
* by `\MvcCore\Session::GetNamespace();`.
* @return \MvcCore\Session
*/
public static function GetSessionIdentity ();
/**
* Set identity session namespace.
* @param \MvcCore\Session $sessionIdentity
* @return \MvcCore\Session
*/
public static function SetSessionIdentity (\MvcCore\ISession $sessionIdentity);
/**
* MvcCore session namespace instance
* to get/clear username record from session
* to load user for authentication.
* Session is automatically started if necessary
* by `\MvcCore\Session::GetNamespace();`.
* @return \MvcCore\Session
*/
public static function GetSessionAuthorization ();
/**
* Set authorization session namespace.
* @param \MvcCore\Session $sessionAuthorization
* @return \MvcCore\Session
*/
public static function SetSessionAuthorization (\MvcCore\ISession $sessionAuthorization);
// trait: \MvcCore\Ext\Auths\Basics\Traits\User\Roles
/**
* Get if user is Administrator. Administrator has always allowed everything.
* @return bool
*/
public function IsAdmin();
/**
* Get if user is Administrator. Administrator has always allowed everything.
* @return bool
*/
public function GetAdmin();
/**
* Set user to Administrator. Administrator has always allowed everything.
* @param bool $admin `TRUE` by default.
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetAdmin ($admin = TRUE);
/**
* Return array of user's roles names.
* @return \string[]
*/
public function & GetRoles ();
/**
* Set new user's roles or roles names.
* @param \string[]|\MvcCore\Ext\Auths\Basics\Role[] $rolesOrRolesNames
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetRoles ($rolesOrRolesNames = []);
/**
* Add user role or role name.
* @param string|\MvcCore\Ext\Auths\Basics\Role $roleOrRoleName
* @throws \InvalidArgumentException
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function AddRole ($roleOrRoleName);
/**
* Get `TRUE` if user has already assigned role or role name.
* @param string|\MvcCore\Ext\Auths\Basics\Role $roleOrRoleName
* @throws \InvalidArgumentException
* @return bool
*/
public function HasRole ($roleOrRoleName);
/**
* Remove user role or role name from user roles.
* @param string|\MvcCore\Ext\Auths\Basics\Role $roleOrRoleName
* @throws \InvalidArgumentException
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function RemoveRole ($roleOrRoleName);
/**
* Get `TRUE` if given permission string(s) is/are (all or some) allowed for user or user role.
* `FALSE` otherwise. Permission name could contain asterisk char `*` in any place.
* @param string|\string[] $permissionNameOrNames
* @param bool $allPermissionsRequired `TRUE` by default.
* @return bool
*/
public function IsAllowed ($permissionNameOrNames, $allPermissionsRequired = TRUE);
// trait: \MvcCore\Ext\Auths\Basics\Traits\UserAndRole\Permissions
/**
* Get `TRUE` if given permission string is allowed for user or role. `FALSE` otherwise.
* @param string $permissionName
* @return bool
*/
public function GetPermission ($permissionName);
/**
* Set `$permissionName` string with `$allow` boolean to allow
* or to disallow permission (with `$allow = FALSE`) for user or role.
* @param string $permissionName Strings describing what is allowed/disallowed to do for user or role.
* @param bool $allow `TRUE` by default.
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetPermission ($permissionName, $allow = TRUE);
/**
* Get array of strings describing what is allowed to do for user or role.
* @return \string[]
*/
public function & GetPermissions ();
/**
* Set array of strings describing what is allowed to do for user or role.
* @param string|\string[] $permissions The permissions string, separated by comma character or array of strings.
* @return \MvcCore\Ext\Auths\Basics\User
*/
public function SetPermissions ($permissions);
// class: \MvcCore\Ext\Auths\Basics\User
/**
* 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.
* @return \MvcCore\Ext\Auths\Basics\User
*/
public static function GetByUserName ($userName);
}