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

Public Member Functions

 __construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Newsletter\Model\Template\Filter $templateFilter, \Magento\Framework\Stdlib\DateTime\DateTime $date, \Magento\Newsletter\Model\TemplateFactory $templateFactory, \Magento\Newsletter\Model\ProblemFactory $problemFactory, \Magento\Newsletter\Model\ResourceModel\Subscriber\CollectionFactory $subscriberCollectionFactory, \Magento\Newsletter\Model\Queue\TransportBuilder $transportBuilder, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], TimezoneInterface $timezone=null)
 
 isNew ()
 
 setQueueStartAtByString ($startAt)
 
 getDataForSave ()
 
 addSubscribersToQueue (array $subscriberIds)
 
 setSaveStoresFlag ($value)
 
 getSaveStoresFlag ()
 
 setStores (array $storesIds)
 
 getStores ()
 
 getTemplate ()
 
 isPlain ()
 
 getType ()
 
- 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 STATUS_NEVER = 0
 
const STATUS_SENDING = 1
 
const STATUS_CANCEL = 2
 
const STATUS_SENT = 3
 
const STATUS_PAUSE = 4
 
- Data Fields inherited from TemplateTypesInterface
const TYPE_TEXT = 1
 
const TYPE_HTML = 2
 

Protected Member Functions

 _construct ()
 
 _finishQueue ()
 
- 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

 $_template
 
 $_subscribersCollection
 
 $_saveStoresFlag = false
 
 $_stores = []
 
 $_templateFilter
 
 $_date
 
 $_problemFactory
 
 $_templateFactory
 
 $_transportBuilder
 
- 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 queue model.

@method int getTemplateId() @method \Magento\Newsletter\Model\Queue setTemplateId(int $value) @method int getNewsletterType() @method \Magento\Newsletter\Model\Queue setNewsletterType(int $value) @method string getNewsletterText() @method \Magento\Newsletter\Model\Queue setNewsletterText(string $value) @method string getNewsletterStyles() @method \Magento\Newsletter\Model\Queue setNewsletterStyles(string $value) @method string getNewsletterSubject() @method \Magento\Newsletter\Model\Queue setNewsletterSubject(string $value) @method string getNewsletterSenderName() @method \Magento\Newsletter\Model\Queue setNewsletterSenderName(string $value) @method string getNewsletterSenderEmail() @method \Magento\Newsletter\Model\Queue setNewsletterSenderEmail(string $value) @method int getQueueStatus() @method \Magento\Newsletter\Model\Queue setQueueStatus(int $value) @method string getQueueStartAt() @method \Magento\Newsletter\Model\Queue setQueueStartAt(string $value) @method string getQueueFinishAt() @method \Magento\Newsletter\Model\Queue setQueueFinishAt(string $value) @SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since
100.0.2

Definition at line 40 of file Queue.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Framework\Model\Context  $context,
\Magento\Framework\Registry  $registry,
\Magento\Newsletter\Model\Template\Filter  $templateFilter,
\Magento\Framework\Stdlib\DateTime\DateTime  $date,
\Magento\Newsletter\Model\TemplateFactory  $templateFactory,
\Magento\Newsletter\Model\ProblemFactory  $problemFactory,
\Magento\Newsletter\Model\ResourceModel\Subscriber\CollectionFactory  $subscriberCollectionFactory,
\Magento\Newsletter\Model\Queue\TransportBuilder  $transportBuilder,
\Magento\Framework\Model\ResourceModel\AbstractResource  $resource = null,
\Magento\Framework\Data\Collection\AbstractDb  $resourceCollection = null,
array  $data = [],
TimezoneInterface  $timezone = null 
)
Parameters
\Magento\Framework\Model\Context$context
\Magento\Framework\Registry$registry
\Magento\Newsletter\Model\Template\Filter$templateFilter
\Magento\Framework\Stdlib\DateTime\DateTime$date
\Magento\Newsletter\Model\TemplateFactory$templateFactory
\Magento\Newsletter\Model\ProblemFactory$problemFactory
\Magento\Newsletter\Model\ResourceModel\Subscriber\CollectionFactory$subscriberCollectionFactory
\Magento\Newsletter\Model\Queue\TransportBuilder$transportBuilder
\Magento\Framework\Model\ResourceModel\AbstractResource$resource
\Magento\Framework\Data\Collection\AbstractDb$resourceCollection
array$data
TimezoneInterface$timezone@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 135 of file Queue.php.

148  {
149  parent::__construct(
150  $context,
151  $registry,
152  $resource,
153  $resourceCollection,
154  $data
155  );
156  $this->_templateFilter = $templateFilter;
157  $this->_date = $date;
158  $this->_templateFactory = $templateFactory;
159  $this->_problemFactory = $problemFactory;
160  $this->_subscribersCollection = $subscriberCollectionFactory->create();
161  $this->_transportBuilder = $transportBuilder;
162  $this->timezone = $timezone ?: \Magento\Framework\App\ObjectManager::getInstance()->get(
163  TimezoneInterface::class
164  );
165  }
$resource
Definition: bulk.php:12

Member Function Documentation

◆ _construct()

_construct ( )
protected

Initialize resource model

Returns
void

Definition at line 172 of file Queue.php.

173  {
174  parent::_construct();
175  $this->_init(\Magento\Newsletter\Model\ResourceModel\Queue::class);
176  }

◆ _finishQueue()

_finishQueue ( )
protected

Finish queue: set status SENT and update finish date

Returns
$this

Definition at line 282 of file Queue.php.

283  {
284  $this->setQueueFinishAt($this->_date->gmtDate());
285  $this->setQueueStatus(self::STATUS_SENT);
286  $this->save();
287 
288  return $this;
289  }

◆ addSubscribersToQueue()

addSubscribersToQueue ( array  $subscriberIds)

Add subscribers to queue.

Parameters
array$subscriberIds
Returns
$this

Definition at line 312 of file Queue.php.

313  {
314  $this->_getResource()->addSubscribersToQueue($this, $subscriberIds);
315  return $this;
316  }

◆ getDataForSave()

getDataForSave ( )

Getter data for saving

Returns
array

Definition at line 296 of file Queue.php.

297  {
298  $data = [];
299  $data['template_id'] = $this->getTemplateId();
300  $data['queue_status'] = $this->getQueueStatus();
301  $data['queue_start_at'] = $this->getQueueStartAt();
302  $data['queue_finish_at'] = $this->getQueueFinishAt();
303  return $data;
304  }

◆ getSaveStoresFlag()

getSaveStoresFlag ( )

Getter for save stores flag.

Returns
boolean @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 336 of file Queue.php.

337  {
338  return $this->_saveStoresFlag;
339  }

◆ getStores()

getStores ( )

Getter for stores of queue.

Returns
array

Definition at line 359 of file Queue.php.

360  {
361  if (!$this->_stores) {
362  $this->_stores = $this->_getResource()->getStores($this);
363  }
364 
365  return $this->_stores;
366  }

◆ getTemplate()

getTemplate ( )

Retrieve Newsletter Template object

Returns
\Magento\Newsletter\Model\Template

Definition at line 373 of file Queue.php.

374  {
375  if ($this->_template === null) {
376  $this->_template = $this->_templateFactory->create()->load($this->getTemplateId());
377  }
378  return $this->_template;
379  }

◆ getType()

getType ( )

Getter for template type

Returns
int|string

Implements TemplateTypesInterface.

Definition at line 396 of file Queue.php.

397  {
398  return $this->getNewsletterType();
399  }

◆ isNew()

isNew ( )

Return: is this queue newly created or not.

Returns
boolean

Definition at line 183 of file Queue.php.

184  {
185  return $this->getQueueStatus() === null;
186  }

◆ isPlain()

isPlain ( )

Return true if template type eq text

Returns
boolean

Implements TemplateTypesInterface.

Definition at line 386 of file Queue.php.

◆ setQueueStartAtByString()

setQueueStartAtByString (   $startAt)

Set $_data['queue_start'] based on string from backend, which based on locale.

Parameters
string | null$startAtstart date of the mailing queue
Returns
$this

Definition at line 194 of file Queue.php.

195  {
196  if ($startAt === null || $startAt == '') {
197  $this->setQueueStartAt(null);
198  } else {
199  $this->setQueueStartAt($this->timezone->convertConfigTimeToUtc($startAt));
200  }
201  return $this;
202  }

◆ setSaveStoresFlag()

setSaveStoresFlag (   $value)

Setter for save stores flag.

Parameters
boolean | integer | string$value
Returns
$this

Definition at line 324 of file Queue.php.

325  {
326  $this->_saveStoresFlag = (bool)$value;
327  return $this;
328  }
$value
Definition: gender.phtml:16

◆ setStores()

setStores ( array  $storesIds)

Setter for stores of queue.

Parameters
array$storesIds
Returns
$this

Definition at line 347 of file Queue.php.

348  {
349  $this->setSaveStoresFlag(true);
350  $this->_stores = $storesIds;
351  return $this;
352  }

Field Documentation

◆ $_date

$_date
protected

Definition at line 92 of file Queue.php.

◆ $_problemFactory

$_problemFactory
protected

Definition at line 99 of file Queue.php.

◆ $_saveStoresFlag

$_saveStoresFlag = false
protected

Definition at line 61 of file Queue.php.

◆ $_stores

$_stores = []
protected

Definition at line 68 of file Queue.php.

◆ $_subscribersCollection

$_subscribersCollection
protected

Definition at line 54 of file Queue.php.

◆ $_template

$_template
protected

Definition at line 47 of file Queue.php.

◆ $_templateFactory

$_templateFactory
protected

Definition at line 106 of file Queue.php.

◆ $_templateFilter

$_templateFilter
protected

Definition at line 85 of file Queue.php.

◆ $_transportBuilder

$_transportBuilder
protected

Definition at line 111 of file Queue.php.

◆ STATUS_CANCEL

const STATUS_CANCEL = 2

Definition at line 74 of file Queue.php.

◆ STATUS_NEVER

const STATUS_NEVER = 0

Definition at line 70 of file Queue.php.

◆ STATUS_PAUSE

const STATUS_PAUSE = 4

Definition at line 78 of file Queue.php.

◆ STATUS_SENDING

const STATUS_SENDING = 1

Definition at line 72 of file Queue.php.

◆ STATUS_SENT

const STATUS_SENT = 3

Definition at line 76 of file Queue.php.


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