Event Class Reference

Inheritance diagram for Event:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Stdlib\DateTime\DateTimeFactory $dateFactory, \Magento\Reports\Model\Event\TypeFactory $eventTypeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	beforeSave ()
	updateCustomerType ($visitorId, $customerId, $types=null)
	clean ()
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	EVENT_PRODUCT_VIEW = 1
const	EVENT_PRODUCT_SEND = 2
const	EVENT_PRODUCT_COMPARE = 3
const	EVENT_PRODUCT_TO_CART = 4
const	EVENT_PRODUCT_TO_WISHLIST = 5
const	EVENT_WISHLIST_SHARE = 6

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
	$_dateFactory
	$_eventTypeFactory
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

Events model

@method string getLoggedAt() @method \Magento\Reports\Model\Event setLoggedAt(string $value) @method int getEventTypeId() @method \Magento\Reports\Model\Event setEventTypeId(int $value) @method int getObjectId() @method \Magento\Reports\Model\Event setObjectId(int $value) @method int getSubjectId() @method \Magento\Reports\Model\Event setSubjectId(int $value) @method int getSubtype() @method \Magento\Reports\Model\Event setSubtype(int $value) @method int getStoreId() @method \Magento\Reports\Model\Event setStoreId(int $value)

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @api

Since

100.0.2

Definition at line 28 of file Event.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Stdlib\DateTime\DateTimeFactory	$dateFactory,
		\Magento\Reports\Model\Event\TypeFactory	$eventTypeFactory,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = null,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = null,
		array	$data = []
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Stdlib\DateTime\DateTimeFactory	$dateFactory
\Magento\Reports\Model\Event\TypeFactory	$eventTypeFactory
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data

Definition at line 61 of file Event.php.

      {
        parent::__construct($context, $registry, $resource, $resourceCollection, $data);
        $this->_dateFactory = $dateFactory;
        $this->_eventTypeFactory = $eventTypeFactory;
    }

Member Function Documentation

_construct()

_construct ( )

protected

Initialize resource

Returns

void

Definition at line 80 of file Event.php.

    {
        $this->_init(\Magento\Reports\Model\ResourceModel\Event::class);
    }

beforeSave()

beforeSave

(

)

Before Event save process

Returns

$this

Definition at line 90 of file Event.php.

    {
        $date = $this->_dateFactory->create();
        $this->setLoggedAt($date->gmtDate());
        return parent::beforeSave();
    }

clean()

clean

(

)

Clean events (visitors)

Returns

$this

Definition at line 125 of file Event.php.

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

updateCustomerType()

updateCustomerType	(		$visitorId,
			$customerId,
			$types = null
	)

Update customer type after customer login

Parameters

int	$visitorId
int	$customerId
array	$types

Returns

$this

Definition at line 105 of file Event.php.

    {
        if ($types === null) {
            $types = [];
            $typesCollection = $this->_eventTypeFactory->create()->getCollection();
            foreach ($typesCollection as $eventType) {
                if ($eventType->getCustomerLogin()) {
                    $types[$eventType->getId()] = $eventType->getId();
                }
            }
        }
        $this->getResource()->updateCustomerType($this, $visitorId, $customerId, $types);
        return $this;
    }

Field Documentation

$_dateFactory

$_dateFactory

protected

Definition at line 45 of file Event.php.

$_eventTypeFactory

$_eventTypeFactory

protected

Definition at line 50 of file Event.php.

EVENT_PRODUCT_COMPARE

const EVENT_PRODUCT_COMPARE = 3

Definition at line 34 of file Event.php.

EVENT_PRODUCT_SEND

const EVENT_PRODUCT_SEND = 2

Definition at line 32 of file Event.php.

EVENT_PRODUCT_TO_CART

const EVENT_PRODUCT_TO_CART = 4

Definition at line 36 of file Event.php.

EVENT_PRODUCT_TO_WISHLIST

const EVENT_PRODUCT_TO_WISHLIST = 5

Definition at line 38 of file Event.php.

EVENT_PRODUCT_VIEW

const EVENT_PRODUCT_VIEW = 1

Definition at line 30 of file Event.php.

EVENT_WISHLIST_SHARE

const EVENT_WISHLIST_SHARE = 6

Definition at line 40 of file Event.php.

---

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

• vendor/magento/module-reports/Model/Event.php