diff options
author | mattab <matthieu.aubry@gmail.com> | 2013-03-28 03:42:39 +0400 |
---|---|---|
committer | mattab <matthieu.aubry@gmail.com> | 2013-03-28 03:42:40 +0400 |
commit | ae4b03163792f0b6e933933e5d37df87dc3fd566 (patch) | |
tree | d1d7510a9728f587d3d63ebd03e4ecf3d904838b /core/ScheduledTask.php | |
parent | 158c2150f5f2e13ece459b8d131244c11b763997 (diff) |
Mass conversion of all files to the newly agreed coding standard: PSR 1/2
Converting Piwik core source files, PHP, JS, TPL, CSS
More info: http://piwik.org/participate/coding-standards/
Diffstat (limited to 'core/ScheduledTask.php')
-rw-r--r-- | core/ScheduledTask.php | 271 |
1 files changed, 135 insertions, 136 deletions
diff --git a/core/ScheduledTask.php b/core/ScheduledTask.php index 689f835d8e..585d793b91 100644 --- a/core/ScheduledTask.php +++ b/core/ScheduledTask.php @@ -1,153 +1,152 @@ <?php /** * Piwik - Open source web analytics - * + * * @link http://piwik.org * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later - * + * * @category Piwik * @package Piwik */ /** * Piwik_ScheduledTask is used by the task scheduler and by plugins to configure runnable tasks. - * + * * @package Piwik * @subpackage Piwik_ScheduledTask */ class Piwik_ScheduledTask { - const LOWEST_PRIORITY = 12; - const LOW_PRIORITY = 9; - const NORMAL_PRIORITY = 6; - const HIGH_PRIORITY = 3; - const HIGHEST_PRIORITY = 0; - - /** - * Object instance on which the method will be executed by the task scheduler - * @var string - */ - var $objectInstance; - - /** - * Class name where the specified method is located - * @var string - */ - var $className; - - /** - * Class method to run when task is scheduled - * @var string - */ - var $methodName; - - /** - * Parameter to pass to the executed method - * @var string - */ - var $methodParameter; - - /** - * The scheduled time policy - * @var Piwik_ScheduledTime - */ - var $scheduledTime; - - /** - * The priority of a task. Affects the order in which this task will be run. - * @var int - */ - var $priority; - - function __construct( $_objectInstance, $_methodName, $_methodParameter, $_scheduledTime, $_priority = self::NORMAL_PRIORITY ) - { - $this->className = get_class($_objectInstance); - - if ($_priority < self::HIGHEST_PRIORITY || $_priority > self::LOWEST_PRIORITY) - { - throw new Exception("Invalid priority for ScheduledTask '$this->className.$_methodName': $_priority"); - } - - $this->objectInstance = $_objectInstance; - $this->methodName = $_methodName; - $this->scheduledTime = $_scheduledTime; - $this->methodParameter = $_methodParameter; - $this->priority = $_priority; - } - - /** - * Return the object instance on which the method should be executed - * @return string - */ - public function getObjectInstance() - { - return $this->objectInstance; - } - - /** - * Return class name - * @return string - */ - public function getClassName() - { - return $this->className; - } - - /** - * Return method name - * @return string - */ - public function getMethodName() - { - return $this->methodName; - } - - /** - * Return method parameter - * @return string - */ - public function getMethodParameter() - { - return $this->methodParameter; - } - - - /** - * Return scheduled time - * @return Piwik_ScheduledTime - */ - public function getScheduledTime() - { - return $this->scheduledTime; - } - - /** - * Return the rescheduled time in milliseconds - * @return int - */ - public function getRescheduledTime() - { - return $this->getScheduledTime()->getRescheduledTime(); - } - - /** - * Return the task priority. The priority will be an integer whose value is - * between Piwik_ScheduledTask::HIGH_PRIORITY and Piwik_ScheduledTask::LOW_PRIORITY. - * - * @return int - */ - public function getPriority() - { - return $this->priority; - } - - public function getName() - { - return self::getTaskName($this->getClassName(), $this->getMethodName(), $this->getMethodParameter()); - } - - static public function getTaskName($className, $methodName, $methodParameter = null) - { - return $className . '.' . $methodName . ($methodParameter == null ? '' : '_' . $methodParameter); - } + const LOWEST_PRIORITY = 12; + const LOW_PRIORITY = 9; + const NORMAL_PRIORITY = 6; + const HIGH_PRIORITY = 3; + const HIGHEST_PRIORITY = 0; + + /** + * Object instance on which the method will be executed by the task scheduler + * @var string + */ + var $objectInstance; + + /** + * Class name where the specified method is located + * @var string + */ + var $className; + + /** + * Class method to run when task is scheduled + * @var string + */ + var $methodName; + + /** + * Parameter to pass to the executed method + * @var string + */ + var $methodParameter; + + /** + * The scheduled time policy + * @var Piwik_ScheduledTime + */ + var $scheduledTime; + + /** + * The priority of a task. Affects the order in which this task will be run. + * @var int + */ + var $priority; + + function __construct($_objectInstance, $_methodName, $_methodParameter, $_scheduledTime, $_priority = self::NORMAL_PRIORITY) + { + $this->className = get_class($_objectInstance); + + if ($_priority < self::HIGHEST_PRIORITY || $_priority > self::LOWEST_PRIORITY) { + throw new Exception("Invalid priority for ScheduledTask '$this->className.$_methodName': $_priority"); + } + + $this->objectInstance = $_objectInstance; + $this->methodName = $_methodName; + $this->scheduledTime = $_scheduledTime; + $this->methodParameter = $_methodParameter; + $this->priority = $_priority; + } + + /** + * Return the object instance on which the method should be executed + * @return string + */ + public function getObjectInstance() + { + return $this->objectInstance; + } + + /** + * Return class name + * @return string + */ + public function getClassName() + { + return $this->className; + } + + /** + * Return method name + * @return string + */ + public function getMethodName() + { + return $this->methodName; + } + + /** + * Return method parameter + * @return string + */ + public function getMethodParameter() + { + return $this->methodParameter; + } + + + /** + * Return scheduled time + * @return Piwik_ScheduledTime + */ + public function getScheduledTime() + { + return $this->scheduledTime; + } + + /** + * Return the rescheduled time in milliseconds + * @return int + */ + public function getRescheduledTime() + { + return $this->getScheduledTime()->getRescheduledTime(); + } + + /** + * Return the task priority. The priority will be an integer whose value is + * between Piwik_ScheduledTask::HIGH_PRIORITY and Piwik_ScheduledTask::LOW_PRIORITY. + * + * @return int + */ + public function getPriority() + { + return $this->priority; + } + + public function getName() + { + return self::getTaskName($this->getClassName(), $this->getMethodName(), $this->getMethodParameter()); + } + + static public function getTaskName($className, $methodName, $methodParameter = null) + { + return $className . '.' . $methodName . ($methodParameter == null ? '' : '_' . $methodParameter); + } } |