Mage_Cron_Model_Schedule Class Reference

Inheritance diagram for Mage_Cron_Model_Schedule:

List of all members.

Public Member Functions
	_construct ()
	setCronExpr ($expr)
	trySchedule ($time)
	matchCronExpression ($expr, $num)
	getNumeric ($value)
Public Attributes
const	STATUS_PENDING = 'pending'
const	STATUS_RUNNING = 'running'
const	STATUS_SUCCESS = 'success'
const	STATUS_MISSED = 'missed'
const	STATUS_ERROR = 'error'

---

Detailed Description

Definition at line 34 of file Schedule.php.

---

Member Function Documentation

_construct

(

)

Enter description here...

Reimplemented from Varien_Object.

Definition at line 42 of file Schedule.php.

    {
        $this->_init('cron/schedule');
    }

getNumeric

(

$

value

)

Definition at line 151 of file Schedule.php.

    {
        static $data = array(
            '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	(	$	expr,
		$	num
	)

Definition at line 91 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 Mage::exception('Mage_Cron', "Invalid cron expression, expecting 'match/modulus': ".$expr);
            }
            if (!is_numeric($e[1])) {
                throw Mage::exception('Mage_Cron', "Invalid cron expression, expecting numeric modulus: ".$expr);
            }
            $expr = $e[0];
            $mod = $e[1];
        } else {
            $mod = 1;
        }

        // handle all match by modulus
        if ($expr==='*') {
            $from = 0;
            $to = 60;
        }
        // handle range
        elseif (strpos($expr,'-')!==false) {
            $e = explode('-', $expr);
            if (sizeof($e)!==2) {
                throw Mage::exception('Mage_Cron', "Invalid cron expression, expecting 'from-to' structure: ".$expr);
            }

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

        if ($from===false || $to===false) {
            throw Mage::exception('Mage_Cron', "Invalid cron expression: ".$expr);
        }

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

setCronExpr

(

$

expr

)

Definition at line 47 of file Schedule.php.

    {
        $e = preg_split('#\s+#', $expr, null, PREG_SPLIT_NO_EMPTY);
        if (sizeof($e)<5 || sizeof($e)>6) {
            throw Mage::exception('Mage_Cron', 'Invalid cron expression: '.$expr);
        }

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

trySchedule

(

$

time

)

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')

Parameters:

Varien_Event

$event

Returns:

boolean

Definition at line 66 of file Schedule.php.

    {
        $e = $this->getCronExprArr();
        if (!$e || !$time) {
            return false;
        }
        if (!is_numeric($time)) {
            $time = strtotime($time);
        }

        $d = getdate(Mage::getSingleton('core/date')->timestamp($time));

        $match = $this->matchCronExpression($e[0], $d['minutes'])
            && $this->matchCronExpression($e[1], $d['hours'])
            && $this->matchCronExpression($e[2], $d['mday'])
            && $this->matchCronExpression($e[3], $d['mon'])
            && $this->matchCronExpression($e[4], $d['wday']);

        if ($match) {
            $this->setCreatedAt(strftime('%Y-%m-%d %H:%M:%S', time()));
            $this->setScheduledAt(strftime('%Y-%m-%d %H:%M', $time));
        }
        return $match;
    }

---

Member Data Documentation

const STATUS_ERROR = 'error'

Definition at line 40 of file Schedule.php.

const STATUS_MISSED = 'missed'

Definition at line 39 of file Schedule.php.

const STATUS_PENDING = 'pending'

Definition at line 36 of file Schedule.php.

const STATUS_RUNNING = 'running'

Definition at line 37 of file Schedule.php.

const STATUS_SUCCESS = 'success'

Definition at line 38 of file Schedule.php.

---

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

• app/code/core/Mage/Cron/Model/Schedule.php