Documentation

Mage_Newsletter_Model_Resource_Queue extends Mage_Core_Model_Resource_Db_Abstract
in package

Table of Contents

Constants

LINK_INSERT_CHUNK  : mixed = 1000
Recipient links probed and written per statement when adding explicit subscriber lists: a bulk addition can be large, so neither the IN() list nor the row array may hold the whole set at once.

Properties

$_commitCallbacks  : array<string|int, mixed>
Array of callbacks subscribed to commit transaction commit
$_connections  : array<string|int, mixed>
Connections cache for this resource model
$_idFieldName  : string
Main table primary key field name
$_isPkAutoIncrement  : bool
Primery key auto increment flag
$_mainTable  : string
Main table name
$_mainTableFields  : array<string|int, mixed>
Fields of main table
$_resourceModel  : string
Resource model name that contains entities (names of tables)
$_resourcePrefix  : string
Prefix for resources that will be used in this resource model
$_resources  : Mage_Core_Model_Resource
Cached resources singleton
$_serializableFields  : array<string|int, mixed>
Serializable fields declaration Structure: [ <field_name> => [ <default_value_for_serialization>, <default_for_unserialization>, <whether_to_unset_empty_when serializing> // optional parameter ], ]
$_tables  : array<string|int, mixed>
Tables used in this resource model
$_uniqueFields  : array<string|int, mixed>|null
Main table unique keys field names could [ ['field' => 'db_field_name1', 'title' => 'Field 1 should be unique'] ['field' => 'db_field_name2', 'title' => 'Field 2 should be unique'] [ 'field' => ['db_field_name3', 'db_field_name3'], 'title' => 'Field 3 and Field 4 combination should be unique' ] ] or string 'my_field_name' - will be autoconverted to [ [ 'field' => 'my_field_name', 'title' => 'my_field_name' ] ]
$_useIsObjectNew  : bool
Use is object new method for save of object

Methods

__construct()  : mixed
Main constructor
addCommitCallback()  : $this
Subscribe some callback to transaction commit
addSubscribersToQueue()  : mixed
Add subscribers to queue
addUniqueField()  : $this
Add unique field restriction
afterLoad()  : mixed
After load
beginTransaction()  : $this
Start resource transaction
commit()  : $this
Commit resource transaction
delete()  : $this
Delete the object
formatDate()  : string|null
Format date to internal format
getChecksum()  : array<string|int, mixed>|false
Retrieve table checksum
getIdFieldName()  : string
Get primary key field name
getMainTable()  : string
Returns main table name - extracted from "module/table" style and validated by db adapter
getReadConnection()  : AdapterInterface
Temporary resolving collection compatibility
getRecipientCount()  : int
Recipients linked to this campaign, sent or not
getSegmentIds()  : array<string|int, mixed>
Empty unless Maho_CustomerSegmentation, which owns the column, is enabled.
getStores()  : array<string|int, mixed>
Returns queue linked stores
getTable()  : string
Get table name for the entity, validated by db adapter
getUniqueFields()  : array<string|int, mixed>
Get configuration of all unique fields
getValueTable()  : string
Retrieve table name for the entity separated value
hasConnection()  : bool
hasDataChanged()  : bool
Check that model data fields that can be saved has really changed comparing with origData
hasUnsatisfiableSegmentRestriction()  : bool
A restriction naming no resolvable segment: the module owning the column is disabled, or the column holds no usable id. Mailing every subscriber of the campaign's stores is the one reading that is certainly wrong, and the grid already projects no recipients for such a campaign.
isModuleEnabled()  : bool
load()  : $this
Load an object
materializeRecipients()  : void
Snapshot the campaign audience as queue links, once.
mktime()  : int
Convert internal date to UNIX timestamp
removeSubscribersFromQueue()  : void
Removes subscriber from queue
resetUniqueField()  : $this
Reset unique fields restrictions
rollBack()  : $this
Roll back resource transaction
save()  : $this
Save object object data
setStores()  : $this
Links queue to store
unserializeFields()  : mixed
Un-serialize serializable object fields
_afterDelete()  : $this
Perform actions after object delete
_afterLoad()  : $this
Perform actions after object load
_afterSave()  : $this
Saving template after saving queue action
_beforeDelete()  : $this
Perform actions before object delete
_beforeSave()  : $this
Perform actions before object save
_canFieldHoldValue()  : bool
Return false when $field is an integer column of the main table and $value is out of its range. No row has such a value, and PostgreSQL refuses the query. The check uses the value as _getLoadSelect() converts it.
_checkUnique()  : $this
Check for unique values existence
_construct()  : mixed
_getConnection()  : AdapterInterface|false
Get connection by name or type
_getLoadSelect()  : Select
Retrieve select object for load object data
_getReadAdapter()  : AdapterInterface|false
Retrieve connection for read data
_getUniqueCheckValue()  : string|null
Return the value that the unique check compares with a column. A column that cannot hold the value stores its default, so the check uses the default. Return null when no row can hold the value.
_getWriteAdapter()  : AdapterInterface|false
Retrieve connection for write data
_init()  : mixed
Standard resource model initialization
_initUniqueFields()  : $this
Initialize unique fields
_prepareDataForSave()  : array<string|int, mixed>
Prepare data for save
_prepareDataForTable()  : array<string|int, mixed>
Prepare data for passed table
_prepareTableValueForSave()  : mixed
Prepare value for save
_prepareValueForSave()  : mixed
Prepare value for save
_serializeField()  : $this
Serialize specified field in an object
_serializeFields()  : mixed
Serialize serializable fields of the object
_setMainTable()  : $this
Set main entity table name and primary key field name If field name is omitted {table_name}_id will be used
_setResource()  : Mage_Core_Model_Resource_Abstract
Initialize connections and tables for this resource model If one or both arguments are string, will be used as prefix If $tables is null and $connections is string, $tables will be the same
_unserializeField()  : mixed
Unserialize \Maho\DataObject field in an object

Constants

Recipient links probed and written per statement when adding explicit subscriber lists: a bulk addition can be large, so neither the IN() list nor the row array may hold the whole set at once.

public mixed LINK_INSERT_CHUNK = 1000

Properties

$_commitCallbacks

Array of callbacks subscribed to commit transaction commit

protected static array<string|int, mixed> $_commitCallbacks = []

$_connections

Connections cache for this resource model

protected array<string|int, mixed> $_connections = []

$_idFieldName

Main table primary key field name

protected string $_idFieldName

$_isPkAutoIncrement

Primery key auto increment flag

protected bool $_isPkAutoIncrement = \true

$_mainTable

Main table name

protected string $_mainTable

$_mainTableFields

Fields of main table

protected array<string|int, mixed> $_mainTableFields

$_resourceModel

Resource model name that contains entities (names of tables)

protected string $_resourceModel

$_resourcePrefix

Prefix for resources that will be used in this resource model

protected string $_resourcePrefix

$_serializableFields

Serializable fields declaration Structure: [ <field_name> => [ <default_value_for_serialization>, <default_for_unserialization>, <whether_to_unset_empty_when serializing> // optional parameter ], ]

protected array<string|int, mixed> $_serializableFields = []

$_tables

Tables used in this resource model

protected array<string|int, mixed> $_tables = []

$_uniqueFields

Main table unique keys field names could [ ['field' => 'db_field_name1', 'title' => 'Field 1 should be unique'] ['field' => 'db_field_name2', 'title' => 'Field 2 should be unique'] [ 'field' => ['db_field_name3', 'db_field_name3'], 'title' => 'Field 3 and Field 4 combination should be unique' ] ] or string 'my_field_name' - will be autoconverted to [ [ 'field' => 'my_field_name', 'title' => 'my_field_name' ] ]

protected array<string|int, mixed>|null $_uniqueFields = \null

$_useIsObjectNew

Use is object new method for save of object

protected bool $_useIsObjectNew = \false

Methods

__construct()

Main constructor

public __construct() : mixed

addCommitCallback()

Subscribe some callback to transaction commit

public addCommitCallback(callable $callback) : $this
Parameters
$callback : callable
Return values
$this

addUniqueField()

Add unique field restriction

public addUniqueField(array<string|int, mixed>|string $field) : $this
Parameters
$field : array<string|int, mixed>|string
Return values
$this

beginTransaction()

Start resource transaction

public beginTransaction() : $this
Return values
$this

commit()

Commit resource transaction

public commit() : $this
Return values
$this

formatDate()

Format date to internal format

public formatDate(int|string|DateTime|bool|null $date[, bool $withTime = true ]) : string|null

since 26.5 Use Mage::app()->getLocale()->formatDateForDb() instead

Parameters
$date : int|string|DateTime|bool|null
$withTime : bool = true
Tags
see
Mage_Core_Model_Locale::formatDateForDb()
Return values
string|null

getChecksum()

Retrieve table checksum

public getChecksum(string|array<string|int, mixed> $table) : array<string|int, mixed>|false
Parameters
$table : string|array<string|int, mixed>
Return values
array<string|int, mixed>|false

getIdFieldName()

Get primary key field name

public getIdFieldName() : string
Return values
string

getMainTable()

Returns main table name - extracted from "module/table" style and validated by db adapter

public getMainTable() : string
Return values
string

getTable()

Get table name for the entity, validated by db adapter

public getTable(string|array<string|int, mixed> $entityName) : string
Parameters
$entityName : string|array<string|int, mixed>
Return values
string

getUniqueFields()

Get configuration of all unique fields

public getUniqueFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getValueTable()

Retrieve table name for the entity separated value

public getValueTable(string $entityName, string $valueType) : string
Parameters
$entityName : string
$valueType : string
Return values
string

hasConnection()

public hasConnection(string $connectionName) : bool
Parameters
$connectionName : string
Return values
bool

hasUnsatisfiableSegmentRestriction()

A restriction naming no resolvable segment: the module owning the column is disabled, or the column holds no usable id. Mailing every subscriber of the campaign's stores is the one reading that is certainly wrong, and the grid already projects no recipients for such a campaign.

public hasUnsatisfiableSegmentRestriction(Mage_Newsletter_Model_Queue $queue) : bool
Parameters
$queue : Mage_Newsletter_Model_Queue
Return values
bool

isModuleEnabled()

public isModuleEnabled(string $moduleName[, string $helperAlias = 'core' ]) : bool
Parameters
$moduleName : string
$helperAlias : string = 'core'
Return values
bool

materializeRecipients()

Snapshot the campaign audience as queue links, once.

public materializeRecipients(Mage_Newsletter_Model_Queue $queue) : void

Deferred to the first batch rather than done on save: the recipients are then the ones subscribed when the campaign goes out, not when it was written, and editing a draft no longer rewrites the whole audience.

Parameters
$queue : Mage_Newsletter_Model_Queue

mktime()

Convert internal date to UNIX timestamp

public mktime(string $str) : int
Parameters
$str : string
Return values
int

resetUniqueField()

Reset unique fields restrictions

public resetUniqueField() : $this
Return values
$this

rollBack()

Roll back resource transaction

public rollBack() : $this
Return values
$this

_canFieldHoldValue()

Return false when $field is an integer column of the main table and $value is out of its range. No row has such a value, and PostgreSQL refuses the query. The check uses the value as _getLoadSelect() converts it.

protected _canFieldHoldValue(string $field, mixed $value) : bool
Parameters
$field : string
$value : mixed
Return values
bool

_construct()

protected _construct() : mixed
Attributes
#[Override]

_getUniqueCheckValue()

Return the value that the unique check compares with a column. A column that cannot hold the value stores its default, so the check uses the default. Return null when no row can hold the value.

protected _getUniqueCheckValue(array<string, mixed> $column, mixed $value) : string|null
Parameters
$column : array<string, mixed>

the description of the column, from describeTable()

$value : mixed
Return values
string|null

_init()

Standard resource model initialization

protected _init(string $mainTable, string $idFieldName) : mixed
Parameters
$mainTable : string
$idFieldName : string

_initUniqueFields()

Initialize unique fields

protected _initUniqueFields() : $this
Return values
$this

_prepareDataForTable()

Prepare data for passed table

protected _prepareDataForTable(DataObject $object, string $table) : array<string|int, mixed>
Parameters
$object : DataObject
$table : string
Return values
array<string|int, mixed>

_prepareTableValueForSave()

Prepare value for save

protected _prepareTableValueForSave(mixed $value, string $type) : mixed
Parameters
$value : mixed
$type : string

_prepareValueForSave()

Prepare value for save

protected _prepareValueForSave(mixed $value, string $type) : mixed
Parameters
$value : mixed
$type : string

_serializeField()

Serialize specified field in an object

protected _serializeField(DataObject $object, string $field[, mixed $defaultValue = null ][, bool $unsetEmpty = false ]) : $this
Parameters
$object : DataObject
$field : string
$defaultValue : mixed = null
$unsetEmpty : bool = false
Return values
$this

_setMainTable()

Set main entity table name and primary key field name If field name is omitted {table_name}_id will be used

protected _setMainTable(string $mainTable[, string|null $idFieldName = null ]) : $this
Parameters
$mainTable : string
$idFieldName : string|null = null
Return values
$this

_setResource()

Initialize connections and tables for this resource model If one or both arguments are string, will be used as prefix If $tables is null and $connections is string, $tables will be the same

protected _setResource(string|array<string|int, mixed> $connections[, string|array<string|int, mixed>|null $tables = null ]) : Mage_Core_Model_Resource_Abstract
Parameters
$connections : string|array<string|int, mixed>
$tables : string|array<string|int, mixed>|null = null
Return values
Mage_Core_Model_Resource_Abstract

_unserializeField()

Unserialize \Maho\DataObject field in an object

protected _unserializeField(DataObject $object, string $field[, mixed $defaultValue = null ]) : mixed
Parameters
$object : DataObject
$field : string
$defaultValue : mixed = null
On this page

Search results