Upgrade to 3.3.0

This commit is contained in:
Bastian Allgeier
2019-11-05 09:35:58 +01:00
parent 447a9dd266
commit a431716732
186 changed files with 3068 additions and 1458 deletions

View File

@@ -21,19 +21,13 @@ class AutoSession
/**
* Creates a new AutoSession instance
*
* @param \Kirby\Session\SessionStore|string $store SessionStore object or a path to the storage directory (uses the FileSessionStore)
* @param array $options Optional additional options:
* - `durationNormal`: Duration of normal sessions in seconds
* Defaults to 2 hours
* - `durationLong`: Duration of "remember me" sessions in seconds
* Defaults to 2 weeks
* - `timeout`: Activity timeout in seconds (integer or false for none)
* *Only* used for normal sessions
* Defaults to `1800` (half an hour)
* - `cookieName`: Name to use for the session cookie
* Defaults to `kirby_session`
* - `gcInterval`: How often should the garbage collector be run?
* Integer or `false` for never; defaults to `100`
* @param \Kirby\Session\SessionStore|string $store SessionStore object or a path to the storage directory (uses the FileSessionStore)
* @param array $options Optional additional options:
* - `durationNormal`: Duration of normal sessions in seconds; defaults to 2 hours
* - `durationLong`: Duration of "remember me" sessions in seconds; defaults to 2 weeks
* - `timeout`: Activity timeout in seconds (integer or false for none); *only* used for normal sessions; defaults to `1800` (half an hour)
* - `cookieName`: Name to use for the session cookie; defaults to `kirby_session`
* - `gcInterval`: How often should the garbage collector be run?; integer or `false` for never; defaults to `100`
*/
public function __construct($store, array $options = [])
{
@@ -56,15 +50,10 @@ class AutoSession
/**
* Returns the automatic session
*
* @param array $options Optional additional options:
* - `detect`: Whether to allow sessions in the `Authorization` HTTP header (`true`)
* or only in the session cookie (`false`)
* Defaults to `false`
* - `createMode`: When creating a new session, should it be set as a cookie or is it going
* to be transmitted manually to be used in a header?
* Defaults to `cookie`
* - `long`: Whether the session is a long "remember me" session or a normal session
* Defaults to `false`
* @param array $options Optional additional options:
* - `detect`: Whether to allow sessions in the `Authorization` HTTP header (`true`) or only in the session cookie (`false`); defaults to `false`
* - `createMode`: When creating a new session, should it be set as a cookie or is it going to be transmitted manually to be used in a header?; defaults to `cookie`
* - `long`: Whether the session is a long "remember me" session or a normal session; defaults to `false`
* @return \Kirby\Session\Session
*/
public function get(array $options = [])
@@ -139,15 +128,11 @@ class AutoSession
* Useful for custom applications like a password reset link
* Does *not* affect the automatic session
*
* @param array $options Optional additional options:
* - `startTime`: Time the session starts being valid (date string or timestamp)
* Defaults to `now`
* - `expiryTime`: Time the session expires (date string or timestamp)
* Defaults to `+ 2 hours`
* - `timeout`: Activity timeout in seconds (integer or false for none)
* Defaults to `1800` (half an hour)
* - `renewable`: Should it be possible to extend the expiry date?
* Defaults to `true`
* @param array $options Optional additional options:
* - `startTime`: Time the session starts being valid (date string or timestamp); defaults to `now`
* - `expiryTime`: Time the session expires (date string or timestamp); defaults to `+ 2 hours`
* - `timeout`: Activity timeout in seconds (integer or false for none); defaults to `1800` (half an hour)
* - `renewable`: Should it be possible to extend the expiry date?; defaults to `true`
* @return \Kirby\Session\Session
*/
public function createManually(array $options = [])