Files
sysPass/lib/SP/Core/Context/ContextBase.php
nuxsmin 4d6104b839 * [ADD] API module. Work in progress.
* [ADD] Upgrade service. Work in progress.
* [MOD] Context based session data. Added collection class to manage session properties.
* [MOD] Code refactoring.
* [MOD] Improved theme icons load by caching objects.
2018-03-13 02:01:09 +01:00

124 lines
3.2 KiB
PHP

<?php
/**
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Core\Context;
/**
* Class ContextBase
*
* @package SP\Core\Session
*/
abstract class ContextBase implements ContextInterface
{
const APP_STATUS_UPDATED = 'updated';
const APP_STATUS_RELOADED = 'reloaded';
const APP_STATUS_INSTALLED = 'installed';
const APP_STATUS_LOGGEDOUT = 'loggedout';
/**
* @var ContextCollection
*/
private $context;
/**
* @param $context
* @throws ContextException
*/
final protected function setContextReference(&$context)
{
if ($this->context !== null) {
throw new ContextException(__u('Contexto ya inicializado'));
}
if (isset($context['context'])
&& ($context['context'] instanceof ContextCollection) === false
) {
throw new ContextException(__u('Contexto inválido'));
} elseif (!isset($context['context'])) {
$context['context'] = $this->context = new ContextCollection();
return;
}
$this->context =& $context['context'];
}
/**
* @param ContextCollection $contextCollection
* @throws ContextException
*/
final protected function setContext(ContextCollection $contextCollection)
{
if ($this->context !== null) {
throw new ContextException(__u('Contexto ya inicializado'));
}
$this->context = $contextCollection;
}
/**
* Devolver una variable de contexto
*
* @param string $key
* @param mixed $default
* @return mixed
* @throws ContextException
*/
protected function getContextKey($key, $default = null)
{
$this->checkContext();
if (isset($this->context[$key])) {
return is_numeric($default) ? (int)$this->context[$key] : $this->context[$key];
}
return $default;
}
/**
* Establecer una variable de contexto
*
* @param string $key El nombre de la variable
* @param mixed $value El valor de la variable
* @return mixed
* @throws ContextException
*/
protected function setContextKey($key, $value)
{
$this->checkContext();
$this->context[$key] = $value;
return $value;
}
/**
* @throws ContextException
*/
private function checkContext()
{
if ($this->context === null) {
throw new ContextException(__u('Contexto no inicializado'));
}
}
}