diff options
Diffstat (limited to 'vendor/thecodingmachine/safe/generated/session.php')
| -rw-r--r-- | vendor/thecodingmachine/safe/generated/session.php | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/vendor/thecodingmachine/safe/generated/session.php b/vendor/thecodingmachine/safe/generated/session.php index 7b8c9478d..212cf850e 100644 --- a/vendor/thecodingmachine/safe/generated/session.php +++ b/vendor/thecodingmachine/safe/generated/session.php @@ -22,6 +22,42 @@ function session_abort(): void /** + * session_create_id is used to create new + * session id for the current session. It returns collision free + * session id. + * + * If session is not active, collision check is omitted. + * + * Session ID is created according to php.ini settings. + * + * It is important to use the same user ID of your web server for GC + * task script. Otherwise, you may have permission problems especially + * with files save handler. + * + * @param string $prefix If prefix is specified, new session id + * is prefixed by prefix. Not all + * characters are allowed within the session id. Characters in + * the range a-z A-Z 0-9 , (comma) and - + * (minus) are allowed. + * @return string session_create_id returns new collision free + * session id for the current session. If it is used without active + * session, it omits collision check. + * On failure, FALSE is returned. + * @throws SessionException + * + */ +function session_create_id(string $prefix = ""): string +{ + error_clear_last(); + $result = \session_create_id($prefix); + if ($result === false) { + throw SessionException::createFromPhpError(); + } + return $result; +} + + +/** * session_decode decodes the serialized session data provided in * $data, and populates the $_SESSION superglobal * with the result. @@ -70,6 +106,151 @@ function session_destroy(): void /** + * session_encode returns a serialized string of the + * contents of the current session data stored in the $_SESSION superglobal. + * + * By default, the serialization method used is internal to PHP, and is not the same as serialize. + * The serialization method can be set using session.serialize_handler. + * + * @return string Returns the contents of the current session encoded. + * @throws SessionException + * + */ +function session_encode(): string +{ + error_clear_last(); + $result = \session_encode(); + if ($result === false) { + throw SessionException::createFromPhpError(); + } + return $result; +} + + +/** + * session_id is used to get or set the session id for + * the current session. + * + * The constant SID can also be used to + * retrieve the current name and session id as a string suitable for + * adding to URLs. See also Session + * handling. + * + * @param string $id If id is specified and not NULL, it will replace the current + * session id. session_id needs to be called before + * session_start for that purpose. Depending on the + * session handler, not all characters are allowed within the session id. + * For example, the file session handler only allows characters in the + * range a-z A-Z 0-9 , (comma) and - (minus)! + * @return string session_id returns the session id for the current + * session or the empty string ("") if there is no current + * session (no current session id exists). + * On failure, FALSE is returned. + * @throws SessionException + * + */ +function session_id(string $id = null): string +{ + error_clear_last(); + if ($id !== null) { + $result = \session_id($id); + } else { + $result = \session_id(); + } + if ($result === false) { + throw SessionException::createFromPhpError(); + } + return $result; +} + + +/** + * session_module_name gets the name of the current + * session module, which is also known as + * session.save_handler. + * + * @param string $module If module is specified and not NULL, that module will be + * used instead. + * Passing "user" to this parameter is forbidden. Instead + * session_set_save_handler has to be called to set a user + * defined session handler. + * @return string Returns the name of the current session module. + * @throws SessionException + * + */ +function session_module_name(string $module = null): string +{ + error_clear_last(); + if ($module !== null) { + $result = \session_module_name($module); + } else { + $result = \session_module_name(); + } + if ($result === false) { + throw SessionException::createFromPhpError(); + } + return $result; +} + + +/** + * session_name returns the name of the current + * session. If name is given, + * session_name will update the session name and return + * the old session name. + * + * If a new session name is + * supplied, session_name modifies the HTTP cookie + * (and output content when session.transid is + * enabled). Once the HTTP cookie is + * sent, session_name raises error. + * session_name must be called + * before session_start for the session to work + * properly. + * + * The session name is reset to the default value stored in + * session.name at request startup time. Thus, you need to + * call session_name for every request (and before + * session_start is called). + * + * @param string $name The session name references the name of the session, which is + * used in cookies and URLs (e.g. PHPSESSID). It + * should contain only alphanumeric characters; it should be short and + * descriptive (i.e. for users with enabled cookie warnings). + * If name is specified and not NULL, the name of the current + * session is changed to its value. + * + * + * + * The session name can't consist of digits only, at least one letter + * must be present. Otherwise a new session id is generated every time. + * + * + * + * The session name can't consist of digits only, at least one letter + * must be present. Otherwise a new session id is generated every time. + * @return string Returns the name of the current session. If name is given + * and function updates the session name, name of the old session + * is returned. + * @throws SessionException + * + */ +function session_name(string $name = null): string +{ + error_clear_last(); + if ($name !== null) { + $result = \session_name($name); + } else { + $result = \session_name(); + } + if ($result === false) { + throw SessionException::createFromPhpError(); + } + return $result; +} + + +/** * session_regenerate_id will replace the current * session id with a new one, and keep the current session information. * @@ -113,6 +294,44 @@ function session_reset(): void /** + * session_save_path returns the path of the current + * directory used to save session data. + * + * @param string $path Session data path. If specified and not NULL, the path to which data is saved will + * be changed. session_save_path needs to be called + * before session_start for that purpose. + * + * + * + * On some operating systems, you may want to specify a path on a + * filesystem that handles lots of small files efficiently. For example, + * on Linux, reiserfs may provide better performance than ext2fs. + * + * + * + * On some operating systems, you may want to specify a path on a + * filesystem that handles lots of small files efficiently. For example, + * on Linux, reiserfs may provide better performance than ext2fs. + * @return string Returns the path of the current directory used for data storage. + * @throws SessionException + * + */ +function session_save_path(string $path = null): string +{ + error_clear_last(); + if ($path !== null) { + $result = \session_save_path($path); + } else { + $result = \session_save_path(); + } + if ($result === false) { + throw SessionException::createFromPhpError(); + } + return $result; +} + + +/** * The session_unset function frees all session variables * currently registered. * |