Documentation

Mage_Cron_Model_Resource_Schedule extends Mage_Core_Model_Resource_Db_Abstract
in package

Maho

Tags
copyright

Copyright (c) 2006-2020 Magento, Inc. (https://magento.com)

copyright

Copyright (c) 2020-2024 The OpenMage Contributors (https://openmage.org)

copyright

Copyright (c) 2024 Maho (https://mahocommerce.com)

license

https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)

Table of Contents

Constants

CHECKSUM_KEY_NAME  = 'Checksum'

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
$_fieldsForUpdate  : array<string|int, mixed>
Fields List for update in forsedSave
$_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: array( <field_name> => array( <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 array( array('field' => 'db_field_name1', 'title' => 'Field 1 should be unique') array('field' => 'db_field_name2', 'title' => 'Field 2 should be unique') array( 'field' => array('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 array( array( 'field' => 'my_field_name', 'title' => 'my_field_name' ) )
$_useIsObjectNew  : bool
Use is object new method for save of object

Methods

__construct()  : mixed
Main constructor
_construct()  : mixed
Initialize resource
addCommitCallback()  : $this
Subscribe some callback to transaction commit
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
forsedSave()  : $this
Forced save object data forced update If duplicate unique key data
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()  : Varien_Db_Adapter_Interface
Temporary resolving collection compatibility
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
isModuleEnabled()  : bool
load()  : $this
Load an object
mktime()  : int
Convert internal date to UNIX timestamp
resetUniqueField()  : $this
Reset unique fields restrictions
rollBack()  : $this
Roll back resource transaction
save()  : $this
Save object object data
trySetJobStatusAtomic()  : bool
If job is currently in $currentStatus, set it to $newStatus and return true. Otherwise, return false and do not change the job.
unserializeFields()  : mixed
Un-serialize serializable object fields
_afterDelete()  : $this
Perform actions after object delete
_afterLoad()  : $this
Perform actions after object load
_afterSave()  : $this
Perform actions after object save
_beforeDelete()  : $this
Perform actions before object delete
_beforeSave()  : $this
Perform actions before object save
_checkUnique()  : $this
Check for unique values existence
_getConnection()  : Varien_Db_Adapter_Pdo_Mysql
Get connection by name or type
_getLoadSelect()  : Varien_Db_Select
Retrieve select object for load object data
_getReadAdapter()  : Varien_Db_Adapter_Pdo_Mysql
Retrieve connection for read data
_getWriteAdapter()  : Varien_Db_Adapter_Pdo_Mysql
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 Varien_Object field in an object

Constants

CHECKSUM_KEY_NAME

since 1.5.0.0

public mixed CHECKSUM_KEY_NAME = 'Checksum'

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 = []

$_fieldsForUpdate

Fields List for update in forsedSave

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

$_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: array( <field_name> => array( <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 array( array('field' => 'db_field_name1', 'title' => 'Field 1 should be unique') array('field' => 'db_field_name2', 'title' => 'Field 2 should be unique') array( 'field' => array('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 array( array( '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

_construct()

Initialize resource

public _construct() : mixed
Attributes
#[Override]

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|Zend_Date|bool|null $date[, bool $includeTime = true ]) : string|null
Parameters
$date : int|string|Zend_Date|bool|null
$includeTime : bool = true
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

isModuleEnabled()

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

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

trySetJobStatusAtomic()

If job is currently in $currentStatus, set it to $newStatus and return true. Otherwise, return false and do not change the job.

public trySetJobStatusAtomic(int $scheduleId, string $newStatus, string $currentStatus) : bool

This method is used to implement locking for cron jobs.

Parameters
$scheduleId : int
$newStatus : string
$currentStatus : string
Return values
bool

_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(Varien_Object $object, string $table) : array<string|int, mixed>
Parameters
$object : Varien_Object
$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(Varien_Object $object, string $field[, mixed $defaultValue = null ][, bool $unsetEmpty = false ]) : $this
Parameters
$object : Varien_Object
$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 Varien_Object field in an object

protected _unserializeField(Varien_Object $object, string $field[, mixed $defaultValue = null ]) : mixed
Parameters
$object : Varien_Object
$field : string
$defaultValue : mixed = null

        
On this page

Search results