| [ Index ] | PHP Cross Reference of phpBB-3.3.14-deutsch | 
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 466 lines (14 kb) | 
| Included or required: | 0 times | 
| Referenced: | 0 times | 
| Includes or requires: | 0 files | 
NativeSessionStorage:: (18 methods):
  __construct()
  getSaveHandler()
  start()
  getId()
  setId()
  getName()
  setName()
  regenerate()
  save()
  clear()
  registerBag()
  getBag()
  setMetadataBag()
  getMetadataBag()
  isStarted()
  setOptions()
  setSaveHandler()
  loadSession()
Class: NativeSessionStorage - X-Ref
This provides a base class for session attribute storage.| __construct(array $options = [], $handler = null, MetadataBag $metaBag = null) X-Ref | 
| Depending on how you want the storage driver to behave you probably want to override this constructor entirely. List of options for $options array with their defaults. param: AbstractProxy|\SessionHandlerInterface|null $handler | 
| getSaveHandler() X-Ref | 
| Gets the save handler instance. return: AbstractProxy|\SessionHandlerInterface | 
| start() X-Ref | 
| {@inheritdoc} | 
| getId() X-Ref | 
| {@inheritdoc} | 
| setId($id) X-Ref | 
| {@inheritdoc} | 
| getName() X-Ref | 
| {@inheritdoc} | 
| setName($name) X-Ref | 
| {@inheritdoc} | 
| regenerate($destroy = false, $lifetime = null) X-Ref | 
| {@inheritdoc} | 
| save() X-Ref | 
| {@inheritdoc} | 
| clear() X-Ref | 
| {@inheritdoc} | 
| registerBag(SessionBagInterface $bag) X-Ref | 
| {@inheritdoc} | 
| getBag($name) X-Ref | 
| {@inheritdoc} | 
| setMetadataBag(MetadataBag $metaBag = null) X-Ref | 
| No description | 
| getMetadataBag() X-Ref | 
| Gets the MetadataBag. return: MetadataBag | 
| isStarted() X-Ref | 
| {@inheritdoc} | 
| setOptions(array $options) X-Ref | 
| Sets session.* ini variables. For convenience we omit 'session.' from the beginning of the keys. Explicitly ignores other ini keys. param: array $options Session ini directives [key => value] | 
| setSaveHandler($saveHandler = null) X-Ref | 
| Registers session save handler as a PHP session handler. To use internal PHP session save handlers, override this method using ini_set with session.save_handler and session.save_path e.g. ini_set('session.save_handler', 'files'); ini_set('session.save_path', '/tmp'); or pass in a \SessionHandler instance which configures session.save_handler in the constructor, for a template see NativeFileSessionHandler. param: AbstractProxy|\SessionHandlerInterface|null $saveHandler | 
| loadSession(array &$session = null) X-Ref | 
| Load the session with attributes. After starting the session, PHP retrieves the session from whatever handlers are set to (either PHP's internal, or a custom save handler set with session_set_save_handler()). PHP takes the return value from the read() handler, unserializes it and populates $_SESSION with the result automatically. | 
| Generated: Mon Nov 25 19:05:08 2024 | Cross-referenced by PHPXref 0.7.1 |