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: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: <?php
namespace MvcCore\Ext\Auths;
interface IBasic {
/**
* Return singleton instance. If instance exists, return existing instance,
* if not, create new basic authentication module instance, store it and return it.
* @param array $configuration Optional configuration passed into method
* `\MvcCore\Ext\Auths\Basic::__construct($configuration)`.
* @return \MvcCore\Ext\Auths\Basic
*/
public static function GetInstance ($configuration = []);
/**
* Get expiration time (in seconds) how long to remember the user name in session.
* You can use zero (`0`) to browser close moment, but some browsers can
* restore previous session after next browser application start. Or anybody
* else in your project could use session for storing any information
* for some longer time in your application and session cookie could then
* exists much longer then browser close moment only.
* So better is not to use a zero value.
* Default value is 1 month (30 days, 2592000 seconds).
* @return int
*/
public function GetExpirationIdentity ();
/**
* Get expiration time (in seconds) how long to remember the authorization in session.
* You can use zero (`0`) to browser close moment, but some browsers can
* restore previous session after next browser application start. Or anybody
* else in your project could use session for storing any information
* for some longer time in your application and session cookie could then
* exists much longer then browser close moment only.
* So better is not to use a zero value.
* Default value is 10 minutes (600 seconds).
* @return int
*/
public function GetExpirationAuthorization ();
/**
* Get full class name to use for user instance.
* Class name has to implement interface
* `\MvcCore\Ext\Auths\Basics\IUser`.
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\User`.
* @return string
*/
public function GetUserClass ();
/**
* Get full class name to use for user role class.
* Class name has to implement interface
* `\MvcCore\Ext\Auths\Basics\IRole`.
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\Role`.
* @return string
*/
public function GetRoleClass ();
/**
* Get full class name to use for controller instance
* to submit authentication form(s). Class name has to implement interfaces:
* - `\MvcCore\Ext\Auths\Basics\IController`
* - `\MvcCore\IController`
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\Controller`.
* @return string
*/
public function GetControllerClass ();
/**
* Get full class name to use for sign in form instance.
* Class name has to implement interface
* `\MvcCore\Ext\Auths\Basics\IForm`.
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\SignInForm`.
* @return string
*/
public function GetSignInFormClass ();
/**
* Full class name to use for sign out form instance.
* Class name has to implement interface
* `\MvcCore\Ext\Auths\Basics\IForm`.
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\SignOutForm`.
* @return string
*/
public function GetSignOutFormClass ();
/**
* Get full URL to redirect user, after sign in
* POST request was successful.
* If `NULL` (by default), user will be redirected
* to the same url, where was sign in form rendered.
* @return string|NULL
*/
public function GetSignedInUrl ();
/**
* Get full URL to redirect user, after sign out
* POST request was successful.
* If `NULL` (by default), user will be redirected
* to the same url, where was sign out form rendered.
* @return string|NULL
*/
public function GetSignedOutUrl ();
/**
* Get full URL to redirect user, after sign in POST
* request or sign out POST request was not successful,
* for example wrong credentials.
* If `NULL` (by default), user will be redirected
* to the same url, where was sign in/out form rendered.
* @param string $signErrorUrl
* @return string|NULL
*/
public function GetSignErrorUrl ();
/**
* Get route instance to submit sign in form into.
* Default configured route for sign in request is `/signin` by POST.
* @return \MvcCore\Route
*/
public function GetSignInRoute ();
/**
* Get route to submit sign out form into.
* Default configured route for sign in request is `/signout` by POST.
* @return \MvcCore\Route
*/
public function GetSignOutRoute ();
/**
* Get configured salt for `passord_hash();` to generate password by `PASSWORD_BCRYPT`.
* `NULL` by default. This option is the only one option required
* to configure authentication module to use it properly.
* @return string|NULL
*/
public function GetPasswordHashSalt ();
/**
* Get timeout to `sleep();` PHP script before sending response to user,
* when user submitted invalid username or password.
* Default value is `3` (3 seconds).
* @return int
*/
public function GetInvalidCredentialsTimeout ();
/**
* Get configured callable translator to set it into authentication form
* to translate form labels, placeholders, buttons or error messages.
* Default value is `NULL` (forms without translations).
* @return callable|NULL
*/
public function GetTranslator ();
/**
* Get authenticated user model instance reference
* or `NULL` if user has no username record in session namespace.
* If user has not yet been initialized, load the user internally by
* `{$configuredUserClass}::SetUpUserBySession();` to try to load
* user by username record in session namespace.
* @return \MvcCore\Ext\Auths\Basics\User|NULL
*/
public function GetUser ();
/**
* Return `TRUE` if user is authenticated/signed in,
* `TRUE` if user has any username record in session namespace.
* If user has not yet been initialized, load the user internally by
* `$auth->GetUser();` to try to load user by username record in session namespace.
* @return bool
*/
public function IsAuthenticated ();
/**
* Return completed sign in or sign out form instance.
* Form instance completion is processed only once,
* any created form instance is stored in `$auth->form` property.
* This method is always called by you, your application
* to set form into you custom template to render it for user.
* If user is not authenticated, sign in form is returned and
* if user is authenticated, opposite sign out form is returned.
* This method is only alias to call two other methods:
* - `\MvcCore\Ext\Auths\Basic::GetInstance()->GetSignInForm();` for not authenticated users.
* - `\MvcCore\Ext\Auths\Basic::GetInstance()->GetSignOutForm();` for authenticated users.
* @var \MvcCore\Ext\Auths\Basics\Form\SignIn|\MvcCore\Ext\Auths\Basics\Form\SignOut
*/
public function GetForm ();
/**
* Return completed sign in form instance.
* Form instance completion is processed only once,
* created form instance is stored in `$auth->form` property.
* @return \MvcCore\Ext\Auths\Basics\Form\SignIn
*/
public function GetSignInForm ();
/**
* Return completed sign out form instance.
* Form instance completion is processed only once,
* created form instance is stored in `$auth->form` property.
* @return \MvcCore\Ext\Auths\Basics\Form\SignOut
*/
public function GetSignOutForm ();
/**
* Return `array` with all protected configuration properties.
* @return array
*/
public function GetConfiguration ();
/**
* Set expiration time (in seconds) how long to remember the user name in session.
* You can use zero (`0`) to browser close moment, but some browsers can
* restore previous session after next browser application start. Or anybody
* else in your project could use session for storing any information
* for some longer time in your application and session cookie could then
* exists much longer then browser close moment only.
* So better is not to use a zero value.
* Default value is 1 month (30 days, 2592000 seconds).
* @param int $identityExpirationSeconds
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetExpirationIdentity ($identityExpirationSeconds = 2592000);
/**
* Set expiration time (in seconds) how long to remember the authorization in session.
* You can use zero (`0`) to browser close moment, but some browsers can
* restore previous session after next browser application start. Or anybody
* else in your project could use session for storing any information
* for some longer time in your application and session cookie could then
* exists much longer then browser close moment only.
* So better is not to use a zero value.
* Default value is 10 minutes (600 seconds).
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetExpirationAuthorization ($authorizationExpirationSeconds = 600);
/**
* Set full class name to use for user instance.
* Class name has to implement interface
* `\MvcCore\Ext\Auths\Basics\IUser`.
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\User`.
* @param string $userClass User full class name implementing `\MvcCore\Ext\Auths\Basics\IUser`.
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetUserClass ($userClass = '');
/**
* Set full class name to use for user role class.
* Class name has to implement interface
* `\MvcCore\Ext\Auths\Basics\IRole`.
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\Role`.
* @param string $roleClass Role full class name implementing `\MvcCore\Ext\Auths\Basics\IRole`.
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetRoleClass ($roleClass = '');
/**
* Set full class name to use for controller instance
* to submit authentication form(s). Class name has to implement interfaces:
* - `\MvcCore\Ext\Auths\Basics\IController`
* - `\MvcCore\IController`
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\Controller`.
* @param string $controllerClass Controller full class name implementing `\MvcCore\Ext\Auths\Basics\IController`.
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetControllerClass ($controllerClass = '');
/**
* Set full class name to use for sign in form instance.
* Class name has to implement interface
* `\MvcCore\Ext\Auths\Basics\IForm`.
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\SignInForm`.
* @param string $signInFormClass Form full class name implementing `\MvcCore\Ext\Auths\Basics\IForm`.
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetSignInFormClass ($signInFormClass = '');
/**
* Set full class name to use for sign out form instance.
* Class name has to implement interface
* `\MvcCore\Ext\Auths\Basics\IForm`.
* Default value after authentication module init is
* configured to `\MvcCore\Ext\Auths\Basics\SignOutForm`.
* @param string $signInFormClass Form full class name implementing `\MvcCore\Ext\Auths\Basics\IForm`.
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetSignOutFormClass ($signOutFormClass = '');
/**
* Set full URL to redirect user, after sign in
* POST request was successful.
* If `NULL` (by default), user will be redirected
* to the same url, where was sign in form rendered.
* @param string|NULL $signedInUrl
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetSignedInUrl ($signedInUrl = NULL);
/**
* Set full URL to redirect user, after sign out
* POST request was successful.
* If `NULL` (by default), user will be redirected
* to the same url, where was sign out form rendered.
* @param string|NULL $signedOutUrl
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetSignedOutUrl ($signedOutUrl = NULL);
/**
* Set full URL to redirect user, after sign in POST
* request or sign out POST request was not successful,
* for example wrong credentials.
* If `NULL` (by default), user will be redirected
* to the same url, where was sign in/out form rendered.
* @param string|NULL $signErrorUrl
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetSignErrorUrl ($signErrorUrl = NULL);
/**
* Set route instance to submit sign in form into.
* Default configured route for sign in request is `/signin` by POST.
* @param string|array|\MvcCore\Route $signInRoute
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetSignInRoute ($signInRoute = NULL);
/**
* Set route to submit sign out form into.
* Default configured route for sign in request is `/signout` by POST.
* @param string|array|\MvcCore\Route $signOutRoute
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetSignOutRoute ($signOutRoute = NULL);
/**
* Set configured salt for `passord_hash();` to generate password by `PASSWORD_BCRYPT`.
* `NULL` by default. This option is the only one option required
* to configure authentication module to use it properly.
* @param string $passwordHashSalt
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetPasswordHashSalt ($passwordHashSalt = '');
/**
* Set timeout to `sleep();` PHP script before sending response to user,
* when user submitted invalid username or password.
* Default value is `3` (3 seconds).
* @param int $seconds
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetInvalidCredentialsTimeout ($seconds = 3);
/**
* Set callable translator to set it into authentication form
* to translate form labels, placeholders or buttons.
* Default value is `NULL` (forms without translations).
* @param callable $translator
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetTranslator (callable $translator = NULL);
/**
* Set user instance manually. If you use this method
* no authentication by `{$configuredUserClass}::SetUpUserBySession();`
* is used and authentication state is always positive.
* @param \MvcCore\Ext\Auths\Basics\User|NULL $user
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetUser (\MvcCore\Ext\Auths\Basics\IUser $user = NULL);
/**
* Set sign in, sign out or any authentication form instance.
* Use this method only if you need sometimes to complete different form to render.
* @param \MvcCore\Ext\Auths\Basics\IForm $form
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetForm (\MvcCore\Ext\Auths\Basics\IForm $form);
/**
* Set up authorization module configuration.
* Each array key has to be key by protected configuration property in this class.
* All properties are one by one configured by it's setter method.
* @param array $configuration Keys by protected properties names in camel case.
* @param bool $throwExceptionIfPropertyIsMissing
* @throws \InvalidArgumentException
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetConfiguration ($configuration = [], $throwExceptionIfPropertyIsMissing = TRUE);
/**
* Optional alias method if you have user class configured
* to database user: `\MvcCore\Ext\Auths\Basics\Users\Database`.
* Alias for `\MvcCore\Ext\Auths\Basics\Users\Database::SetUsersTableStructure($tableName, $columnNames);`.
* @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.
* @return \MvcCore\Ext\Auths\Basic
*/
public function SetTableStructureForDbUsers ($tableName = NULL, $columnNames = NULL);
}