Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Member Functions | Protected Attributes
Problem Class Reference
Inheritance diagram for Problem:
AbstractModel DataObject

Public Member Functions

 __construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Newsletter\Model\SubscriberFactory $subscriberFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
 
 addSubscriberData (\Magento\Newsletter\Model\Subscriber $subscriber)
 
 addQueueData (\Magento\Newsletter\Model\Queue $queue)
 
 addErrorData (\Exception $e)
 
 getSubscriber ()
 
 unsubscribe ()
 
- 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)
 

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

 $_subscriber = null
 
 $_subscriberFactory
 
- 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

Newsletter problem model

@method int getSubscriberId() @method \Magento\Newsletter\Model\Problem setSubscriberId(int $value) @method int getQueueId() @method \Magento\Newsletter\Model\Problem setQueueId(int $value) @method int getProblemErrorCode() @method \Magento\Newsletter\Model\Problem setProblemErrorCode(int $value) @method string getProblemErrorText() @method \Magento\Newsletter\Model\Problem setProblemErrorText(string $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 25 of file Problem.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Framework\Model\Context  $context,
\Magento\Framework\Registry  $registry,
\Magento\Newsletter\Model\SubscriberFactory  $subscriberFactory,
\Magento\Framework\Model\ResourceModel\AbstractResource  $resource = null,
\Magento\Framework\Data\Collection\AbstractDb  $resourceCollection = null,
array  $data = [] 
)

Construct

Parameters
\Magento\Framework\Model\Context$context
\Magento\Framework\Registry$registry
\Magento\Newsletter\Model\SubscriberFactory$subscriberFactory
\Magento\Framework\Model\ResourceModel\AbstractResource$resource
\Magento\Framework\Data\Collection\AbstractDb$resourceCollection
array$data

Definition at line 51 of file Problem.php.

58  {
59  parent::__construct($context, $registry, $resource, $resourceCollection, $data);
60  $this->_subscriberFactory = $subscriberFactory;
61  }
$resource
Definition: bulk.php:12

Member Function Documentation

◆ _construct()

_construct ( )
protected

Initialize Newsletter Problem Model

Returns
void

Definition at line 68 of file Problem.php.

69  {
70  $this->_init(\Magento\Newsletter\Model\ResourceModel\Problem::class);
71  }

◆ addErrorData()

addErrorData ( \Exception  $e)

Add Error Data

Parameters
\Exception$e
Returns
$this

Definition at line 103 of file Problem.php.

104  {
105  $this->setProblemErrorCode($e->getCode());
106  $this->setProblemErrorText($e->getMessage());
107  return $this;
108  }

◆ addQueueData()

addQueueData ( \Magento\Newsletter\Model\Queue  $queue)

Add Queue Data

Parameters
\Magento\Newsletter\Model\Queue$queue
Returns
$this

Definition at line 91 of file Problem.php.

92  {
93  $this->setQueueId($queue->getId());
94  return $this;
95  }
$queue
Definition: queue.php:21

◆ addSubscriberData()

addSubscriberData ( \Magento\Newsletter\Model\Subscriber  $subscriber)

Add Subscriber Data

Parameters
\Magento\Newsletter\Model\Subscriber$subscriber
Returns
$this

Definition at line 79 of file Problem.php.

80  {
81  $this->setSubscriberId($subscriber->getId());
82  return $this;
83  }
$subscriber
Definition: subscribers.php:20

◆ getSubscriber()

getSubscriber ( )

Retrieve Subscriber

Returns
\Magento\Newsletter\Model\Subscriber

Definition at line 115 of file Problem.php.

116  {
117  if (!$this->getSubscriberId()) {
118  return null;
119  }
120 
121  if ($this->_subscriber === null) {
122  $this->_subscriber = $this->_subscriberFactory->create()->load($this->getSubscriberId());
123  }
124 
125  return $this->_subscriber;
126  }

◆ unsubscribe()

unsubscribe ( )

Unsubscribe Subscriber

Returns
$this

Definition at line 133 of file Problem.php.

134  {
135  if ($this->getSubscriber()) {
136  $this->getSubscriber()->setSubscriberStatus(
137  \Magento\Newsletter\Model\Subscriber::STATUS_UNSUBSCRIBED
138  )->setIsStatusChanged(
139  true
140  )->save();
141  }
142  return $this;
143  }

Field Documentation

◆ $_subscriber

$_subscriber = null
protected

Definition at line 32 of file Problem.php.

◆ $_subscriberFactory

$_subscriberFactory
protected

Definition at line 39 of file Problem.php.


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