Schedule Class Reference

Inheritance diagram for Schedule:

Public Member Functions
	__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=[], TimezoneInterface $timezoneConverter=null)
	_construct ()
	setCronExpr ($expr)
	trySchedule ()
	matchCronExpression ($expr, $num)
	getNumeric ($value)
	tryLockJob ()
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_PENDING = 'pending'
const	STATUS_RUNNING = 'running'
const	STATUS_SUCCESS = 'success'
const	STATUS_MISSED = 'missed'
const	STATUS_ERROR = 'error'

Additional Inherited Members
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 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 = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Crontab schedule model

@method string getJobCode() @method \Magento\Cron\Model\Schedule setJobCode(string $value) @method string getStatus() @method \Magento\Cron\Model\Schedule setStatus(string $value) @method string getMessages() @method \Magento\Cron\Model\Schedule setMessages(string $value) @method string getCreatedAt() @method \Magento\Cron\Model\Schedule setCreatedAt(string $value) @method string getScheduledAt() @method \Magento\Cron\Model\Schedule setScheduledAt(string $value) @method string getExecutedAt() @method \Magento\Cron\Model\Schedule setExecutedAt(string $value) @method string getFinishedAt() @method \Magento\Cron\Model\Schedule setFinishedAt(string $value) @method array getCronExprArr() @method \Magento\Cron\Model\Schedule setCronExprArr(array $value)

@api

Since

100.0.2

Definition at line 36 of file Schedule.php.

Constructor & Destructor Documentation

__construct()

__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 = [],
		TimezoneInterface	$timezoneConverter = null
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
TimezoneInterface	$timezoneConverter

Definition at line 61 of file Schedule.php.

      {
        parent::__construct($context, $registry, $resource, $resourceCollection, $data);
        $this->timezoneConverter = $timezoneConverter ?: ObjectManager::getInstance()->get(TimezoneInterface::class);
    }

Member Function Documentation

_construct()

_construct

(

)

Definition at line 76 of file Schedule.php.

    {
        $this->_init(\Magento\Cron\Model\ResourceModel\Schedule::class);
    }

getNumeric()

getNumeric

(

$value

)

Get number of a month.

Parameters

int | string

$value

Returns

bool|int|string

Definition at line 203 of file Schedule.php.

    {
        static $data = [
            'jan' => 1,
            'feb' => 2,
            'mar' => 3,
            'apr' => 4,
            'may' => 5,
            'jun' => 6,
            'jul' => 7,
            'aug' => 8,
            'sep' => 9,
            'oct' => 10,
            'nov' => 11,
            'dec' => 12,
            'sun' => 0,
            'mon' => 1,
            'tue' => 2,
            'wed' => 3,
            'thu' => 4,
            'fri' => 5,
            'sat' => 6,
        ];

        if (is_numeric($value)) {
            return $value;
        }

        if (is_string($value)) {
            $value = strtolower(substr($value, 0, 3));
            if (isset($data[$value])) {
                return $data[$value];
            }
        }

        return false;
    }

matchCronExpression()

matchCronExpression	(		$expr,
			$num
	)

Match cron expression.

Parameters

string	$expr
int	$num

Returns

bool

Exceptions

Definition at line 139 of file Schedule.php.

    {
        // handle ALL match
        if ($expr === '*') {
            return true;
        }

        // handle multiple options
        if (strpos($expr, ',') !== false) {
            foreach (explode(',', $expr) as $e) {
                if ($this->matchCronExpression($e, $num)) {
                    return true;
                }
            }
            return false;
        }

        // handle modulus
        if (strpos($expr, '/') !== false) {
            $e = explode('/', $expr);
            if (sizeof($e) !== 2) {
                throw new CronException(__('Invalid cron expression, expecting \'match/modulus\': %1', $expr));
            }
            if (!is_numeric($e[1])) {
                throw new CronException(__('Invalid cron expression, expecting numeric modulus: %1', $expr));
            }
            $expr = $e[0];
            $mod = $e[1];
        } else {
            $mod = 1;
        }

        // handle all match by modulus
        if ($expr === '*') {
            $from = 0;
            $to = 60;
        } elseif (strpos($expr, '-') !== false) {
            // handle range
            $e = explode('-', $expr);
            if (sizeof($e) !== 2) {
                throw new CronException(__('Invalid cron expression, expecting \'from-to\' structure: %1', $expr));
            }

            $from = $this->getNumeric($e[0]);
            $to = $this->getNumeric($e[1]);
        } else {
            // handle regular token
            $from = $this->getNumeric($expr);
            $to = $from;
        }

        if ($from === false || $to === false) {
            throw new CronException(__('Invalid cron expression: %1', $expr));
        }

        return $num >= $from && $num <= $to && $num % $mod === 0;
    }

setCronExpr()

setCronExpr

(

$expr

)

Set cron expression.

Parameters

string

$expr

Returns

$this

Exceptions

Definition at line 88 of file Schedule.php.

    {
        $e = preg_split('#\s+#', $expr, null, PREG_SPLIT_NO_EMPTY);
        if (sizeof($e) < 5 || sizeof($e) > 6) {
            throw new CronException(__('Invalid cron expression: %1', $expr));
        }

        $this->setCronExprArr($e);
        return $this;
    }

tryLockJob()

tryLockJob

(

)

Lock the cron job so no other scheduled instances run simultaneously.

Sets a job to STATUS_RUNNING only if it is currently in STATUS_PENDING and no other jobs of the same code are currently in STATUS_RUNNING. Returns true if status was changed and false otherwise.

Returns

boolean

Definition at line 250 of file Schedule.php.

    {
        if ($this->_getResource()->trySetJobUniqueStatusAtomic(
            $this->getId(),
            self::STATUS_RUNNING,
            self::STATUS_PENDING
        )) {
            $this->setStatus(self::STATUS_RUNNING);
            return true;
        }
        return false;
    }

trySchedule()

trySchedule

(

)

Checks the observer's cron expression against time.

Supports $this->setCronExpr('* 0-5,10-59/5 2-10,15-25 january-june/2 mon-fri')

Returns

bool

Definition at line 106 of file Schedule.php.

    {
        $time = $this->getScheduledAt();
        $e = $this->getCronExprArr();

        if (!$e || !$time) {
            return false;
        }
        if (!is_numeric($time)) {
            //convert time from UTC to admin store timezone
            //we assume that all schedules in configuration (crontab.xml and DB tables) are in admin store timezone
            $time = $this->timezoneConverter->date($time)->format('Y-m-d H:i');
            $time = strtotime($time);
        }
        $match = $this->matchCronExpression($e[0], strftime('%M', $time))
            && $this->matchCronExpression($e[1], strftime('%H', $time))
            && $this->matchCronExpression($e[2], strftime('%d', $time))
            && $this->matchCronExpression($e[3], strftime('%m', $time))
            && $this->matchCronExpression($e[4], strftime('%w', $time));

        return $match;
    }

Field Documentation

STATUS_ERROR

const STATUS_ERROR = 'error'

Definition at line 46 of file Schedule.php.

STATUS_MISSED

const STATUS_MISSED = 'missed'

Definition at line 44 of file Schedule.php.

STATUS_PENDING

const STATUS_PENDING = 'pending'

Definition at line 38 of file Schedule.php.

STATUS_RUNNING

const STATUS_RUNNING = 'running'

Definition at line 40 of file Schedule.php.

STATUS_SUCCESS

const STATUS_SUCCESS = 'success'

Definition at line 42 of file Schedule.php.

---

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

• vendor/magento/module-cron/Model/Schedule.php