Inheritance diagram for Config:

Public Member Functions
	__construct (\Magento\Framework\ValidatorFactory $validatorFactory, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Stdlib\StringUtils $stringHelper, \Magento\Framework\App\RequestInterface $request, Filesystem $filesystem, DeploymentConfig $deploymentConfig, $scopeType, $lifetimePath=self::XML_PATH_COOKIE_LIFETIME)

	setOptions ($options, $default=[])

	getOptions ()

	setOption ($option, $value)

	getOption ($option)

	toArray ()

	setName ($name, $default=null)

	getName ()

	setSavePath ($savePath)

	getSavePath ()

	setCookieLifetime ($cookieLifetime, $default=null)

	getCookieLifetime ()

	setCookiePath ($cookiePath, $default=null)

	getCookiePath ()

	setCookieDomain ($cookieDomain, $default=null)

	getCookieDomain ()

	setCookieSecure ($cookieSecure)

	getCookieSecure ()

	setCookieHttpOnly ($cookieHttpOnly)

	getCookieHttpOnly ()

	setUseCookies ($useCookies)

	getUseCookies ()

	__call ($method, $args)

Public Member Functions inherited from ConfigInterface
	setOptions ($options)

	setName ($name)

	setCookieLifetime ($cookieLifetime)

	setCookiePath ($cookiePath)

	setCookieDomain ($cookieDomain)

Data Fields
const	PARAM_SESSION_SAVE_METHOD = 'session/save'

const	PARAM_SESSION_SAVE_PATH = 'session/save_path'

const	PARAM_SESSION_CACHE_LIMITER = 'session/cache_limiter'

const	XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain'

const	XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime'

const	XML_PATH_COOKIE_HTTPONLY = 'web/cookie/cookie_httponly'

const	XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path'

const	COOKIE_LIFETIME_DEFAULT = 3600

Protected Member Functions
	getStorageOption ($option)

	getFixedOptionName ($option)

Protected Attributes
	$options = []

	$_scopeConfig

	$_stringHelper

	$_httpRequest

	$booleanOptions

	$_scopeType

	$lifetimePath

	$_validatorFactory

Detailed Description

Magento session configuration

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 20 of file Config.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\ValidatorFactory	$validatorFactory,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Stdlib\StringUtils	$stringHelper,
		\Magento\Framework\App\RequestInterface	$request,
		Filesystem	$filesystem,
		DeploymentConfig	$deploymentConfig,
			$scopeType,
			$lifetimePath = `self::XML_PATH_COOKIE_LIFETIME`
	)

Parameters

\Magento\Framework\ValidatorFactory	$validatorFactory
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Stdlib\StringUtils	$stringHelper
\Magento\Framework\App\RequestInterface	$request
Filesystem	$filesystem
DeploymentConfig	$deploymentConfig
string	$scopeType
string	$lifetimePath	@SuppressWarnings(PHPMD.NPathComplexity)

Session path

Session save handler - memcache, files, etc

Session cache limiter

Cookie settings: lifetime, path, domain, httpOnly. These govern settings for the session cookie.

Definition at line 106 of file Config.php.

       {
         $this->_validatorFactory = $validatorFactory;
         $this->_scopeConfig = $scopeConfig;
         $this->_stringHelper = $stringHelper;
         $this->_httpRequest = $request;
         $this->_scopeType = $scopeType;
         $this->lifetimePath = $lifetimePath;
 
         $savePath = $deploymentConfig->get(self::PARAM_SESSION_SAVE_PATH);
         if (!$savePath && !ini_get('session.save_path')) {
             $sessionDir = $filesystem->getDirectoryWrite(DirectoryList::SESSION);
             $savePath = $sessionDir->getAbsolutePath();
             $sessionDir->create();
         }
         if ($savePath) {
             $this->setSavePath($savePath);
         }
 
         $saveHandler = $deploymentConfig->get(self::PARAM_SESSION_SAVE_METHOD);
         if ($saveHandler) {
             $this->setOption('session.save_handler', $saveHandler);
         }
 
         $cacheLimiter = $deploymentConfig->get(self::PARAM_SESSION_CACHE_LIMITER);
         if ($cacheLimiter) {
             $this->setOption('session.cache_limiter', $cacheLimiter);
         }
 
         $lifetime = $this->_scopeConfig->getValue($this->lifetimePath, $this->_scopeType);
         $this->setCookieLifetime($lifetime, self::COOKIE_LIFETIME_DEFAULT);
 
         $path = $this->_scopeConfig->getValue(self::XML_PATH_COOKIE_PATH, $this->_scopeType);
         $path = empty($path) ? $this->_httpRequest->getBasePath() : $path;
         $this->setCookiePath($path, $this->_httpRequest->getBasePath());
 
         $domain = $this->_scopeConfig->getValue(self::XML_PATH_COOKIE_DOMAIN, $this->_scopeType);
         $domain = empty($domain) ? $this->_httpRequest->getHttpHost() : $domain;
         $this->setCookieDomain((string)$domain, $this->_httpRequest->getHttpHost());
 
         $this->setCookieHttpOnly(
             $this->_scopeConfig->getValue(self::XML_PATH_COOKIE_HTTPONLY, $this->_scopeType)
         );
 
         $secureURL = $this->_scopeConfig->getValue('web/secure/base_url', $this->_scopeType);
         $unsecureURL = $this->_scopeConfig->getValue('web/unsecure/base_url', $this->_scopeType);
         $isFullySecuredURL = $secureURL == $unsecureURL;
         $this->setCookieSecure($isFullySecuredURL && $this->_httpRequest->isSecure());
     }

Member Function Documentation

◆ __call()

__call	(	$method,
		$args
	)

Intercept get*() and set*() methods

Intercepts getters and setters and passes them to getOption() and setOption(), respectively.

Parameters

string	$method
array	$args

Returns: mixed

Exceptions

Definition at line 523 of file Config.php.

     {
         $prefix = substr($method, 0, 3);
         $option = substr($method, 3);
         $key = strtolower(preg_replace('#(?<=[a-z])([A-Z])#', '_\1', $option));
 
         if ($prefix === 'set') {
             $value = array_shift($args);
             return $this->setOption($key, $value);
         } elseif ($prefix === 'get') {
             return $this->getOption($key);
         } else {
             throw new \BadMethodCallException(sprintf('Method "%s" does not exist in %s', $method, get_class($this)));
         }
     }

◆ getCookieDomain()

getCookieDomain ( )

Get session.cookie_domain

Returns: string

Implements ConfigInterface.

Definition at line 398 of file Config.php.

     {
         return (string)$this->getOption('session.cookie_domain');
     }

◆ getCookieHttpOnly()

getCookieHttpOnly ( )

Get session.cookie_httponly

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements ConfigInterface.

Definition at line 444 of file Config.php.

     {
         return (bool)$this->getOption('session.cookie_httponly');
     }

◆ getCookieLifetime()

getCookieLifetime ( )

Get session.cookie_lifetime

Returns: int

Implements ConfigInterface.

Definition at line 333 of file Config.php.

     {
         return (int)$this->getOption('session.cookie_lifetime');
     }

◆ getCookiePath()

getCookiePath ( )

Get session.cookie_path

Returns: string

Implements ConfigInterface.

Definition at line 366 of file Config.php.

     {
         return (string)$this->getOption('session.cookie_path');
     }

◆ getCookieSecure()

getCookieSecure ( )

Get session.cookie_secure

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements ConfigInterface.

Definition at line 421 of file Config.php.

     {
         return (bool)$this->getOption('session.cookie_secure');
     }

◆ getFixedOptionName()

getFixedOptionName ( $option )

protected

Fix session option name

Parameters

string $option

Returns: string

Definition at line 494 of file Config.php.

     {
         $option = strtolower($option);
 
         switch ($option) {
             case 'url_rewriter_tags':
                 $option = 'url_rewriter.tags';
                 break;
             default:
                 if (strpos($option, 'session.') !== 0) {
                     $option = 'session.' . $option;
                 }
                 break;
         }
 
         return $option;
     }

◆ getName()

getName ( )

Get session.name

Returns: string

Implements ConfigInterface.

Definition at line 279 of file Config.php.

     {
         return (string)$this->getOption('session.name');
     }

◆ getOption()

getOption ( $option )

Get an individual option

Parameters

string $option

Returns: mixed

Implements ConfigInterface.

Definition at line 230 of file Config.php.

     {
         $option = $this->getFixedOptionName($option);
         if (array_key_exists($option, $this->options)) {
             return $this->options[$option];
         }
 
         $value = $this->getStorageOption($option);
         if (null !== $value) {
             $this->options[$option] = $value;
             return $value;
         }
 
         return null;
     }

◆ getOptions()

getOptions ( )

Get all options set

Returns: array

Implements ConfigInterface.

Definition at line 204 of file Config.php.

     {
         return $this->options;
     }

◆ getSavePath()

getSavePath ( )

Set session.save_path

Returns: string

Implements ConfigInterface.

Definition at line 301 of file Config.php.

     {
         return (string)$this->getOption('session.save_path');
     }

◆ getStorageOption()

getStorageOption ( $option )

protected

Retrieve a storage option from a backend configuration store

Parameters

string $option

Returns: string|bool

Definition at line 478 of file Config.php.

     {
         $value = ini_get($option);
         if (in_array($option, $this->booleanOptions)) {
             $value = (bool)$value;
         }
 
         return $value;
     }

◆ getUseCookies()

getUseCookies ( )

Get session.use_cookies

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements ConfigInterface.

Definition at line 467 of file Config.php.

     {
         return (bool)$this->getOption('session.use_cookies');
     }

◆ setCookieDomain()

setCookieDomain	(	$cookieDomain,
		$default = `null`
	)

Set session.cookie_domain

Parameters

string	$cookieDomain
string \| null	$default

Returns: $this

Definition at line 378 of file Config.php.

     {
         $validator = $this->_validatorFactory->create(
             [],
             \Magento\Framework\Session\Config\Validator\CookieDomainValidator::class
         );
         if ($validator->isValid($cookieDomain)) {
             $this->setOption('session.cookie_domain', $cookieDomain);
         } elseif (null !== $default && $validator->isValid($default)) {
             $this->setOption('session.cookie_domain', $default);
         }
 
         return $this;
     }

◆ setCookieHttpOnly()

setCookieHttpOnly ( $cookieHttpOnly )

Set session.cookie_httponly

Parameters

bool $cookieHttpOnly

Returns: $this

Implements ConfigInterface.

Definition at line 432 of file Config.php.

     {
         $this->setOption('session.cookie_httponly', (bool)$cookieHttpOnly);
         return $this;
     }

◆ setCookieLifetime()

setCookieLifetime	(	$cookieLifetime,
		$default = `null`
	)

Set session.cookie_lifetime

Parameters

int	$cookieLifetime
int \| null	$default

Returns: $this

Definition at line 313 of file Config.php.

     {
         $validator = $this->_validatorFactory->create(
             [],
             \Magento\Framework\Session\Config\Validator\CookieLifetimeValidator::class
         );
         if ($validator->isValid($cookieLifetime)) {
             $this->setOption('session.cookie_lifetime', (int)$cookieLifetime);
         } elseif (null !== $default && $validator->isValid($default)) {
             $this->setOption('session.cookie_lifetime', (int)$default);
         }
 
         return $this;
     }

◆ setCookiePath()

setCookiePath	(	$cookiePath,
		$default = `null`
	)

Set session.cookie_path

Parameters

string	$cookiePath
string \| null	$default

Returns: $this

Definition at line 345 of file Config.php.

     {
         $cookiePath = (string)$cookiePath;
         $validator = $this->_validatorFactory->create(
             [],
             \Magento\Framework\Session\Config\Validator\CookiePathValidator::class
         );
         if ($validator->isValid($cookiePath)) {
             $this->setOption('session.cookie_path', $cookiePath);
         } elseif (null !== $default && $validator->isValid($default)) {
             $this->setOption('session.cookie_path', $default);
         }
 
         return $this;
     }

◆ setCookieSecure()

setCookieSecure ( $cookieSecure )

Set session.cookie_secure

Parameters

bool $cookieSecure

Returns: $this

Implements ConfigInterface.

Definition at line 409 of file Config.php.

     {
         $this->setOption('session.cookie_secure', (bool)$cookieSecure);
         return $this;
     }

◆ setName()

setName	(	$name,
		$default = `null`
	)

Set session.name

Parameters

string	$name
string \| null	$default

Returns: $this

Definition at line 263 of file Config.php.

     {
         $name = (string)$name;
         $name = empty($name) ? $default : $name;
         if (!empty($name)) {
             $this->setOption('session.name', $name);
         }
 
         return $this;
     }

◆ setOption()

setOption	(	$option,
		$value
	)

Set an individual option

Parameters

string	$option
mixed	$value

Returns: $this

Implements ConfigInterface.

Definition at line 216 of file Config.php.

     {
         $option = $this->getFixedOptionName($option);
         $this->options[$option] = $value;
 
         return $this;
     }

◆ setOptions()

setOptions	(	$options,
		$default = `[]`
	)

Set many options at once

Parameters

array	$options
array	$default

Returns: $this

Definition at line 183 of file Config.php.

     {
         $options = (!is_array($options) && !$options instanceof \Traversable) ? $default : $options;
         if (is_array($options) || $options instanceof \Traversable) {
             foreach ($options as $option => $value) {
                 $setter = 'set' . $this->_stringHelper->upperCaseWords($option, '_', '');
                 if (method_exists($this, $setter)) {
                     $this->{$setter}($value);
                 } else {
                     $this->setOption($option, $value);
                 }
             }
         }
         return $this;
     }

◆ setSavePath()

setSavePath ( $savePath )

Set session.save_path

Parameters

string $savePath

Returns: $this

Implements ConfigInterface.

Definition at line 290 of file Config.php.

     {
         $this->setOption('session.save_path', $savePath);
         return $this;
     }

◆ setUseCookies()

setUseCookies ( $useCookies )

Set session.use_cookies

Parameters

bool $useCookies

Returns: $this

Implements ConfigInterface.

Definition at line 455 of file Config.php.

     {
         $this->setOption('session.use_cookies', (bool)$useCookies);
         return $this;
     }

◆ toArray()

toArray ( )

Convert config to array

Returns: array

Implements ConfigInterface.

Definition at line 251 of file Config.php.

     {
         return $this->getOptions();
     }

Field Documentation

◆ $_httpRequest

$_httpRequest

protected

Definition at line 66 of file Config.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 56 of file Config.php.

◆ $_scopeType

$_scopeType

protected

Definition at line 83 of file Config.php.

◆ $_stringHelper

$_stringHelper

protected

Definition at line 61 of file Config.php.

◆ $_validatorFactory

$_validatorFactory

protected

Definition at line 93 of file Config.php.

◆ $booleanOptions

$booleanOptions

protected

Initial value:

= [
        'session.use_cookies',
        'session.use_only_cookies',
        'session.use_trans_sid',
        'session.cookie_httponly',
    ]

Definition at line 73 of file Config.php.

◆ $lifetimePath

$lifetimePath

protected

Definition at line 88 of file Config.php.

◆ $options

$options = []

protected

Definition at line 51 of file Config.php.

◆ COOKIE_LIFETIME_DEFAULT

const COOKIE_LIFETIME_DEFAULT = 3600

Cookie default lifetime

Definition at line 44 of file Config.php.

◆ PARAM_SESSION_CACHE_LIMITER

const PARAM_SESSION_CACHE_LIMITER = 'session/cache_limiter'

Configuration path for session cache limiter

Definition at line 29 of file Config.php.

◆ PARAM_SESSION_SAVE_METHOD

const PARAM_SESSION_SAVE_METHOD = 'session/save'

Configuration path for session save method

Definition at line 23 of file Config.php.

◆ PARAM_SESSION_SAVE_PATH

const PARAM_SESSION_SAVE_PATH = 'session/save_path'

Configuration path for session save path

Definition at line 26 of file Config.php.

◆ XML_PATH_COOKIE_DOMAIN

const XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain'

Configuration path for cookie domain

Definition at line 32 of file Config.php.

◆ XML_PATH_COOKIE_HTTPONLY

const XML_PATH_COOKIE_HTTPONLY = 'web/cookie/cookie_httponly'

Configuration path for cookie http only param

Definition at line 38 of file Config.php.

◆ XML_PATH_COOKIE_LIFETIME

const XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime'

Configuration path for cookie lifetime

Definition at line 35 of file Config.php.

◆ XML_PATH_COOKIE_PATH

const XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path'

Configuration path for cookie path

Definition at line 41 of file Config.php.

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

vendor/magento/framework/Session/Config.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ getCookieDomain()

◆ getCookieHttpOnly()

◆ getCookieLifetime()

◆ getCookiePath()

◆ getCookieSecure()

◆ getFixedOptionName()

◆ getName()

◆ getOption()

◆ getOptions()

◆ getSavePath()

◆ getStorageOption()

◆ getUseCookies()

◆ setCookieDomain()

◆ setCookieHttpOnly()

◆ setCookieLifetime()

◆ setCookiePath()

◆ setCookieSecure()

◆ setName()

◆ setOption()

◆ setOptions()

◆ setSavePath()

◆ setUseCookies()

◆ toArray()

Field Documentation

◆ $_httpRequest

◆ $_scopeConfig

◆ $_scopeType

◆ $_stringHelper

◆ $_validatorFactory

◆ $booleanOptions

◆ $lifetimePath

◆ $options

◆ COOKIE_LIFETIME_DEFAULT

◆ PARAM_SESSION_CACHE_LIMITER

◆ PARAM_SESSION_SAVE_METHOD

◆ PARAM_SESSION_SAVE_PATH

◆ XML_PATH_COOKIE_DOMAIN

◆ XML_PATH_COOKIE_HTTPONLY

◆ XML_PATH_COOKIE_LIFETIME

◆ XML_PATH_COOKIE_PATH