Inheritance diagram for Visitor:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Session\SessionManagerInterface $session, \Magento\Framework\HTTP\Header $httpHeader, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Stdlib\DateTime $dateTime, \Magento\Framework\Indexer\IndexerRegistry $indexerRegistry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $ignoredUserAgents=[], array $ignores=[], array $data=[], RequestSafetyInterface $requestSafety=null)

	setSkipRequestLogging ($skipRequestLogging)

	initByRequest ($observer)

	saveByRequest ($observer)

	isModuleIgnored ($observer)

	bindCustomerLogout ($observer)

	bindQuoteCreate ($observer)

	bindQuoteDestroy ($observer)

	getCleanTime ()

	clean ()

	getOnlineInterval ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	VISITOR_TYPE_CUSTOMER = 'c'

const	VISITOR_TYPE_VISITOR = 'v'

const	DEFAULT_ONLINE_MINUTES_INTERVAL = 15

const	XML_PATH_ONLINE_INTERVAL = 'customer/online_customers/online_minutes_interval'

Protected Member Functions
	_construct ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$ignoredUserAgents

	$session

	$httpHeader

	$skipRequestLogging = false

	$ignores

	$scopeConfig

	$dateTime

	$indexerRegistry

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 17 of file Visitor.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Session\SessionManagerInterface	$session,
		\Magento\Framework\HTTP\Header	$httpHeader,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Stdlib\DateTime	$dateTime,
		\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$ignoredUserAgents = `[]`,
		array	$ignores = `[]`,
		array	$data = `[]`,
		RequestSafetyInterface	$requestSafety = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Session\SessionManagerInterface	$session
\Magento\Framework\HTTP\Header	$httpHeader
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Stdlib\DateTime	$dateTime
\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry
\Magento\Framework\Model\ResourceModel\AbstractResource \| null	$resource
\Magento\Framework\Data\Collection\AbstractDb \| null	$resourceCollection
array	$ignoredUserAgents
array	$ignores
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 92 of file Visitor.php.

       {
         $this->session = $session;
         $this->httpHeader = $httpHeader;
         $this->ignoredUserAgents = $ignoredUserAgents;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
         $this->ignores = $ignores;
         $this->scopeConfig = $scopeConfig;
         $this->dateTime = $dateTime;
         $this->indexerRegistry = $indexerRegistry;
         $this->requestSafety = $requestSafety ?? ObjectManager::getInstance()->get(RequestSafetyInterface::class);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Object initialization

Returns: void

Definition at line 123 of file Visitor.php.

     {
         $this->_init(\Magento\Customer\Model\ResourceModel\Visitor::class);
         $userAgent = $this->httpHeader->getHttpUserAgent();
         if ($this->ignoredUserAgents) {
             if (in_array($userAgent, $this->ignoredUserAgents)) {
                 $this->skipRequestLogging = true;
             }
         }
     }

◆ bindCustomerLogout()

bindCustomerLogout ( $observer )

Bind customer data when customer logout

Used in event "customer_logout"

Parameters

\Magento\Framework\Event\Observer $observer

Returns: \Magento\Customer\Model\Visitor @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 252 of file Visitor.php.

     {
         if ($this->getCustomerId()) {
             $this->setDoCustomerLogout(true);
         }
         return $this;
     }

◆ bindQuoteCreate()

bindQuoteCreate ( $observer )

Create binding of checkout quote

Parameters

\Magento\Framework\Event\Observer $observer

Returns: \Magento\Customer\Model\Visitor

Definition at line 266 of file Visitor.php.

     {
         $quote = $observer->getEvent()->getQuote();
         if ($quote) {
             if ($quote->getIsCheckoutCart()) {
                 $this->setQuoteId($quote->getId());
                 $this->setDoQuoteCreate(true);
             }
         }
         return $this;
     }

◆ bindQuoteDestroy()

bindQuoteDestroy ( $observer )

Destroy binding of checkout quote

Parameters

\Magento\Framework\Event\Observer $observer

Returns: \Magento\Customer\Model\Visitor

Definition at line 283 of file Visitor.php.

     {
         $quote = $observer->getEvent()->getQuote();
         if ($quote) {
             $this->setDoQuoteDestroy(true);
         }
         return $this;
     }

◆ clean()

clean ( )

Clean visitor's outdated records

Returns: $this

Definition at line 310 of file Visitor.php.

     {
         $this->getResource()->clean($this);
         return $this;
     }

◆ getCleanTime()

getCleanTime ( )

Return clean time in seconds for visitor's outdated records

Returns: string

Definition at line 297 of file Visitor.php.

     {
         return $this->scopeConfig->getValue(
             \Magento\Framework\Session\Config::XML_PATH_COOKIE_LIFETIME,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) + 86400;
     }

◆ getOnlineInterval()

getOnlineInterval ( )

Retrieve Online Interval (in minutes)

Returns: int Minutes Interval

Definition at line 321 of file Visitor.php.

     {
         $configValue = intval(
             $this->scopeConfig->getValue(
                 static::XML_PATH_ONLINE_INTERVAL,
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             )
         );
         return $configValue ?: static::DEFAULT_ONLINE_MINUTES_INTERVAL;
     }

◆ initByRequest()

initByRequest ( $observer )

Initialization visitor by request

Used in event "controller_action_predispatch"

Parameters

\Magento\Framework\Event\Observer $observer

Returns: \Magento\Customer\Model\Visitor

Definition at line 154 of file Visitor.php.

     {
         if ($this->skipRequestLogging || $this->isModuleIgnored($observer)) {
             return $this;
         }
 
         if ($this->session->getVisitorData()) {
             $this->setData($this->session->getVisitorData());
             if ($this->getSessionId() != $this->session->getSessionId()) {
                 $this->setSessionId($this->session->getSessionId());
             }
         }
 
         $this->setLastVisitAt((new \DateTime())->format(\Magento\Framework\Stdlib\DateTime::DATETIME_PHP_FORMAT));
 
         // prevent saving Visitor for safe methods, e.g. GET request
         if ($this->requestSafety->isSafeMethod()) {
             return $this;
         }
         if (!$this->getId()) {
             $this->setSessionId($this->session->getSessionId());
             $this->save();
             $this->_eventManager->dispatch('visitor_init', ['visitor' => $this]);
             $this->session->setVisitorData($this->getData());
         }
         return $this;
     }

◆ isModuleIgnored()

isModuleIgnored ( $observer )

Returns true if the module is required

Parameters

\Magento\Framework\Event\Observer $observer

Returns: bool

Definition at line 213 of file Visitor.php.

     {
         if (is_array($this->ignores) && $observer) {
             $curModule = $observer->getEvent()->getControllerAction()->getRequest()->getRouteName();
             if (isset($this->ignores[$curModule])) {
                 return true;
             }
         }
         return false;
     }

◆ saveByRequest()

saveByRequest ( $observer )

Save visitor by request

Used in event "controller_action_postdispatch"

Parameters

\Magento\Framework\Event\Observer $observer

Returns: \Magento\Customer\Model\Visitor

Definition at line 190 of file Visitor.php.

     {
         // prevent saving Visitor for safe methods, e.g. GET request
         if ($this->skipRequestLogging || $this->requestSafety->isSafeMethod() || $this->isModuleIgnored($observer)) {
             return $this;
         }
 
         try {
             $this->save();
             $this->_eventManager->dispatch('visitor_activity_save', ['visitor' => $this]);
             $this->session->setVisitorData($this->getData());
         } catch (\Exception $e) {
             $this->_logger->critical($e);
         }
         return $this;
     }

◆ setSkipRequestLogging()

setSkipRequestLogging ( $skipRequestLogging )

Skip request logging

Parameters

bool $skipRequestLogging

Returns: \Magento\Customer\Model\Visitor

Definition at line 140 of file Visitor.php.

     {
         $this->skipRequestLogging = (bool)$skipRequestLogging;
         return $this;
     }

Field Documentation

◆ $dateTime

$dateTime

protected

Definition at line 64 of file Visitor.php.

◆ $httpHeader

$httpHeader

protected

Definition at line 40 of file Visitor.php.

◆ $ignoredUserAgents

$ignoredUserAgents

protected

Definition at line 30 of file Visitor.php.

◆ $ignores

$ignores

protected

Definition at line 52 of file Visitor.php.

◆ $indexerRegistry

$indexerRegistry

protected

Definition at line 69 of file Visitor.php.

◆ $scopeConfig

$scopeConfig

protected

Definition at line 59 of file Visitor.php.

◆ $session

$session

protected

Definition at line 35 of file Visitor.php.

◆ $skipRequestLogging

$skipRequestLogging = false

protected

Definition at line 45 of file Visitor.php.

◆ DEFAULT_ONLINE_MINUTES_INTERVAL

const DEFAULT_ONLINE_MINUTES_INTERVAL = 15

Definition at line 23 of file Visitor.php.

◆ VISITOR_TYPE_CUSTOMER

const VISITOR_TYPE_CUSTOMER = 'c'

Definition at line 19 of file Visitor.php.

◆ VISITOR_TYPE_VISITOR

const VISITOR_TYPE_VISITOR = 'v'

Definition at line 21 of file Visitor.php.

◆ XML_PATH_ONLINE_INTERVAL

const XML_PATH_ONLINE_INTERVAL = 'customer/online_customers/online_minutes_interval'

Definition at line 25 of file Visitor.php.

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

vendor/magento/module-customer/Model/Visitor.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ bindCustomerLogout()

◆ bindQuoteCreate()

◆ bindQuoteDestroy()

◆ clean()

◆ getCleanTime()

◆ getOnlineInterval()

◆ initByRequest()

◆ isModuleIgnored()

◆ saveByRequest()

◆ setSkipRequestLogging()

Field Documentation

◆ $dateTime

◆ $httpHeader

◆ $ignoredUserAgents

◆ $ignores

◆ $indexerRegistry

◆ $scopeConfig

◆ $session

◆ $skipRequestLogging

◆ DEFAULT_ONLINE_MINUTES_INTERVAL

◆ VISITOR_TYPE_CUSTOMER

◆ VISITOR_TYPE_VISITOR

◆ XML_PATH_ONLINE_INTERVAL