AbstractProxy.
@author Drak <drak@zikula.org>
Expanded class hierarchy of AbstractProxy
abstract class AbstractProxy {
/**
* Flag if handler wraps an internal PHP session handler (using \SessionHandler).
*
* @var boolean
*/
protected $wrapper = false;
/**
* @var boolean
*/
protected $active = false;
/**
* @var string
*/
protected $saveHandlerName;
/**
* Gets the session.save_handler name.
*
* @return string
*/
public function getSaveHandlerName() {
return $this->saveHandlerName;
}
/**
* Is this proxy handler and instance of \SessionHandlerInterface.
*
* @return boolean
*/
public function isSessionHandlerInterface() {
return $this instanceof \SessionHandlerInterface;
}
/**
* Returns true if this handler wraps an internal PHP session save handler using \SessionHandler.
*
* @return Boolean
*/
public function isWrapper() {
return $this->wrapper;
}
/**
* Has a session started?
*
* @return Boolean
*/
public function isActive() {
return $this->active;
}
/**
* Sets the active flag.
*
* @param Boolean $flag
*/
public function setActive($flag) {
$this->active = (bool) $flag;
}
/**
* Gets the session ID.
*
* @return string
*/
public function getId() {
return session_id();
}
/**
* Sets the session ID.
*
* @param string $id
*/
public function setId($id) {
if ($this
->isActive()) {
throw new \LogicException('Cannot change the ID of an active session');
}
session_id($id);
}
/**
* Gets the session name.
*
* @return string
*/
public function getName() {
return session_name();
}
/**
* Sets the session name.
*
* @param string $name
*/
public function setName($name) {
if ($this
->isActive()) {
throw new \LogicException('Cannot change the name of an active session');
}
session_name($name);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AbstractProxy:: |
protected | property | ||
AbstractProxy:: |
protected | property | ||
AbstractProxy:: |
protected | property | Flag if handler wraps an internal PHP session handler (using \SessionHandler). | |
AbstractProxy:: |
public | function | Gets the session ID. | |
AbstractProxy:: |
public | function | Gets the session name. | |
AbstractProxy:: |
public | function | Gets the session.save_handler name. | |
AbstractProxy:: |
public | function | Has a session started? | |
AbstractProxy:: |
public | function | Is this proxy handler and instance of \SessionHandlerInterface. | |
AbstractProxy:: |
public | function | Returns true if this handler wraps an internal PHP session save handler using \SessionHandler. | 1 |
AbstractProxy:: |
public | function | Sets the active flag. | |
AbstractProxy:: |
public | function | Sets the session ID. | |
AbstractProxy:: |
public | function | Sets the session name. |