Redis Class Reference

Inheritance diagram for Redis:

Public Member Functions
	__construct (ConfigInterface $config, LoggerInterface $logger, Filesystem $filesystem)
	open ($savePath, $sessionName)
	read ($sessionId)
	write ($sessionId, $sessionData)
	destroy ($sessionId)
	close ()
	gc ($maxLifeTime)
	getFailedLockAttempts ()

Detailed Description

Definition at line 17 of file Redis.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ConfigInterface	$config,
		LoggerInterface	$logger,
		Filesystem	$filesystem
	)

Parameters

ConfigInterface	$config
LoggerInterface	$logger
Filesystem	$filesystem

Exceptions

SessionException

Definition at line 45 of file Redis.php.

    {
        $this->config = $config;
        $this->logger = $logger;
        $this->filesystem = $filesystem;
    }

Member Function Documentation

close()

close

(

)

Overridden to prevent calling getLifeTime at shutdown

Returns

bool

Exceptions

SessionException

Definition at line 132 of file Redis.php.

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

destroy()

destroy

(

$sessionId

)

Destroy session

Parameters

string

$sessionId

Returns

boolean

Exceptions

SessionException

Definition at line 121 of file Redis.php.

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

gc()

gc

(

$maxLifeTime

)

Garbage collection

Parameters

int

$maxLifeTime

ignored

Returns

boolean

Exceptions

SessionException

@SuppressWarnings(PHPMD.ShortMethodName)

Definition at line 145 of file Redis.php.

    {
        return $this->getConnection()->gc($maxLifeTime);
    }

getFailedLockAttempts()

getFailedLockAttempts

(

)

Get the number of failed lock attempts

Returns

int

Exceptions

SessionException

Definition at line 156 of file Redis.php.

    {
        return $this->getConnection()->getFailedLockAttempts();
    }

open()

open	(		$savePath,
			$sessionName
	)

Open session

Parameters

string	$savePath	ignored
string	$sessionName	ignored

Returns

bool

Exceptions

SessionException

Definition at line 79 of file Redis.php.

    {
        return $this->getConnection()->open($savePath, $sessionName);
    }

read()

read

(

$sessionId

)

Fetch session data

Parameters

string

$sessionId

Returns

string

Exceptions

ConcurrentConnectionsExceededException
SessionException

Definition at line 92 of file Redis.php.

    {
        try {
            return $this->getConnection()->read($sessionId);
        } catch (ConcurrentConnectionsExceededException $e) {
            require $this->filesystem->getDirectoryRead(DirectoryList::PUB)->getAbsolutePath('errors/503.php');
        }
    }

write()

write	(		$sessionId,
			$sessionData
	)

Update session

Parameters

string	$sessionId
string	$sessionData

Returns

boolean

Exceptions

SessionException

Definition at line 109 of file Redis.php.

    {
        return $this->getConnection()->write($sessionId, $sessionData);
    }

---

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

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