SaveHandler Class Reference

Inheritance diagram for SaveHandler:

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.

      {
        $saveMethod = $sessionConfig->getOption('session.save_handler') ?: $default;

        try {
            $this->saveHandlerAdapter = $saveHandlerFactory->create($saveMethod);
        } catch (SessionException $e) {
            $this->saveHandlerAdapter = $saveHandlerFactory->create($default);
        }
    }

Member Function Documentation

close()

close

(

)

Close Session - free resources

Returns

bool

Definition at line 67 of file SaveHandler.php.

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

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.

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

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.

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

open()

open	(		$savePath,
			$name
	)

Open Session - retrieve resources

Parameters

string	$savePath
string	$name

Returns

bool

Definition at line 57 of file SaveHandler.php.

    {
        return $this->saveHandlerAdapter->open($savePath, $name);
    }

read()

read

(

$sessionId

)

Read session data

Parameters

string

$sessionId

Returns

string

Definition at line 78 of file SaveHandler.php.

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

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.

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

Field Documentation

$saveHandlerAdapter

$saveHandlerAdapter

protected

Definition at line 21 of file SaveHandler.php.

---

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

• vendor/magento/framework/Session/SaveHandler.php