Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Data Structures | Public Member Functions | Protected Attributes
SaveHandler Class Reference
Inheritance diagram for SaveHandler:
SaveHandlerInterface

Data Structures

class  DbTableTest
 

Public Member Functions

 __construct (SaveHandlerFactory $saveHandlerFactory, ConfigInterface $sessionConfig, $default=self::DEFAULT_HANDLER)
 
 open ($savePath, $name)
 
 close ()
 
 read ($sessionId)
 
 write ($sessionId, $data)
 
 destroy ($sessionId)
 
 gc ($maxLifetime)
 

Protected Attributes

 $saveHandlerAdapter
 

Additional Inherited Members

- Data Fields inherited from SaveHandlerInterface
const DEFAULT_HANDLER = 'files'
 

Detailed Description

Magento session save handler

Definition at line 14 of file SaveHandler.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( SaveHandlerFactory  $saveHandlerFactory,
ConfigInterface  $sessionConfig,
  $default = self::DEFAULT_HANDLER 
)

Constructor

Parameters
SaveHandlerFactory$saveHandlerFactory
ConfigInterface$sessionConfig
string$default

Session handler

Save handler may be set to custom value in deployment config, which will override everything else. Otherwise, try to read PHP settings for session.save_handler value. Otherwise, use 'files' as default.

Definition at line 30 of file SaveHandler.php.

34  {
41  $saveMethod = $sessionConfig->getOption('session.save_handler') ?: $default;
42 
43  try {
44  $this->saveHandlerAdapter = $saveHandlerFactory->create($saveMethod);
45  } catch (SessionException $e) {
46  $this->saveHandlerAdapter = $saveHandlerFactory->create($default);
47  }
48  }

Member Function Documentation

◆ close()

close ( )

Close Session - free resources

Returns
bool

Definition at line 67 of file SaveHandler.php.

68  {
69  return $this->saveHandlerAdapter->close();
70  }

◆ destroy()

destroy (   $sessionId)

Destroy Session - remove data from resource for given session id

Parameters
string$sessionId
Returns
bool

Definition at line 101 of file SaveHandler.php.

102  {
103  return $this->saveHandlerAdapter->destroy($sessionId);
104  }

◆ gc()

gc (   $maxLifetime)

Garbage Collection - remove old session data older than $maxLifetime (in seconds)

Parameters
int$maxLifetime
Returns
bool @SuppressWarnings(PHPMD.ShortMethodName)

Definition at line 114 of file SaveHandler.php.

115  {
116  return $this->saveHandlerAdapter->gc($maxLifetime);
117  }

◆ open()

open (   $savePath,
  $name 
)

Open Session - retrieve resources

Parameters
string$savePath
string$name
Returns
bool

Definition at line 57 of file SaveHandler.php.

58  {
59  return $this->saveHandlerAdapter->open($savePath, $name);
60  }
if(!isset($_GET['name'])) $name
Definition: log.php:14

◆ read()

read (   $sessionId)

Read session data

Parameters
string$sessionId
Returns
string

Definition at line 78 of file SaveHandler.php.

79  {
80  return $this->saveHandlerAdapter->read($sessionId);
81  }

◆ write()

write (   $sessionId,
  $data 
)

Write Session - commit data to resource

Parameters
string$sessionId
string$data
Returns
bool

Definition at line 90 of file SaveHandler.php.

91  {
92  return $this->saveHandlerAdapter->write($sessionId, $data);
93  }

Field Documentation

◆ $saveHandlerAdapter

$saveHandlerAdapter
protected

Definition at line 21 of file SaveHandler.php.


The documentation for this class was generated from the following file: