Inheritance diagram for Queue:

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.

       {
         parent::__construct(
             $context,
             $registry,
             $resource,
             $resourceCollection,
             $data
         );
         $this->_templateFilter = $templateFilter;
         $this->_date = $date;
         $this->_templateFactory = $templateFactory;
         $this->_problemFactory = $problemFactory;
         $this->_subscribersCollection = $subscriberCollectionFactory->create();
         $this->_transportBuilder = $transportBuilder;
         $this->timezone = $timezone ?: \Magento\Framework\App\ObjectManager::getInstance()->get(
             TimezoneInterface::class
         );
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Initialize resource model

Returns: void

Definition at line 172 of file Queue.php.

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

◆ _finishQueue()

_finishQueue ( )

protected

Finish queue: set status SENT and update finish date

Returns: $this

Definition at line 282 of file Queue.php.

     {
         $this->setQueueFinishAt($this->_date->gmtDate());
         $this->setQueueStatus(self::STATUS_SENT);
         $this->save();
 
         return $this;
     }

◆ addSubscribersToQueue()

addSubscribersToQueue ( array $subscriberIds )

Add subscribers to queue.

Parameters

array $subscriberIds

Returns: $this

Definition at line 312 of file Queue.php.

     {
         $this->_getResource()->addSubscribersToQueue($this, $subscriberIds);
         return $this;
     }

◆ getDataForSave()

getDataForSave ( )

Getter data for saving

Returns: array

Definition at line 296 of file Queue.php.

     {
         $data = [];
         $data['template_id'] = $this->getTemplateId();
         $data['queue_status'] = $this->getQueueStatus();
         $data['queue_start_at'] = $this->getQueueStartAt();
         $data['queue_finish_at'] = $this->getQueueFinishAt();
         return $data;
     }

◆ getSaveStoresFlag()

getSaveStoresFlag ( )

Getter for save stores flag.

Returns: boolean @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 336 of file Queue.php.

     {
         return $this->_saveStoresFlag;
     }

◆ getStores()

getStores ( )

Getter for stores of queue.

Returns: array

Definition at line 359 of file Queue.php.

     {
         if (!$this->_stores) {
             $this->_stores = $this->_getResource()->getStores($this);
         }
 
         return $this->_stores;
     }

◆ getTemplate()

getTemplate ( )

Retrieve Newsletter Template object

Returns: \Magento\Newsletter\Model\Template

Definition at line 373 of file Queue.php.

     {
         if ($this->_template === null) {
             $this->_template = $this->_templateFactory->create()->load($this->getTemplateId());
         }
         return $this->_template;
     }

◆ getType()

getType ( )

Getter for template type

Returns: int|string

Implements TemplateTypesInterface.

Definition at line 396 of file Queue.php.

     {
         return $this->getNewsletterType();
     }

◆ isNew()

isNew ( )

Return: is this queue newly created or not.

Returns: boolean

Definition at line 183 of file Queue.php.

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

◆ isPlain()

isPlain ( )

Return true if template type eq text

Returns: boolean

Implements TemplateTypesInterface.

Definition at line 386 of file Queue.php.

     {
         return $this->getType() == self::TYPE_TEXT;
     }

◆ setQueueStartAtByString()

setQueueStartAtByString ( $startAt )

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

Parameters

string | null $startAt start date of the mailing queue

Returns: $this

Definition at line 194 of file Queue.php.

     {
         if ($startAt === null || $startAt == '') {
             $this->setQueueStartAt(null);
         } else {
             $this->setQueueStartAt($this->timezone->convertConfigTimeToUtc($startAt));
         }
         return $this;
     }

◆ setSaveStoresFlag()

setSaveStoresFlag ( $value )

Setter for save stores flag.

Parameters

boolean | integer | string $value

Returns: $this

Definition at line 324 of file Queue.php.

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

◆ setStores()

setStores ( array $storesIds )

Setter for stores of queue.

Parameters

array $storesIds

Returns: $this

Definition at line 347 of file Queue.php.

     {
         $this->setSaveStoresFlag(true);
         $this->_stores = $storesIds;
         return $this;
     }

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:

vendor/magento/module-newsletter/Model/Queue.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _finishQueue()

◆ addSubscribersToQueue()

◆ getDataForSave()

◆ getSaveStoresFlag()

◆ getStores()

◆ getTemplate()

◆ getType()

◆ isNew()

◆ isPlain()

◆ setQueueStartAtByString()

◆ setSaveStoresFlag()

◆ setStores()

Field Documentation

◆ $_date

◆ $_problemFactory

◆ $_saveStoresFlag

◆ $_stores

◆ $_subscribersCollection

◆ $_template

◆ $_templateFactory

◆ $_templateFilter

◆ $_transportBuilder

◆ STATUS_CANCEL

◆ STATUS_NEVER

◆ STATUS_PAUSE

◆ STATUS_SENDING

◆ STATUS_SENT