paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
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 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\Session; /** * Expected behavior of a session container used with CodeIgniter. */ interface SessionInterface { /** * Regenerates the session ID. * * @param boolean $destroy Should old session data be destroyed? */ public function regenerate(bool $destroy = false); //-------------------------------------------------------------------- /** * Destroys the current session. */ public function destroy(); //-------------------------------------------------------------------- /** * Sets user data into the session. * * If $data is a string, then it is interpreted as a session property * key, and $value is expected to be non-null. * * If $data is an array, it is expected to be an array of key/value pairs * to be set as session properties. * * @param string|array $data Property name or associative array of properties * @param string|array $value Property value if single key provided */ public function set($data, $value = null); //-------------------------------------------------------------------- /** * Get user data that has been set in the session. * * If the property exists as "normal", returns it. * Otherwise, returns an array of any temp or flash data values with the * property key. * * Replaces the legacy method $session->userdata(); * * @param string $key Identifier of the session property to retrieve * * @return array|null The property value(s) */ public function get(string $key = null); //-------------------------------------------------------------------- /** * Returns whether an index exists in the session array. * * @param string $key Identifier of the session property we are interested in. * * @return boolean */ public function has(string $key): bool; //-------------------------------------------------------------------- /** * Remove one or more session properties. * * If $key is an array, it is interpreted as an array of string property * identifiers to remove. Otherwise, it is interpreted as the identifier * of a specific session property to remove. * * @param string|array $key Identifier of the session property or properties to remove. */ public function remove($key); //-------------------------------------------------------------------- /** * Sets data into the session that will only last for a single request. * Perfect for use with single-use status update messages. * * If $data is an array, it is interpreted as an associative array of * key/value pairs for flashdata properties. * Otherwise, it is interpreted as the identifier of a specific * flashdata property, with $value containing the property value. * * @param string|array $data Property identifier or associative array of properties * @param string|array $value Property value if $data is a scalar */ public function setFlashdata($data, $value = null); //-------------------------------------------------------------------- /** * Retrieve one or more items of flash data from the session. * * If the item key is null, return all flashdata. * * @param string $key Property identifier * @return array|null The requested property value, or an associative * array of them */ public function getFlashdata(string $key = null); //-------------------------------------------------------------------- /** * Keeps a single piece of flash data alive for one more request. * * @param array|string $key Property identifier or array of them */ public function keepFlashdata($key); //-------------------------------------------------------------------- /** * Mark a session property or properties as flashdata. * * @param string|array $key Property identifier or array of them * * @return False if any of the properties are not already set */ public function markAsFlashdata($key); //-------------------------------------------------------------------- /** * Unmark data in the session as flashdata. * * @param string|array $key Property identifier or array of them */ public function unmarkFlashdata($key); //-------------------------------------------------------------------- /** * Retrieve all of the keys for session data marked as flashdata. * * @return array The property names of all flashdata */ public function getFlashKeys(): array; //-------------------------------------------------------------------- /** * Sets new data into the session, and marks it as temporary data * with a set lifespan. * * @param string|array $data Session data key or associative array of items * @param mixed $value Value to store * @param integer $ttl Time-to-live in seconds */ public function setTempdata($data, $value = null, int $ttl = 300); //-------------------------------------------------------------------- /** * Returns either a single piece of tempdata, or all temp data currently * in the session. * * @param string $key Session data key * @return mixed Session data value or null if not found. */ public function getTempdata(string $key = null); //-------------------------------------------------------------------- /** * Removes a single piece of temporary data from the session. * * @param string $key Session data key */ public function removeTempdata(string $key); //-------------------------------------------------------------------- /** * Mark one of more pieces of data as being temporary, meaning that * it has a set lifespan within the session. * * @param string|array $key Property identifier or array of them * @param integer $ttl Time to live, in seconds * * @return boolean False if any of the properties were not set */ public function markAsTempdata($key, int $ttl = 300); //-------------------------------------------------------------------- /** * Unmarks temporary data in the session, effectively removing its * lifespan and allowing it to live as long as the session does. * * @param string|array $key Property identifier or array of them */ public function unmarkTempdata($key); //-------------------------------------------------------------------- /** * Retrieve the keys of all session data that have been marked as temporary data. * * @return array */ public function getTempKeys(): array; //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/Session/SessionInterface.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |