mirror of
https://github.com/friendica/friendica
synced 2025-03-28 12:41:26 +00:00
23dda5d510
- It is more efficient to use the null coalescing operator ?? that prevents the computation of the default value if the key has been found
96 lines
2.4 KiB
PHP
96 lines
2.4 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2010-2022, the Friendica project
|
|
*
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
namespace Friendica\Core\Session\Capability;
|
|
|
|
/**
|
|
* Contains all global supported Session methods
|
|
*/
|
|
interface IHandleSessions
|
|
{
|
|
/**
|
|
* Start the current session
|
|
*
|
|
* @return self The own Session instance
|
|
*/
|
|
public function start(): IHandleSessions;
|
|
|
|
/**
|
|
* Checks if the key exists in this session
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return boolean True, if it exists
|
|
*/
|
|
public function exists(string $name): bool;
|
|
|
|
/**
|
|
* Retrieves a key from the session super global or the defaults if the key is missing or the value is falsy.
|
|
*
|
|
* Handle the case where session_start() hasn't been called and the super global isn't available.
|
|
*
|
|
* @param string $name
|
|
* @param mixed $defaults Deprecated, use `Session->get($name) ?? $defaults` instead
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function get(string $name, $defaults = null);
|
|
|
|
/**
|
|
* Retrieves a value from the provided key if it exists and removes it from session
|
|
*
|
|
* @param string $name
|
|
* @param mixed $defaults Deprecated, use `Session->pop($name) ?? $defaults` instead
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function pop(string $name, $defaults = null);
|
|
|
|
/**
|
|
* Sets a single session variable.
|
|
* Overrides value of existing key.
|
|
*
|
|
* @param string $name
|
|
* @param mixed $value
|
|
*/
|
|
public function set(string $name, $value);
|
|
|
|
/**
|
|
* Sets multiple session variables.
|
|
* Overrides values for existing keys.
|
|
*
|
|
* @param array $values
|
|
*/
|
|
public function setMultiple(array $values);
|
|
|
|
/**
|
|
* Removes a session variable.
|
|
* Ignores missing keys.
|
|
*
|
|
* @param string $name
|
|
*/
|
|
public function remove(string $name);
|
|
|
|
/**
|
|
* Clears the current session array
|
|
*/
|
|
public function clear();
|
|
}
|