Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
Session Class Reference
Inheritance diagram for Session:
SessionManager SessionManagerInterface

Public Member Functions

 addError ($message)
 
 addSuccess ($message)
 
 getError ()
 
 getSuccess ()
 
- Public Member Functions inherited from SessionManager
 __construct (\Magento\Framework\App\Request\Http $request, SidResolverInterface $sidResolver, ConfigInterface $sessionConfig, SaveHandlerInterface $saveHandler, ValidatorInterface $validator, StorageInterface $storage, \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager, \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory, \Magento\Framework\App\State $appState)
 
 writeClose ()
 
 __call ($method, $args)
 
 start ()
 
 isSessionExists ()
 
 getData ($key='', $clear=false)
 
 getSessionId ()
 
 getName ()
 
 setName ($name)
 
 destroy (array $options=null)
 
 clearStorage ()
 
 getCookieDomain ()
 
 getCookiePath ()
 
 getCookieLifetime ()
 
 setSessionId ($sessionId)
 
 getSessionIdForHost ($urlHost)
 
 isValidForHost ($host)
 
 isValidForPath ($path)
 
 regenerateId ()
 
 expireSessionCookie ()
 

Additional Inherited Members

- Data Fields inherited from SessionManagerInterface
const HOST_KEY = '_session_hosts'
 
- Protected Member Functions inherited from SessionManager
 registerSaveHandler ()
 
 _addHost ()
 
 _getHosts ()
 
 _cleanHosts ()
 
 clearSubDomainSessionCookie ()
 
- Protected Attributes inherited from SessionManager
 $defaultDestroyOptions = ['send_expire_cookie' => true, 'clear_storage' => true]
 
 $validator
 
 $request
 
 $sidResolver
 
 $sessionConfig
 
 $saveHandler
 
 $storage
 
 $cookieManager
 
 $cookieMetadataFactory
 
- Static Protected Attributes inherited from SessionManager
static $urlHostCache = []
 

Detailed Description

Newsletter session model

Definition at line 11 of file Session.php.

Member Function Documentation

◆ addError()

addError (   $message)

Set error message

Parameters
string$message
Returns
$this

Definition at line 19 of file Session.php.

20  {
21  $this->setErrorMessage($message);
22  return $this;
23  }
$message

◆ addSuccess()

addSuccess (   $message)

Set success message

Parameters
string$message
Returns
$this

Definition at line 31 of file Session.php.

32  {
33  $this->setSuccessMessage($message);
34  return $this;
35  }
$message

◆ getError()

getError ( )

Get error message

Returns
string $message

Definition at line 42 of file Session.php.

43  {
44  $message = $this->getErrorMessage();
45  $this->unsErrorMessage();
46  return $message;
47  }
$message

◆ getSuccess()

getSuccess ( )

Get success message

Returns
string $message

Definition at line 54 of file Session.php.

55  {
56  $message = $this->getSuccessMessage();
57  $this->unsSuccessMessage();
58  return $message;
59  }
$message

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