[TASK] Scheduler: Code clean up
authorFrancois Suter <francois@typo3.org>
Fri, 24 Jun 2011 16:14:44 +0000 (18:14 +0200)
committerFrancois Suter <francois@typo3.org>
Fri, 24 Jun 2011 16:26:39 +0000 (18:26 +0200)
Clean up code in the Scheduler system extension: phpDoc,
CGLs compliancy, spelling mistakes, type hinting.

Change-Id: I59cb7450fd31f714590b81df33e2986397be2545
Resolves: #27687
Releases: 4.6
Reviewed-on: http://review.typo3.org/2917
Reviewed-by: Francois Suter
Tested-by: Francois Suter
20 files changed:
typo3/sysext/scheduler/class.tx_scheduler.php
typo3/sysext/scheduler/class.tx_scheduler_croncmd.php
typo3/sysext/scheduler/class.tx_scheduler_croncmd_normalize.php
typo3/sysext/scheduler/class.tx_scheduler_execution.php
typo3/sysext/scheduler/class.tx_scheduler_module.php
typo3/sysext/scheduler/class.tx_scheduler_task.php
typo3/sysext/scheduler/cli/scheduler_cli_dispatch.php
typo3/sysext/scheduler/examples/class.tx_scheduler_sleeptask.php
typo3/sysext/scheduler/examples/class.tx_scheduler_sleeptask_additionalfieldprovider.php
typo3/sysext/scheduler/examples/class.tx_scheduler_testtask.php
typo3/sysext/scheduler/examples/class.tx_scheduler_testtask_additionalfieldprovider.php
typo3/sysext/scheduler/interfaces/interface.tx_scheduler_additionalfieldprovider.php
typo3/sysext/scheduler/mod1/index.php
typo3/sysext/scheduler/tasks/class.tx_scheduler_cachingframeworkgarbagecollection.php
typo3/sysext/scheduler/tasks/class.tx_scheduler_cachingframeworkgarbagecollection_additionalfieldprovider.php
typo3/sysext/scheduler/tasks/class.tx_scheduler_recyclergarbagecollection_additionalfieldprovider.php
typo3/sysext/scheduler/tasks/class.tx_scheduler_tablegarbagecollection_additionalfieldprovider.php
typo3/sysext/scheduler/tests/class.tx_scheduler_croncmdTest.php
typo3/sysext/scheduler/tests/class.tx_scheduler_croncmd_normalizeTest.php
typo3/sysext/scheduler/tests/class.tx_scheduler_moduleTest.php

index d7a0870..638bef1 100755 (executable)
@@ -42,7 +42,7 @@ class tx_scheduler implements t3lib_Singleton {
        /**
         * Constructor, makes sure all derived client classes are included
         *
-        * @return      void
+        * @return tx_scheduler
         */
        public function __construct() {
                        // Get configuration from the extension manager
@@ -58,9 +58,8 @@ class tx_scheduler implements t3lib_Singleton {
        /**
         * Adds a task to the pool
         *
-        * @param       tx_scheduler_Task       $task: the object representing the task to add
-        * @param       string                          $identifier: the identified of the task
-        * @return      boolean                         TRUE if the task was successfully added, FALSE otherwise
+        * @param tx_scheduler_Task $task The object representing the task to add
+        * @return boolean TRUE if the task was successfully added, FALSE otherwise
         */
        public function addTask(tx_scheduler_Task $task) {
                $taskUid = $task->getTaskUid();
@@ -89,7 +88,7 @@ class tx_scheduler implements t3lib_Singleton {
         * Cleans the execution lists of the scheduled tasks, executions older than 24h are removed
         * TODO: find a way to actually kill the job
         *
-        * @return      void
+        * @return void
         */
        protected function cleanExecutionArrays() {
                $tstamp = $GLOBALS['EXEC_TIME'];
@@ -138,8 +137,8 @@ class tx_scheduler implements t3lib_Singleton {
      * This method executes the given task and properly marks and records that execution
         * It is expected to return FALSE if the task was barred from running or if it was not saved properly
         *
-        * @param       tx_scheduler_Task       $task: the task to execute
-        * @return      boolean                         Whether the task was saved succesfully to the database or not
+        * @param tx_scheduler_Task $task The task to execute
+        * @return boolean Whether the task was saved successfully to the database or not
         */
        public function executeTask(tx_scheduler_Task $task) {
                        // Trigger the saving of the task, as this will calculate its next execution time
@@ -184,7 +183,7 @@ class tx_scheduler implements t3lib_Singleton {
                                $failure = $e;
                        }
 
-                               // Unregister excution
+                               // Un-register execution
                        $task->unmarkExecution($executionID, $failure);
 
                                // Log completion of execution
@@ -204,8 +203,8 @@ class tx_scheduler implements t3lib_Singleton {
        /**
         * This method stores information about the last run of the Scheduler into the system registry
         *
-        * @param       string  $type: Type of run (manual or command-line (assumed to be cron))
-        * @return      void
+        * @param string $type Type of run (manual or command-line (assumed to be cron))
+        * @return void
         */
        public function recordLastRun($type = 'cron') {
                        // Validate input value
@@ -213,9 +212,7 @@ class tx_scheduler implements t3lib_Singleton {
                        $type = 'cron';
                }
 
-               /**
-                * @var t3lib_Registry
-                */
+                       /** @var t3lib_Registry $registry */
                $registry = t3lib_div::makeInstance('t3lib_Registry');
                $runInformation = array('start' => $GLOBALS['EXEC_TIME'], 'end' => time(), 'type' => $type);
                $registry->set('tx_scheduler', 'lastRun', $runInformation);
@@ -225,8 +222,8 @@ class tx_scheduler implements t3lib_Singleton {
         * Removes a task completely from the system.
         * TODO: find a way to actually kill the existing jobs
         *
-        * @param       tx_scheduler_Task       $task: the object representing the task to delete
-        * @return      boolean                         TRUE if task was successfully deleted, FALSE otherwise
+        * @param tx_scheduler_Task $task The object representing the task to delete
+        * @return boolean TRUE if task was successfully deleted, FALSE otherwise
         */
        public function removeTask(tx_scheduler_Task $task) {
                $taskUid = $task->getTaskUid();
@@ -240,8 +237,8 @@ class tx_scheduler implements t3lib_Singleton {
        /**
         * Updates a task in the pool
         *
-        * @param       tx_scheduler_Task       $task: Scheduler task object
-        * @return      boolean                         False if submitted task was not of proper class
+        * @param tx_scheduler_Task $task Scheduler task object
+        * @return boolean False if submitted task was not of proper class
         */
        public function saveTask(tx_scheduler_Task $task) {
                $taskUid = $task->getTaskUid();
@@ -272,8 +269,8 @@ class tx_scheduler implements t3lib_Singleton {
         * with the uid is returned, else the object representing the next due task is returned.
         * If there are no due tasks the method throws an exception.
         *
-        * @param       integer                         $uid: primary key of a task
-        * @return      tx_scheduler_Task       The fetched task object
+        * @param integer $uid Primary key of a task
+        * @return tx_scheduler_Task The fetched task object
         */
        public function fetchTask($uid = 0) {
                $whereClause = '';
@@ -324,9 +321,9 @@ class tx_scheduler implements t3lib_Singleton {
          * This method is used to get the database record for a given task
          * It returns the database record and not the task object
          *
-         * @param      integer $uid: primary key of the task to get
-         * @return     array   Database record for the task
-         * @see        tx_scheduler::fetchTask()
+         * @param integer $uid Primary key of the task to get
+         * @return array Database record for the task
+         * @see tx_scheduler::fetchTask()
          */
         public function fetchTaskRecord($uid) {
                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'tx_scheduler_task', "uid = '" . intval($uid) . "'");
@@ -347,9 +344,9 @@ class tx_scheduler implements t3lib_Singleton {
         * Fetches and unserializes task objects selected with some (SQL) condition
         * Objects are returned as an array
         *
-        * @param       string          $where: part of a SQL where clause (without the "WHERE" keyword)
-        * @param       boolean         $includeDisabledTasks: TRUE if disabled tasks should be fetched too, FALSE otherwise
-        * @return      array           List of task objects
+        * @param string $where Part of a SQL where clause (without the "WHERE" keyword)
+        * @param boolean $includeDisabledTasks TRUE if disabled tasks should be fetched too, FALSE otherwise
+        * @return array List of task objects
         */
        public function fetchTasksWithCondition($where, $includeDisabledTasks = FALSE) {
                $tasks = array();
@@ -386,8 +383,8 @@ class tx_scheduler implements t3lib_Singleton {
         * the unserialization will produce an incomplete object.
         * This test checks whether the unserialized object is of the right (parent) class or not.
         *
-        * @param       object          The object to test
-        * @return      boolean         TRUE if object is a task, FALSE otherwise
+        * @param object $task The object to test
+        * @return boolean TRUE if object is a task, FALSE otherwise
         */
        public function isValidTaskObject($task) {
                return $task instanceof tx_scheduler_Task;
@@ -397,10 +394,10 @@ class tx_scheduler implements t3lib_Singleton {
         * This is a utility method that writes some message to the BE Log
         * It could be expanded to write to some other log
         *
-        * @param       string          The message to write to the log
-        * @param       integer         Status (0 = message, 1 = error)
-        * @param       mixed           Key for the message
-        * @return      void
+        * @param string $message The message to write to the log
+        * @param integer $status Status (0 = message, 1 = error)
+        * @param mixed $code Key for the message
+        * @return void
         */
        public function log($message, $status = 0, $code = 'scheduler') {
                        // Log only if enabled
index 7b30921..ff5f89f 100644 (file)
@@ -60,11 +60,12 @@ class tx_scheduler_CronCmd {
         * Constructor
         *
         * @api
-        * @param string $cronCommand: The cron command can hold any combination documented as valid
-        *              expression in usual unix like crons like vixiecron. Special commands like @weekly,
-        *              ranges, steps and three letter month and weekday abbreviations are allowed.
-        * @param integer $timestamp: optional start time, used in unit tests
-        * @return void
+        * @param string $cronCommand The cron command can hold any combination documented as valid
+        *                expression in usual unix like crons like vixiecron. Special commands like
+        *               "@weekly", ranges, steps and three letter month and weekday abbreviations are allowed.
+        * @param bool|int $timestamp Optional start time, used in unit tests
+        *
+        * @return tx_scheduler_CronCmd
         */
        public function __construct($cronCommand, $timestamp = FALSE) {
                $cronCommand = tx_scheduler_CronCmd_Normalize::normalize($cronCommand);
@@ -83,7 +84,7 @@ class tx_scheduler_CronCmd {
        }
 
        /**
-        * Calulates the date of the next execution.
+        * Calculates the date of the next execution.
         *
         * @api
         * @param integer $level (Deprecated) Number of the current level, e.g. 2 is the day level
@@ -147,7 +148,7 @@ class tx_scheduler_CronCmd {
 
        /**
         * Get cron command sections. Array of strings, each containing either
-        * a list of comma seperated integers or *
+        * a list of comma separated integers or *
         *
         * @return array command sections:
         *      0 => minute
@@ -248,7 +249,7 @@ class tx_scheduler_CronCmd {
         * and on last sunday of october they are set back one hour (from 3:00 to 2:00).
         * This shortens and lengthens the length of a day by one hour.
         *
-        * @param integer timestamp
+        * @param integer $timestamp Unix timestamp
         * @return integer Number of seconds of day
         */
        protected function numberOfSecondsInDay($timestamp) {
@@ -263,7 +264,7 @@ class tx_scheduler_CronCmd {
        /**
         * Round a timestamp down to full minute.
         *
-        * @param integer timestamp
+        * @param integer $timestamp Unix timestamp
         * @return integer Rounded timestamp
         */
        protected function roundTimestamp($timestamp) {
index d562fb5..e05824e 100644 (file)
@@ -59,7 +59,7 @@ final class tx_scheduler_CronCmd_Normalize {
         * Accept special cron command keywords and convert to standard cron syntax.
         * Allowed keywords: @yearly, @annually, @monthly, @weekly, @daily, @midnight, @hourly
         *
-        * @params string $cronCommand cron command
+        * @param string $cronCommand Cron command
         * @return string Normalized cron command if keyword was found, else unchanged cron command
         */
        public static function convertKeywordsToCronCommand($cronCommand) {
@@ -248,8 +248,8 @@ final class tx_scheduler_CronCmd_Normalize {
        /**
         * Convert a range of integers to a list: 4-6 results in a string '4,5,6'
         *
-        * @throws InvalidArgumentException If range can not be coverted to list
-        * @params string $range integer-integer
+        * @throws InvalidArgumentException If range can not be converted to list
+        * @param string $range Integer-integer
         * @return array
         */
        public static function convertRangeToListOfValues($range) {
@@ -310,7 +310,7 @@ final class tx_scheduler_CronCmd_Normalize {
         *      2-10/3 -> 2,5,8
         *
         * @throws Exception if step value is invalid or if resulting list is empty
-        * @param string #stepExpression stepvalue expression
+        * @param string $stepExpression Step value expression
         * @return string Comma separated list of valid values
         */
        public static function reduceListOfValuesByStepValue($stepExpression) {
index bbfdbf6..7840ce3 100644 (file)
@@ -87,8 +87,8 @@ class tx_scheduler_Execution {
        /**
         * This method is used to set the start date
         *
-        * @param       integer         $start: start date (timestamp)
-        * @return      void
+        * @param integer $start Start date (timestamp)
+        * @return void
         */
        public function setStart($start) {
                $this->start = $start;
@@ -97,7 +97,7 @@ class tx_scheduler_Execution {
        /**
         * This method is used to get the start date
         *
-        * @return      integer         start date (timestamp)
+        * @return integer Start date (timestamp)
         */
        public function getStart() {
                return $this->start;
@@ -106,8 +106,8 @@ class tx_scheduler_Execution {
        /**
         * This method is used to set the end date
         *
-        * @param       integer         $end: end date (timestamp)
-        * @return      void
+        * @param integer $end End date (timestamp)
+        * @return void
         */
        public function setEnd($end) {
                $this->end = $end;
@@ -116,7 +116,7 @@ class tx_scheduler_Execution {
        /**
         * This method is used to get the end date
         *
-        * @return      integer         end date (timestamp)
+        * @return integer End date (timestamp)
         */
        public function getEnd() {
                return $this->end;
@@ -125,8 +125,8 @@ class tx_scheduler_Execution {
        /**
         * This method is used to set the interval
         *
-        * @param       integer         $interval: interval (in seconds)
-        * @return      void
+        * @param integer $interval Interval (in seconds)
+        * @return void
         */
        public function setInterval($interval) {
                $this->interval = $interval;
@@ -135,7 +135,7 @@ class tx_scheduler_Execution {
        /**
         * This method is used to get the interval
         *
-        * @return      integer         interval (in seconds)
+        * @return integer Interval (in seconds)
         */
        public function getInterval() {
                return $this->interval;
@@ -144,8 +144,8 @@ class tx_scheduler_Execution {
        /**
         * This method is used to set the multiple execution flag
         *
-        * @param       boolean         $multiple: TRUE if concurrent executions are allowed, FALSE otherwise
-        * @return      void
+        * @param boolean $multiple TRUE if concurrent executions are allowed, FALSE otherwise
+        * @return void
         */
        public function setMultiple($multiple) {
                $this->multiple = $multiple;
@@ -154,7 +154,7 @@ class tx_scheduler_Execution {
        /**
         * This method is used to get the multiple execution flag
         *
-        * @return      boolean         TRUE if concurrent executions are allowed, FALSE otherwise
+        * @return boolean TRUE if concurrent executions are allowed, FALSE otherwise
         */
        public function getMultiple() {
                return $this->multiple;
@@ -163,8 +163,8 @@ class tx_scheduler_Execution {
        /**
         * Set the value of the cron command
         *
-        * @param       string          $cmd: cron command, using cron-like syntax
-        * @return      void
+        * @param string $cmd Cron command, using cron-like syntax
+        * @return void
         */
        public function setCronCmd($cmd) {
                $this->cronCmd = $cmd;
@@ -173,7 +173,7 @@ class tx_scheduler_Execution {
        /**
         * Get the value of the cron command
         *
-        * @return      string          cron command, using cron-like syntax
+        * @return string Cron command, using cron-like syntax
         */
        public function getCronCmd() {
                return $this->cronCmd;
@@ -188,7 +188,7 @@ class tx_scheduler_Execution {
         * Setting this flag to TRUE preserves this task for a single run.
         * Upon next execution, this flag is set to FALSE.
         *
-        * @param       boolean         Is newly created single execution?
+        * @param boolean $isNewSingleExecution Is newly created single execution?
         * @return      void
         * @see tx_scheduler_Execution::getNextExecution()
         */
@@ -199,7 +199,7 @@ class tx_scheduler_Execution {
        /**
         * Get whether this is a newly created single execution
         *
-        * @return      boolean         Is newly created single execution?
+        * @return boolean Is newly created single execution?
         */
        public function getIsNewSingleExecution() {
                return $this->isNewSingleExecution;
@@ -212,7 +212,7 @@ class tx_scheduler_Execution {
        /**
         * This method gets or calculates the next execution date
         *
-        * @return      integer         Timestamp of the next execution
+        * @return integer Timestamp of the next execution
         */
        public function getNextExecution() {
 
@@ -255,11 +255,12 @@ class tx_scheduler_Execution {
        }
 
        /**
-        * Calulates the next execution from a cron command
+        * Calculates the next execution from a cron command
         *
-        * @return      integer         Next execution (timestamp)
+        * @return integer Next execution (timestamp)
         */
        public function getNextCronExecution() {
+                       /** @var $cronCmd tx_scheduler_CronCmd */
                $cronCmd = t3lib_div::makeInstance('tx_scheduler_CronCmd', $this->getCronCmd());
                $cronCmd->calculateNextValue();
 
@@ -269,7 +270,7 @@ class tx_scheduler_Execution {
        /**
         * Checks if the schedule for a task is started or not
         *
-        * @return      boolean         TRUE if the schedule is already active, FALSE otherwise
+        * @return boolean TRUE if the schedule is already active, FALSE otherwise
         */
        public function isStarted() {
                return $this->start < time();
@@ -278,7 +279,7 @@ class tx_scheduler_Execution {
        /**
         * Checks if the schedule for a task is passed or not
         *
-        * @return      boolean         TRUE if the schedule is not active anymore, FALSE otherwise
+        * @return boolean TRUE if the schedule is not active anymore, FALSE otherwise
         */
        public function isEnded() {
                if (empty($this->end)) {
index 1275171..635128e 100644 (file)
@@ -70,7 +70,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Constructor
         *
-        * @return      void
+        * @return tx_scheduler_Module
         */
        public function __construct() {
                $this->backPath = $GLOBALS['BACK_PATH'];
@@ -81,7 +81,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Initializes the backend module
         *
-        * @return      void
+        * @return void
         */
        public function init() {
                parent::init();
@@ -101,7 +101,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Adds items to the ->MOD_MENU array. Used for the function menu selector.
         *
-        * @return      void
+        * @return void
         */
        public function menuConfig() {
                $this->MOD_MENU = array(
@@ -118,7 +118,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Main function of the module. Write the content to $this->content
         *
-        * @return      void
+        * @return void
         */
        public function main() {
                        // Access check!
@@ -152,7 +152,6 @@ class tx_scheduler_Module extends t3lib_SCbase {
                }
 
                        // Place content inside template
-
                $content = $this->doc->moduleBody(
                        array(),
                        $this->getDocHeaderButtons(),
@@ -169,7 +168,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Generate the module's content
         *
-        * @return      string  HTML of the module's main content
+        * @return string HTML of the module's main content
         */
        protected function getModuleContent() {
                $content = '';
@@ -215,7 +214,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                                                                // An exception may happen when the task to
                                                                // edit could not be found. In this case revert
                                                                // to displaying the list of tasks
-                                                               // It can also happend when attempting to edit a running task
+                                                               // It can also happen when attempting to edit a running task
                                                        $content .= $this->listTasks();
                                                }
                                                break;
@@ -251,7 +250,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * This method actually prints out the module's HTML content
         *
-        * @return      void
+        * @return void
         */
        public function render() {
                echo $this->content;
@@ -262,9 +261,9 @@ class tx_scheduler_Module extends t3lib_SCbase {
         * It will differentiate between a non-existing user and an existing,
         * but disabled user (as per enable fields)
         *
-        * @return      integer         -1      if user doesn't exist
-        *                                               0      if user exists, but is disabled
-        *                                               1      if user exists and is not disabled
+        * @return integer      -1      if user doesn't exist
+        *                                       0      if user exists, but is disabled
+        *                                       1      if user exists and is not disabled
         */
        protected function checkSchedulerUser() {
                $schedulerUserStatus = -1;
@@ -296,7 +295,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * This method creates the "cli_scheduler" BE user if it doesn't exist
         *
-        * @return      void
+        * @return void
         */
        protected function createSchedulerUser() {
                        // Check _cli_scheduler user status
@@ -309,11 +308,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                                // Prepare necessary data for _cli_scheduler user creation
                        $password = md5(uniqid('scheduler', TRUE));
                        $data = array('be_users' => array('NEW' => array('username' => '_cli_scheduler', 'password' => $password, 'pid' => 0)));
-                               /**
-                                * Create an instance of TCEmain and execute user creation
-                                *
-                                * @var t3lib_TCEmain
-                                */
+                               /** @var t3lib_TCEmain $tcemain */
                        $tcemain = t3lib_div::makeInstance('t3lib_TCEmain');
                        $tcemain->stripslashes_values = 0;
                        $tcemain->start($data, array());
@@ -336,13 +331,13 @@ class tx_scheduler_Module extends t3lib_SCbase {
         * This method displays the result of a number of checks
         * on whether the Scheduler is ready to run or running properly
         *
-        * @return      string  further information
+        * @return string Further information
         */
        protected function displayCheckScreen() {
                $message = '';
                $severity = t3lib_FlashMessage::OK;
 
-                       // First, check if cli_sceduler user creation was requested
+                       // First, check if _cli_scheduler user creation was requested
                if ($this->CMD == 'user') {
                        $this->createSchedulerUser();
                }
@@ -351,9 +346,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                $content = $GLOBALS['LANG']->getLL('msg.schedulerSetupCheck');
 
                        // Display information about last automated run, as stored in the system registry
-                       /**
-                        * @var t3lib_Registry
-                        */
+                       /** @var t3lib_Registry $registry */
                $registry = t3lib_div::makeInstance('t3lib_Registry');
                $lastRun = $registry->get('tx_scheduler', 'lastRun');
                if (!is_array($lastRun)) {
@@ -377,6 +370,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                                $severity = t3lib_FlashMessage::INFO;
                        }
                }
+                       /** @var $flashMessage t3lib_FlashMessage */
                $flashMessage = t3lib_div::makeInstance(
                        't3lib_FlashMessage',
                        $message,
@@ -448,7 +442,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * This method gathers information about all available task classes and displays it
         *
-        * @return      string  HTML content to display
+        * @return string HTML content to display
         */
        protected function displayInfoScreen() {
                $content = '';
@@ -511,7 +505,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
         * Display the current server's time along with a help text about server time
         * usage in the Scheduler
         *
-        * @return      string  HTML to display
+        * @return string HTML to display
         */
        protected function displayServerTime() {
                        // Get the current time, formatted
@@ -527,14 +521,11 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Delete a task from the execution queue
         *
-        * @return      void
+        * @return void
         */
        protected function deleteTask() {
                try {
                                // Try to fetch the task and delete it
-                               /**
-                                * @var tx_scheduler_Task
-                                */
                        $task = $this->scheduler->fetchTask($this->submittedData['uid']);
                                // If the task is currently running, it may not be deleted
                        if ($task->isExecutionRunning()) {
@@ -566,14 +557,11 @@ class tx_scheduler_Module extends t3lib_SCbase {
         * all executions.
         * TODO: find a way to really kill the running task
         *
-        * @return      void
+        * @return void
         */
        protected function stopTask() {
                try {
                                // Try to fetch the task and stop it
-                               /**
-                                * @var tx_scheduler_Task
-                                */
                        $task = $this->scheduler->fetchTask($this->submittedData['uid']);
                        if ($task->isExecutionRunning()) {
                                // If the task is indeed currently running, clear marked executions
@@ -617,6 +605,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                                        throw new LogicException('Runnings tasks cannot not be edited', 1251232849);
                                }
                                        // Get the task object
+                                       /** @var $task tx_scheduler_Task */
                                $task = unserialize($taskRecord['serialized_task_object']);
 
                                        // Set some task information
@@ -640,7 +629,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                                                        // Guess task type from the existing information
                                                        // If an interval or a cron command is defined, it's a recurring task
 
-                                                       // FIXME remove magic numbers for the type, use class constants instead
+                                                       // FIXME: remove magic numbers for the type, use class constants instead
                                                $taskInfo['type']      = 2;
                                                $taskInfo['frequency'] = (empty($taskInfo['interval'])) ? $taskInfo['croncmd'] : $taskInfo['interval'];
                                        } else {
@@ -689,6 +678,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                if ($process == 'add') {
                        foreach ($registeredClasses as $class => $registrationInfo) {
                                if (!empty($registrationInfo['provider'])) {
+                                               /** @var $providerObject tx_scheduler_AdditionalFieldProvider */
                                        $providerObject = t3lib_div::getUserObj($registrationInfo['provider']);
                                        if ($providerObject instanceof tx_scheduler_AdditionalFieldProvider) {
                                                $additionalFields = $providerObject->getAdditionalFields($taskInfo, NULL, $this);
@@ -900,7 +890,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Execute all selected tasks
         *
-        * @return      void
+        * @return void
         */
        protected function executeTasks() {
                        // Continue if some elements have been chosen for execution
@@ -950,7 +940,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Assemble display of list of scheduled tasks
         *
-        * @return      string                  table of waiting schedulings
+        * @return string Table of pending tasks
         */
        protected function listTasks() {
                        // Define display format for dates
@@ -1053,6 +1043,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                                $startExecutionElement = '&nbsp;';
 
                                        // Restore the serialized task and pass it a reference to the scheduler object
+                                       /** @var $task tx_scheduler_Task */
                                $task = unserialize($schedulerRecord['serialized_task_object']);
 
                                        // Assemble information about last execution
@@ -1139,6 +1130,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                                        $failureOutput = '';
                                        if (!empty($schedulerRecord['lastexecution_failure'])) {
                                                        // Try to get the stored exception object
+                                                       /** @var $exception Exception */
                                                $exception = unserialize($schedulerRecord['lastexecution_failure']);
                                                        // If the exception could not be unserialized, issue a default error message
                                                if ($exception === FALSE) {
@@ -1233,7 +1225,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Saves a task specified in the backend form to the database
         *
-        * @return      void
+        * @return void
         */
        protected function saveTask() {
 
@@ -1241,9 +1233,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
                if (!empty($this->submittedData['uid'])) {
                        try {
                                $taskRecord = $this->scheduler->fetchTaskRecord($this->submittedData['uid']);
-                               /**
-                                * @var tx_scheduler_Task
-                                */
+                               /** @var tx_scheduler_Task $task */
                                $task = unserialize($taskRecord['serialized_task_object']);
                        } catch (OutOfBoundsException $e) {
                                        // If the task could not be fetched, issue an error message
@@ -1279,6 +1269,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
 
                                // Save additional input values
                        if (!empty($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][$this->submittedData['class']]['additionalFields'])) {
+                                       /** @var $providerObject tx_scheduler_AdditionalFieldProvider */
                                $providerObject = t3lib_div::getUserObj($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][$this->submittedData['class']]['additionalFields']);
                                if ($providerObject instanceof tx_scheduler_AdditionalFieldProvider) {
                                        $providerObject->saveAdditionalFields($this->submittedData, $task);
@@ -1308,6 +1299,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
 
                                // Save additional input values
                        if (!empty($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][$this->submittedData['class']]['additionalFields'])) {
+                                       /** @var $providerObject tx_scheduler_AdditionalFieldProvider */
                                $providerObject = t3lib_div::getUserObj($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][$this->submittedData['class']]['additionalFields']);
                                if ($providerObject instanceof tx_scheduler_AdditionalFieldProvider) {
                                        $providerObject->saveAdditionalFields($this->submittedData, $task);
@@ -1335,9 +1327,9 @@ class tx_scheduler_Module extends t3lib_SCbase {
         *************************/
 
        /**
-        * Checks the submitted data and performs some preprocessing on it
+        * Checks the submitted data and performs some pre-processing on it
         *
-        * @return      boolean         TRUE if everything was ok, FALSE otherwise
+        * @return boolean TRUE if everything was ok, FALSE otherwise
         */
        protected function preprocessData() {
                $result = TRUE;
@@ -1442,8 +1434,8 @@ class tx_scheduler_Module extends t3lib_SCbase {
         * If the string is a valid date, the corresponding timestamp is returned.
         * Otherwise an exception is thrown
         *
-        * @param       string          $string: string to check
-        * @return      integer         Unix timestamp
+        * @param string $string String to check
+        * @return integer Unix timestamp
         */
        public function checkDate($string) {
                        // Try with strtotime
@@ -1479,9 +1471,9 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * This method is used to add a message to the internal queue
         *
-        * @param       string  the message itself
-        * @param       integer message level (-1 = success (default), 0 = info, 1 = notice, 2 = warning, 3 = error)
-        * @return      void
+        * @param string $message The message itself
+        * @param integer $severity Message level (according to t3lib_FlashMessage class constants)
+        * @return void
         */
        public function addMessage($message, $severity = t3lib_FlashMessage::OK) {
                $message = t3lib_div::makeInstance(
@@ -1505,7 +1497,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
         *
         * The name of the class itself is used as the key of the list array
         *
-        * @return      array   List of registered classes
+        * @return array List of registered classes
         */
        protected static function getRegisteredClasses() {
                $list = array();
@@ -1537,7 +1529,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Gets the filled markers that are used in the HTML template.
         *
-        * @return      array           The filled marker array
+        * @return array The filled marker array
         */
        protected function getTemplateMarkers() {
                $markers = array(
@@ -1553,7 +1545,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Gets the function menu selector for this backend module.
         *
-        * @return      string          The HTML representation of the function menu selector
+        * @return string The HTML representation of the function menu selector
         */
        protected function getFunctionMenu() {
                $functionMenu = t3lib_BEfunc::getFuncMenu(
@@ -1569,7 +1561,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Gets the buttons that shall be rendered in the docHeader.
         *
-        * @return      array           Available buttons for the docHeader
+        * @return array Available buttons for the docHeader
         */
        protected function getDocHeaderButtons() {
                $buttons = array(
@@ -1589,7 +1581,7 @@ class tx_scheduler_Module extends t3lib_SCbase {
        /**
         * Gets the button to set a new shortcut in the backend (if current user is allowed to).
         *
-        * @return      string          HTML representiation of the shortcut button
+        * @return string HTML representation of the shortcut button
         */
        protected function getShortcutButton() {
                $result = '';
index eafea1f..7a07e99 100755 (executable)
@@ -86,7 +86,7 @@ abstract class tx_scheduler_Task {
         * to be handled and logged by the client implementations.
         * Should return TRUE on successful execution, FALSE on error.
         *
-        * @return boolean      Returns TRUE on successful execution, FALSE on error
+        * @return boolean Returns TRUE on successful execution, FALSE on error
         */
        abstract public function execute();
 
@@ -96,7 +96,7 @@ abstract class tx_scheduler_Task {
         * This additional information is used - for example - in the Scheduler's BE module
         * This method should be implemented in most task classes
         *
-        * @return      string  Information to display
+        * @return string Information to display
         */
        public function getAdditionalInformation() {
                return '';
@@ -105,8 +105,8 @@ abstract class tx_scheduler_Task {
        /**
         * This method is used to set the unique id of the task
         *
-        * @param       integer $id: primary key (from the database record) of the scheduled task
-        * @return      void
+        * @param integer $id Primary key (from the database record) of the scheduled task
+        * @return void
         */
        public function setTaskUid($id) {
                $this->taskUid = intval($id);
@@ -115,7 +115,7 @@ abstract class tx_scheduler_Task {
        /**
         * This method returns the unique id of the task
         *
-        * @return      integer         The id of the task
+        * @return integer The id of the task
         */
        public function getTaskUid() {
                return $this->taskUid;
@@ -124,7 +124,7 @@ abstract class tx_scheduler_Task {
        /**
         * This method returns the disable status of the task
         *
-        * @return      boolean         TRUE if task is disabled, FALSE otherwise
+        * @return boolean TRUE if task is disabled, FALSE otherwise
         */
        public function isDisabled() {
                return $this->disabled;
@@ -133,8 +133,8 @@ abstract class tx_scheduler_Task {
        /**
         * This method is used to set the disable status of the task
         *
-        * @param       boolean $flag: TRUE if task should be disabled, FALSE otherwise
-        * @return      void
+        * @param boolean $flag TRUE if task should be disabled, FALSE otherwise
+        * @return void
         */
        public function setDisabled($flag) {
                if ($flag) {
@@ -147,8 +147,8 @@ abstract class tx_scheduler_Task {
        /**
         * This method is used to set the timestamp corresponding to the next execution time of the task
         *
-        * @param       integer         $timestamp: timestamp of next execution
-        * @return      void
+        * @param integer $timestamp Timestamp of next execution
+        * @return void
         */
        public function setExecutionTime($timestamp) {
                $this->executionTime = intval($timestamp);
@@ -156,7 +156,8 @@ abstract class tx_scheduler_Task {
 
        /**
         * This method returns the timestamp corresponding to the next execution time of the task
-        * @return      integer         Timestamp of next execution
+        *
+        * @return integer Timestamp of next execution
         */
        public function getExecutionTime() {
                return $this->executionTime;
@@ -185,9 +186,10 @@ abstract class tx_scheduler_Task {
        /**
         * Registers a single execution of the task
         *
-        * @param       integer $timestamp: Timestamp of the next execution
+        * @param integer $timestamp Timestamp of the next execution
         */
        public function registerSingleExecution($timestamp) {
+                       /** @var $execution tx_scheduler_Execution */
                $execution = t3lib_div::makeInstance('tx_scheduler_Execution');
                $execution->setStart($timestamp);
                $execution->setInterval(0);
@@ -200,16 +202,17 @@ abstract class tx_scheduler_Task {
        }
 
        /**
-        * Registers a reccuring excecution of the task
+        * Registers a recurring execution of the task
         *
-        * @param       integer         $start: the first date/time where this execution should occur (timestamp)
-        * @param       string          $interval: execution interval in seconds
-        * @param       integer         $end: the last date/time where this execution should occur (timestamp)
-        * @param       boolean         $multiple: set to FALSE if multiple executions of this task are not permitted in parallel
-        * @param       string          $croncmd: used like in crontab (minute hour day month weekday)
-        * @return      void
+        * @param integer $start The first date/time where this execution should occur (timestamp)
+        * @param string $interval Execution interval in seconds
+        * @param integer $end The last date/time where this execution should occur (timestamp)
+        * @param boolean $multiple Set to FALSE if multiple executions of this task are not permitted in parallel
+        * @param string $cron_cmd Used like in crontab (minute hour day month weekday)
+        * @return void
         */
        public function registerRecurringExecution($start, $interval, $end = 0, $multiple = FALSE, $cron_cmd = '') {
+                       /** @var $execution tx_scheduler_Execution */
                $execution = t3lib_div::makeInstance('tx_scheduler_Execution');
                        // Set general values
                $execution->setStart($start);
@@ -232,7 +235,7 @@ abstract class tx_scheduler_Task {
        /**
         * Sets the internal execution object
         *
-        * @param       tx_scheduler_Execution  $execution: the execution to add
+        * @param tx_scheduler_Execution $execution The execution to add
         */
        public function setExecution(tx_scheduler_Execution $execution) {
                $this->execution = $execution;
@@ -241,7 +244,7 @@ abstract class tx_scheduler_Task {
        /**
         * Returns the execution object
         *
-        * @return      tx_scheduler_Execution  The internal execution object
+        * @return tx_scheduler_Execution The internal execution object
         */
        public function getExecution() {
                return $this->execution;
@@ -250,7 +253,7 @@ abstract class tx_scheduler_Task {
        /**
         * Returns the timestamp for next due execution of the task
         *
-        * @return      integer         Date and time of the next execution as a timestamp
+        * @return integer Date and time of the next execution as a timestamp
         */
        public function getNextDueExecution() {
 
@@ -261,7 +264,7 @@ abstract class tx_scheduler_Task {
        /**
         * Returns TRUE if several runs of the task are allowed concurrently
         *
-        * @return      boolean         TRUE if concurrent executions are allowed, FALSE otherwise
+        * @return boolean TRUE if concurrent executions are allowed, FALSE otherwise
         */
        public function areMultipleExecutionsAllowed() {
                return $this->execution->getMultiple();
@@ -270,7 +273,7 @@ abstract class tx_scheduler_Task {
        /**
         * Returns TRUE if an instance of the task is already running
         *
-        * @return      boolean         TRUE if an instance is already running, FALSE otherwise
+        * @return boolean TRUE if an instance is already running, FALSE otherwise
         */
        public function isExecutionRunning() {
                $isRunning = FALSE;
@@ -297,7 +300,7 @@ abstract class tx_scheduler_Task {
         * This method adds current execution to the execution list
         * It also logs the execution time and mode
         *
-        * @return      integer         Execution id
+        * @return integer Execution id
         */
        public function markExecution() {
                $queryArr = array(
@@ -343,8 +346,8 @@ abstract class tx_scheduler_Task {
        /**
         * Removes given execution from list
         *
-        * @param       integer         Id of the execution to remove.
-        * @param       Exception       An exception to signal a failed execution
+        * @param integer $executionID Id of the execution to remove.
+        * @param Exception $failure An exception to signal a failed execution
         * @return      void
         */
        public function unmarkExecution($executionID, Exception $failure = NULL) {
@@ -400,7 +403,7 @@ abstract class tx_scheduler_Task {
        /**
         * Clears all marked executions
         *
-        * @return      boolean         TRUE if the clearing succeeded, FALSE otherwise
+        * @return boolean TRUE if the clearing succeeded, FALSE otherwise
         */
        public function unmarkAllExecutions() {
                        // Set the serialized executions field to empty
index 9711a22..a97b3fe 100644 (file)
 if ((TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI) && basename(PATH_thisScript) == 'cli_dispatch.phpsh') {
        $hasTask = TRUE;
                // Create an instance of the scheduler object
-               /**
-                * @var tx_scheduler
-                */
+               /** @var $scheduler tx_scheduler */
        $scheduler = t3lib_div::makeInstance('tx_scheduler');
                // Loop as long as there are tasks
        do {
                        // Try getting the next task and execute it
                        // If there are no more tasks to execute, an exception is thrown by tx_scheduler::fetchTask()
                try {
-                               /**
-                                * @var tx_scheduler_Task
-                                */
+                               /** @var $task tx_scheduler_Task */
                        $task = $scheduler->fetchTask();
                        $hasTask = TRUE;
                        try {
index 568adc0..249169f 100644 (file)
@@ -35,7 +35,7 @@ class tx_scheduler_SleepTask extends tx_scheduler_Task {
        /**
         * Number of seconds the task should be sleeping for
         *
-        * @var integer         $sleepTime
+        * @var integer $sleepTime
         */
         public $sleepTime = 10;
 
@@ -43,7 +43,7 @@ class tx_scheduler_SleepTask extends tx_scheduler_Task {
         * Function executed from the Scheduler.
         * Goes to sleep ;-)
         *
-        * @return      void
+        * @return boolean
         */
        public function execute() {
                $time = 10;
@@ -60,7 +60,7 @@ class tx_scheduler_SleepTask extends tx_scheduler_Task {
        /**
         * This method returns the sleep duration as additional information
         *
-        * @return      string  Information to display
+        * @return string Information to display
         */
        public function getAdditionalInformation() {
                return $GLOBALS['LANG']->sL('LLL:EXT:scheduler/mod1/locallang.xml:label.sleepTime') . ': ' . $this->sleepTime;
index f3e89fc..39e463f 100644 (file)
@@ -35,16 +35,16 @@ class tx_scheduler_SleepTask_AdditionalFieldProvider implements tx_scheduler_Add
         * This method is used to define new fields for adding or editing a task
         * In this case, it adds an sleep time field
         *
-        * @param       array                                   $taskInfo: reference to the array containing the info used in the add/edit form
-        * @param       object                                  $task: when editing, reference to the current task object. Null when adding.
-        * @param       tx_scheduler_Module             $parentObject: reference to the calling object (Scheduler's BE module)
-        * @return      array                                   Array containg all the information pertaining to the additional fields
-        *                                                                      The array is multidimensional, keyed to the task class name and each field's id
-        *                                                                      For each field it provides an associative sub-array with the following:
-        *                                                                              ['code']                => The HTML code for the field
-        *                                                                              ['label']               => The label of the field (possibly localized)
-        *                                                                              ['cshKey']              => The CSH key for the field
-        *                                                                              ['cshLabel']    => The code of the CSH label
+        * @param array $taskInfo Reference to the array containing the info used in the add/edit form
+        * @param object $task When editing, reference to the current task object. Null when adding.
+        * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)
+        * @return array        Array containing all the information pertaining to the additional fields
+        *                                      The array is multidimensional, keyed to the task class name and each field's id
+        *                                      For each field it provides an associative sub-array with the following:
+        *                                              ['code']                => The HTML code for the field
+        *                                              ['label']               => The label of the field (possibly localized)
+        *                                              ['cshKey']              => The CSH key for the field
+        *                                              ['cshLabel']    => The code of the CSH label
         */
        public function getAdditionalFields(array &$taskInfo, $task, tx_scheduler_Module $parentObject) {
 
@@ -80,9 +80,9 @@ class tx_scheduler_SleepTask_AdditionalFieldProvider implements tx_scheduler_Add
         * This method checks any additional data that is relevant to the specific task
         * If the task class is not relevant, the method is expected to return TRUE
         *
-        * @param       array                                   $submittedData: reference to the array containing the data submitted by the user
-        * @param       tx_scheduler_Module             $parentObject: reference to the calling object (Scheduler's BE module)
-        * @return      boolean                                 TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
+        * @param array $submittedData Reference to the array containing the data submitted by the user
+        * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)
+        * @return boolean TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
         */
        public function validateAdditionalFields(array &$submittedData, tx_scheduler_Module $parentObject) {
                $submittedData['sleepTime'] = intval($submittedData['sleepTime']);
@@ -100,9 +100,9 @@ class tx_scheduler_SleepTask_AdditionalFieldProvider implements tx_scheduler_Add
         * This method is used to save any additional input into the current task object
         * if the task class matches
         *
-        * @param       array                           $submittedData: array containing the data submitted by the user
-        * @param       tx_scheduler_Task       $task: reference to the current task object
-        * @return      void
+        * @param array $submittedData Array containing the data submitted by the user
+        * @param tx_scheduler_Task $task Reference to the current task object
+        * @return void
         */
        public function saveAdditionalFields(array $submittedData, tx_scheduler_Task $task) {
                $task->sleepTime = $submittedData['sleepTime'];
index 06996b0..2c69c66 100644 (file)
@@ -34,7 +34,7 @@ class tx_scheduler_TestTask extends tx_scheduler_Task {
        /**
         * An email address to be used during the process
         *
-        * @var string          $email
+        * @var string $email
         */
         var $email;
 
@@ -42,7 +42,7 @@ class tx_scheduler_TestTask extends tx_scheduler_Task {
         * Function executed from the Scheduler.
         * Sends an email
         *
-        * @return      void
+        * @return boolean
         */
        public function execute() {
                $success = FALSE;
@@ -111,7 +111,7 @@ class tx_scheduler_TestTask extends tx_scheduler_Task {
        /**
         * This method returns the destination mail address as additional information
         *
-        * @return      string  Information to display
+        * @return string Information to display
         */
        public function getAdditionalInformation() {
                return $GLOBALS['LANG']->sL('LLL:EXT:scheduler/mod1/locallang.xml:label.email') . ': ' . $this->email;
index ed7c411..ac14d4c 100644 (file)
@@ -35,16 +35,16 @@ class tx_scheduler_TestTask_AdditionalFieldProvider implements tx_scheduler_Addi
         * This method is used to define new fields for adding or editing a task
         * In this case, it adds an email field
         *
-        * @param       array                                   $taskInfo: reference to the array containing the info used in the add/edit form
-        * @param       object                                  $task: when editing, reference to the current task object. Null when adding.
-        * @param       tx_scheduler_Module             $parentObject: reference to the calling object (Scheduler's BE module)
-        * @return      array                                   Array containg all the information pertaining to the additional fields
-        *                                                                      The array is multidimensional, keyed to the task class name and each field's id
-        *                                                                      For each field it provides an associative sub-array with the following:
-        *                                                                              ['code']                => The HTML code for the field
-        *                                                                              ['label']               => The label of the field (possibly localized)
-        *                                                                              ['cshKey']              => The CSH key for the field
-        *                                                                              ['cshLabel']    => The code of the CSH label
+        * @param array $taskInfo Reference to the array containing the info used in the add/edit form
+        * @param object $task When editing, reference to the current task object. Null when adding.
+        * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)
+        * @return array        Array containing all the information pertaining to the additional fields
+        *                                      The array is multidimensional, keyed to the task class name and each field's id
+        *                                      For each field it provides an associative sub-array with the following:
+        *                                              ['code']                => The HTML code for the field
+        *                                              ['label']               => The label of the field (possibly localized)
+        *                                              ['cshKey']              => The CSH key for the field
+        *                                              ['cshLabel']    => The code of the CSH label
         */
        public function getAdditionalFields(array &$taskInfo, $task, tx_scheduler_Module $parentObject) {
 
@@ -81,9 +81,9 @@ class tx_scheduler_TestTask_AdditionalFieldProvider implements tx_scheduler_Addi
         * This method checks any additional data that is relevant to the specific task
         * If the task class is not relevant, the method is expected to return TRUE
         *
-        * @param       array                                   $submittedData: reference to the array containing the data submitted by the user
-        * @param       tx_scheduler_Module             $parentObject: reference to the calling object (Scheduler's BE module)
-        * @return      boolean                                 TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
+        * @param array  $submittedData Reference to the array containing the data submitted by the user
+        * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)
+        * @return boolean TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
         */
        public function validateAdditionalFields(array &$submittedData, tx_scheduler_Module $parentObject) {
                $submittedData['email'] = trim($submittedData['email']);
@@ -102,9 +102,9 @@ class tx_scheduler_TestTask_AdditionalFieldProvider implements tx_scheduler_Addi
         * This method is used to save any additional input into the current task object
         * if the task class matches
         *
-        * @param       array                           $submittedData: array containing the data submitted by the user
-        * @param       tx_scheduler_Task       $task: reference to the current task object
-        * @return      void
+        * @param array $submittedData Array containing the data submitted by the user
+        * @param tx_scheduler_Task $task Reference to the current task object
+        * @return void
         */
        public function saveAdditionalFields(array $submittedData, tx_scheduler_Task $task) {
                $task->email = $submittedData['email'];
index d23ae4d..9d69018 100644 (file)
@@ -35,28 +35,28 @@ interface tx_scheduler_AdditionalFieldProvider {
        /**
         * Gets additional fields to render in the form to add/edit a task
         *
-        * @param       array                                   Values of the fields from the add/edit task form
-        * @param       tx_scheduler_Task               The task object being eddited. Null when adding a task!
-        * @param       tx_scheduler_Module             Reference to the scheduler backend module
-        * @return      array                                   A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
+        * @param array $taskInfo Values of the fields from the add/edit task form
+        * @param tx_scheduler_Task $task The task object being eddited. Null when adding a task!
+        * @param tx_scheduler_Module $schedulerModule Reference to the scheduler backend module
+        * @return array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
         */
        public function getAdditionalFields(array &$taskInfo, $task, tx_scheduler_Module $schedulerModule);
 
        /**
         * Validates the additional fields' values
         *
-        * @param       array                                   An array containing the data submitted by the add/edit task form
-        * @param       tx_scheduler_Module             Reference to the scheduler backend module
-        * @return      boolean                                 TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
+        * @param array $submittedData An array containing the data submitted by the add/edit task form
+        * @param tx_scheduler_Module $schedulerModule Reference to the scheduler backend module
+        * @return boolean TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
         */
        public function validateAdditionalFields(array &$submittedData, tx_scheduler_Module $schedulerModule);
 
        /**
         * Takes care of saving the additional fields' values in the task's object
         *
-        * @param       array                                   An array containing the data submitted by the add/edit task form
-        * @param       tx_scheduler_Task               Reference to the scheduler backend module
-        * @return      void
+        * @param array $submittedData An array containing the data submitted by the add/edit task form
+        * @param tx_scheduler_Task $task Reference to the scheduler backend module
+        * @return void
         */
        public function saveAdditionalFields(array $submittedData, tx_scheduler_Task $task);
 }
index 61b0a8f..cc3c781 100755 (executable)
@@ -28,12 +28,12 @@ require_once (t3lib_extMgm::extPath('scheduler') . 'interfaces/interface.tx_sche
 $LANG->includeLLFile('EXT:scheduler/mod1/locallang.xml');
 $BE_USER->modAccess($MCONF, 1); // This checks permissions and exits if the users has no permission for entry.
 
-// Make instance:
+ // Make instance:
 $SOBE = t3lib_div::makeInstance('tx_scheduler_Module');
 $SOBE->init();
 
-// Include files?
-foreach($SOBE->include_once as $INC_FILE) {
+ // Include files?
+foreach ($SOBE->include_once as $INC_FILE) {
        include_once($INC_FILE);
 }
 
index 3ac431e..841b13b 100644 (file)
@@ -45,12 +45,12 @@ class tx_scheduler_CachingFrameworkGarbageCollection extends tx_scheduler_Task {
        /**
         * Execute garbage collection, called by scheduler.
         *
-        * @return void
+        * @return boolean
         */
        public function execute() {
                        // Don't do anything if caching framework is not used at all
                if (t3lib_cache::isCachingFrameworkInitialized()) {
-                               // Global subarray with all configured caches
+                               // Global sub-array with all configured caches
                        $cacheConfigurations = $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations'];
 
                        if (is_array($cacheConfigurations)) {
@@ -67,18 +67,19 @@ class tx_scheduler_CachingFrameworkGarbageCollection extends tx_scheduler_Task {
                        }
                }
 
-               return(TRUE);
+               return TRUE;
        }
 
        /**
         * Get an instance of cache and call garbage collection
         *
-        * @param string Cache name
-        * @param array Cache configuration
+        * @param string $cacheName Cache name
+        * @param array $cacheConfiguration Cache configuration
         */
        protected function callGarbageCollectionOfCache($cacheName, array $cacheConfiguration) {
                        // Get existing cache instance or create a new one
                try {
+                               /** @var $cache t3lib_cache_frontend_Frontend */
                        $cache = $GLOBALS['typo3CacheManager']->getCache($cacheName);
                } catch (t3lib_cache_exception_NoSuchCache $exception) {
                        $GLOBALS['typo3CacheFactory']->create(
index 447836e..4d608a7 100644 (file)
@@ -34,10 +34,10 @@ class tx_scheduler_CachingFrameworkGarbageCollection_AdditionalFieldProvider imp
        /**
         * Add a multi select box with all available cache backends.
         *
-        * @param array Reference to the array containing the info used in the add/edit form
-        * @param object When editing, reference to the current task object. Null when adding.
-        * @param tx_scheduler_Module Reference to the calling object (Scheduler's BE module)
-        * @return array Array containg all the information pertaining to the additional fields
+        * @param array $taskInfo Reference to the array containing the info used in the add/edit form
+        * @param object $task When editing, reference to the current task object. Null when adding.
+        * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)
+        * @return array Array containing all the information pertaining to the additional fields
         */
        public function getAdditionalFields(array &$taskInfo, $task, tx_scheduler_Module $parentObject) {
                        // Initialize selected fields
@@ -62,7 +62,7 @@ class tx_scheduler_CachingFrameworkGarbageCollection_AdditionalFieldProvider imp
                                $fieldOptions .
                        '</select>';
 
-               $additionalFields[$fieldID] = array(
+               $additionalFields[$fieldId] = array(
                        'code' => $fieldHtml,
                        'label' => 'LLL:EXT:scheduler/mod1/locallang.xml:label.cachingFrameworkGarbageCollection.selectBackends',
                        'cshKey' => '_MOD_tools_txschedulerM1',
@@ -75,8 +75,8 @@ class tx_scheduler_CachingFrameworkGarbageCollection_AdditionalFieldProvider imp
        /**
         * Checks that all selected backends exist in available backend list
         *
-        * @param array Reference to the array containing the data submitted by the user
-        * @param tx_scheduler_Module Reference to the calling object (Scheduler's BE module)
+        * @param array $submittedData Reference to the array containing the data submitted by the user
+        * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)
         * @return boolean TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
         */
        public function validateAdditionalFields(array &$submittedData, tx_scheduler_Module $parentObject) {
@@ -94,8 +94,8 @@ class tx_scheduler_CachingFrameworkGarbageCollection_AdditionalFieldProvider imp
        /**
         * Save selected backends in task object
         *
-        * @param array Contains data submitted by the user
-        * @param tx_scheduler_Task Reference to the current task object
+        * @param array $submittedData Contains data submitted by the user
+        * @param tx_scheduler_Task $task Reference to the current task object
         * @return void
         */
        public function saveAdditionalFields(array $submittedData, tx_scheduler_Task $task) {
@@ -105,7 +105,7 @@ class tx_scheduler_CachingFrameworkGarbageCollection_AdditionalFieldProvider imp
        /**
         * Build select options of available backends and set currently selected backends
         *
-        * @param array Selected backends
+        * @param array $selectedBackends Selected backends
         * @return string HTML of selectbox options
         */
        protected function getCacheBackendOptions(array $selectedBackends) {
index b36b66e..e1dcb03 100644 (file)
@@ -46,9 +46,9 @@ class tx_scheduler_RecyclerGarbageCollection_AdditionalFieldProvider implements
         * Add an integer input field for difference between scheduler run time
         * and file modification time in days to select from
         *
-        * @param array Reference to the array containing the info used in the add/edit form
-        * @param object When editing, reference to the current task object. Null when adding.
-        * @param tx_scheduler_Module Reference to the calling object (Scheduler's BE module)
+        * @param array $taskInfo Reference to the array containing the info used in the add/edit form
+        * @param object $task When editing, reference to the current task object. Null when adding.
+        * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)
         * @return array Array containing all the information pertaining to the additional fields
         */
        public function getAdditionalFields(array &$taskInfo, $task, tx_scheduler_Module $parentObject) {
@@ -79,8 +79,8 @@ class tx_scheduler_RecyclerGarbageCollection_AdditionalFieldProvider implements
        /**
         * Checks if the given value is an integer
         *
-        * @param array Reference to the array containing the data submitted by the user
-        * @param tx_scheduler_Module Reference to the calling object (Scheduler's BE module)
+        * @param array $submittedData Reference to the array containing the data submitted by the user
+        * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)
         * @return boolean TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
         */
        public function validateAdditionalFields(array &$submittedData, tx_scheduler_Module $parentObject) {
@@ -99,8 +99,8 @@ class tx_scheduler_RecyclerGarbageCollection_AdditionalFieldProvider implements
        /**
         * Saves given integer value in task object
         *
-        * @param array Contains data submitted by the user
-        * @param tx_scheduler_Task Reference to the current task object
+        * @param array $submittedData Contains data submitted by the user
+        * @param tx_scheduler_Task $task Reference to the current task object
         * @return void
         */
        public function saveAdditionalFields(array $submittedData, tx_scheduler_Task $task) {
index 6ee1065..0bde02d 100644 (file)
@@ -37,7 +37,7 @@ class tx_scheduler_TableGarbageCollection_AdditionalFieldProvider implements tx_
        protected $defaultNumberOfDays = array();
 
        /**
-        * Add addional fields
+        * Add additional fields
         *
         * @param array $taskInfo Reference to the array containing the info used in the add/edit form
         * @param object $task When editing, reference to the current task object. Null when adding.
@@ -55,7 +55,7 @@ class tx_scheduler_TableGarbageCollection_AdditionalFieldProvider implements tx_
 
        /**
         * Initialize the default number of days for all configured tables
-        * 
+        *
         * @return void
         */
        protected function initDefaultNumberOfDays() {
index 99553b9..9bdf47c 100644 (file)
@@ -211,6 +211,9 @@ class tx_scheduler_croncmdTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider expectedTimestampDataProvider
+        * @param string $cronCommand Cron command
+        * @param integer $startTimestamp Timestamp for start of calculation
+        * @param integer $expectedTimestamp Expected result (next time of execution)
         */
        public function calculateNextValueDeterminesCorrectNextTimestamp($cronCommand, $startTimestamp, $expectedTimestamp) {
                $instance = new tx_scheduler_CronCmd($cronCommand, $startTimestamp);
@@ -221,6 +224,10 @@ class tx_scheduler_croncmdTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider expectedTimestampDataProvider
+        * @param string $cronCommand Cron command
+        * @param integer $startTimestamp Timestamp for start of calculation
+        * @param integer $firstTimestamp Timestamp of the next execution
+        * @param integer $secondTimestamp Timestamp of the further execution
         */
        public function calculateNextValueDeterminesCorrectNextTimestampOnConsecutiveCall($cronCommand, $startTimestamp, $firstTimestamp, $secondTimestamp) {
                $instance = new tx_scheduler_CronCmd($cronCommand, $firstTimestamp);
index f22bb54..c6b82c5 100644 (file)
@@ -63,6 +63,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider normalizeValidDataProvider
+        * @param string $expression Cron command to test
+        * @param string $expected Expected result (normalized cron command syntax)
         */
        public function normalizeConvertsCronCommand($expression, $expected) {
                $result = tx_scheduler_CronCmd_Normalize::normalize($expression);
@@ -87,10 +89,12 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider validSpecialKeywordsDataProvider
+        * @param string $keyword Cron command keyword
+        * @param string $expectedCronCommand Expected result (normalized cron command syntax)
         */
-       public function convertKeywordsToCronCommandConvertsValidKeywords($keyword, $exptedCronCommand) {
+       public function convertKeywordsToCronCommandConvertsValidKeywords($keyword, $expectedCronCommand) {
                $result = tx_scheduler_CronCmd_Normalize::convertKeywordsToCronCommand($keyword);
-               $this->assertEquals($exptedCronCommand, $result);
+               $this->assertEquals($expectedCronCommand, $result);
        }
 
        /**
@@ -118,6 +122,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider normalizeFieldsValidDataProvider
+        * @param string $expression Cron command to normalize
+        * @param string $expected Expected result (normalized cron command syntax)
         */
        public function normalizeFieldsConvertsField($expression, $expected) {
                $result = tx_scheduler_CronCmd_Normalize::normalizeFields($expression);
@@ -154,6 +160,9 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider normalizeMonthAndWeekdayFieldValidDataProvider
+        * @param string $expression Cron command partial expression for month and weekday fields
+        * @param boolean $isMonthField Flag to designate month field or not
+        * @param string $expected Expected result (normalized months or weekdays)
         */
        public function normalizeMonthAndWeekdayFieldReturnsNormalizedListForValidExpression($expression, $isMonthField, $expected) {
                $result = tx_scheduler_CronCmd_Normalize::normalizeMonthAndWeekdayField($expression, $isMonthField);
@@ -178,6 +187,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
         * @test
         * @dataProvider normalizeMonthAndWeekdayFieldInvalidDataProvider
         * @expectedException InvalidArgumentException
+        * @param string $expression Cron command partial expression for month and weekday fields (invalid)
+        * @param boolean $isMonthField Flag to designate month field or not
         */
        public function normalizeMonthAndWeekdayFieldThrowsExceptionForInvalidExpression($expression, $isMonthField) {
                $result = tx_scheduler_CronCmd_Normalize::normalizeMonthAndWeekdayField($expression, $isMonthField);
@@ -207,6 +218,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider normalizeIntegerFieldValidDataProvider
+        * @param string $expression Cron command partial integer expression
+        * @param string $expected Expected result (normalized integer or integer list)
         */
        public function normalizeIntegerFieldReturnsNormalizedListForValidExpression($expression, $expected) {
                $result = tx_scheduler_CronCmd_Normalize::normalizeIntegerField($expression);
@@ -236,6 +249,10 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
         * @test
         * @dataProvider normalizeIntegerFieldInvalidDataProvider
         * @expectedException InvalidArgumentException
+        * @param string $expression Cron command partial integer expression (invalid)
+        * @param integer $lowerBound Lower limit
+        * @param integer $upperBound Upper limit
+        *
         */
        public function normalizeIntegerFieldThrowsExceptionForInvalidExpressions($expression, $lowerBound, $upperBound) {
                tx_scheduler_CronCmd_Normalize::normalizeIntegerField($expression, $lowerBound, $upperBound);
@@ -273,6 +290,7 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
         * @test
         * @expectedException InvalidArgumentException
         * @dataProvider invalidCronCommandFieldsDataProvider
+        * @param string $cronCommand Invalid cron command
         */
        public function splitFieldsThrowsExceptionIfCronCommandDoesNotContainFiveFields($cronCommand) {
                tx_scheduler_CronCmd_Normalize::splitFields($cronCommand);
@@ -295,6 +313,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider validRangeDataProvider
+        * @param string $range Cron command range expression
+        * @param string $expected Expected result (normalized range)
         */
        public function convertRangeToListOfValuesReturnsCorrectListForValidRanges($range, $expected) {
                $result = tx_scheduler_CronCmd_Normalize::convertRangeToListOfValues($range);
@@ -323,6 +343,7 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
         * @test
         * @dataProvider invalidRangeDataProvider
         * @expectedException InvalidArgumentException
+        * @param string $range Cron command range expression (invalid)
         */
        public function convertRangeToListOfValuesThrowsExceptionForInvalidRanges($range) {
                tx_scheduler_CronCmd_Normalize::convertRangeToListOfValues($range);
@@ -343,6 +364,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider validStepsDataProvider
+        * @param string $stepExpression Cron command step expression
+        * @param string $expected Expected result (normalized range)
         */
        public function reduceListOfValuesByStepValueReturnsCorrectListOfValues($stepExpression, $expected) {
                $result = tx_scheduler_CronCmd_Normalize::reduceListOfValuesByStepValue($stepExpression);
@@ -370,9 +393,10 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
         * @test
         * @dataProvider invalidStepsDataProvider
         * @expectedException InvalidArgumentException
+        * @param string $stepExpression Cron command step expression (invalid)
         */
        public function reduceListOfValuesByStepValueThrowsExceptionForInvalidStepExpressions($stepExpression) {
-               $result = tx_scheduler_CronCmd_Normalize::reduceListOfValuesByStepValue($stepExpression);
+               tx_scheduler_CronCmd_Normalize::reduceListOfValuesByStepValue($stepExpression);
        }
 
        /**
@@ -427,6 +451,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider validMonthNamesDataProvider
+        * @param string $monthName Month name
+        * @param integer $expectedInteger Number of the month
         */
        public function normalizeMonthConvertsName($monthName, $expectedInteger) {
                $result = tx_scheduler_CronCmd_Normalize::normalizeMonth($monthName);
@@ -436,6 +462,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider validMonthNamesDataProvider
+        * @param string $monthName Month name
+        * @param integer $expectedInteger Number of the month (not used)
         */
        public function normalizeMonthReturnsInteger($monthName, $expectedInteger) {
                $result = tx_scheduler_CronCmd_Normalize::normalizeMonth($monthName);
@@ -473,6 +501,7 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
         * @test
         * @expectedException InvalidArgumentException
         * @dataProvider invalidMonthNamesDataProvider
+        * @param string $invalidMonthName Month name (invalid)
         */
        public function normalizeMonthThrowsExceptionForInvalidMonthRepresentation($invalidMonthName) {
                tx_scheduler_CronCmd_Normalize::normalizeMonth($invalidMonthName);
@@ -515,6 +544,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider validWeekdayDataProvider
+        * @param string $weekday Weekday expression
+        * @param integer $expectedInteger Number of weekday
         */
        public function normalizeWeekdayConvertsName($weekday, $expectedInteger) {
                $result = tx_scheduler_CronCmd_Normalize::normalizeWeekday($weekday);
@@ -524,6 +555,8 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
        /**
         * @test
         * @dataProvider validWeekdayDataProvider
+        * @param string $weekday Weekday expression
+        * @param integer $expectedInteger Number of weekday (not used)
         */
        public function normalizeWeekdayReturnsInteger($weekday, $expectedInteger) {
                $result = tx_scheduler_CronCmd_Normalize::normalizeWeekday($weekday);
@@ -560,6 +593,7 @@ class tx_scheduler_CronCmd_NormalizeTest extends tx_phpunit_testcase {
         * @test
         * @dataProvider invalidWeekdayDataProvider
         * @expectedException InvalidArgumentException
+        * @param string $weekday Weekday expression (invalid)
         */
        public function normalizeWeekdayThrowsExceptionForInvalidWeekdayRepresentation($weekday) {
                tx_scheduler_CronCmd_Normalize::normalizeWeekday($weekday);
index a5a2246..77387d1 100644 (file)
@@ -106,9 +106,8 @@ class tx_scheduler_ModuleTest extends tx_phpunit_testcase {
         * @dataProvider checkDateWithStrtotimeValuesDataProvider
         * @test
         * @see http://de.php.net/manual/de/function.strtotime.php
-        * @param string $strToTimeValue                Testvalue which will be passed to $this->testObject->checkDate
-        * @param integer $expectedTimestamp    Expected value to compare with result from operation
-        * @return      void
+        * @param string $strToTimeValue Test value which will be passed to $this->testObject->checkDate
+        * @param integer $expectedTimestamp Expected value to compare with result from operation
         */
        public function checkDateWithStrtotimeValues($strToTimeValue, $expectedTimestamp) {
                $checkDateResult = $this->testObject->checkDate($strToTimeValue);
@@ -185,9 +184,8 @@ class tx_scheduler_ModuleTest extends tx_phpunit_testcase {
        /**
         * @dataProvider checkDateWithTypo3DateSyntaxDataProvider
         * @test
-        * @param string $typo3DateValue                Testvalue which will be passed to $this->testObject->checkDate
-        * @param integer $expectedTimestamp    Expected value to compare with result from operation
-        * @return      void
+        * @param string $typo3DateValue Test value which will be passed to $this->testObject->checkDate
+        * @param integer $expectedTimestamp Expected value to compare with result from operation
         */
        public function checkDateWithTypo3DateSyntax($typo3DateValue, $expectedTimestamp) {
                $this->assertSame(
@@ -200,7 +198,7 @@ class tx_scheduler_ModuleTest extends tx_phpunit_testcase {
        /**
         * Provides some invalid dates
         * @see checkDateWithInvalidDateValues
-        * @return      array   Testdata for "checkDateWithInvalidDateValues".
+        * @return      array   Test data for "checkDateWithInvalidDateValues".
         *                                      Structure: array(
         *                                              'Value description' => array(
         *                                                      'value to pass to $this->testObject->checkDate'
@@ -224,8 +222,7 @@ class tx_scheduler_ModuleTest extends tx_phpunit_testcase {
         * @dataProvider checkDateWithInvalidDateValuesDataProvider
         * @expectedException InvalidArgumentException
         * @test
-        * @param       $dateValue              Testvalue which will be passed to $this->testObject->checkDate.
-        * @return      void
+        * @param string $dateValue Test value which will be passed to $this->testObject->checkDate.
         */
        public function checkDateWithInvalidDateValues($dateValue) {
                $this->testObject->checkDate($dateValue);