class.tx_scheduler_testtask.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2008 Markus Friedrich (markus.friedrich@dkd.de)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

/**
 * Class "tx_scheduler_TestTask" provides testing procedures
 *
 * @author      Markus Friedrich <markus.friedrich@dkd.de>
 * @package     TYPO3
 * @subpackage  tx_scheduler
 *
 * $Id: class.tx_scheduler_testtask.php 10130 2011-01-18 22:45:15Z lolli $
 */
class tx_scheduler_TestTask extends tx_scheduler_Task {

    /**
     * An email address to be used during the process
     *
     * @var string      $email
     */
     var $email;

    /**
     * Function executed from the Scheduler.
     * Sends an email
     *
     * @return  void
     */
    public function execute() {
        $success = false;

        if (!empty($this->email)) {
                // If an email address is defined, send a message to it

                // NOTE: the TYPO3_DLOG constant is not used in this case, as this is a test task
                // and debugging is its main purpose anyway
            t3lib_div::devLog('[tx_scheduler_TestTask]: Test email sent to "' . $this->email . '"', 'scheduler', 0);

                // Get execution information
            $exec = $this->getExecution();

                // Get call method
            if (basename(PATH_thisScript) == 'cli_dispatch.phpsh') {
                $calledBy = 'CLI module dispatcher';
                $site = '-';
            } else {
                $calledBy = 'TYPO3 backend';
                $site = t3lib_div::getIndpEnv('TYPO3_SITE_URL');
            }

            $start = $exec->getStart();
            $end = $exec->getEnd();
            $interval = $exec->getInterval();
            $multiple = $exec->getMultiple();
            $cronCmd = $exec->getCronCmd();
            $mailBody =
                'SCHEDULER TEST-TASK' . LF
                . '- - - - - - - - - - - - - - - -' . LF
                . 'UID: ' . $this->taskUid . LF
                . 'Sitename: ' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] . LF
                . 'Site: ' . $site . LF
                . 'Called by: ' . $calledBy . LF
                . 'tstamp: ' . date('Y-m-d H:i:s') . ' [' . time() . ']' . LF
                . 'maxLifetime: ' . $this->scheduler->extConf['maxLifetime'] . LF
                . 'start: ' . date('Y-m-d H:i:s', $start) . ' [' . $start . ']' . LF
                . 'end: ' . ((empty($end)) ? '-' : (date('Y-m-d H:i:s', $end) . ' [' . $end . ']')) . LF
                . 'interval: ' . $interval . LF
                . 'multiple: ' . ($multiple ? 'yes' : 'no') . LF
                . 'cronCmd: ' . ($cronCmd ? $cronCmd : 'not used');

                // Prepare mailer and send the mail
            try {
                /** @var $mailer t3lib_mail_message */
                $mailer = t3lib_div::makeInstance('t3lib_mail_message');
                $mailer->setFrom(array($this->email => 'SCHEDULER TEST-TASK'));
                $mailer->setReplyTo(array($this->email => 'SCHEDULER TEST-TASK'));
                $mailer->setSubject('SCHEDULER TEST-TASK');
                $mailer->setBody($mailBody);
                $mailer->setTo($this->email);
                $mailsSend = $mailer->send();
                $success = ($mailsSend>0);
            } catch (Exception $e) {
                throw new t3lib_exception($e->getMessage());
            }
        } else {
                // No email defined, just log the task
            t3lib_div::devLog('[tx_scheduler_TestTask]: No email address given', 'scheduler', 2);
        }

        return $success;
    }

    /**
     * This method returns the destination mail address as additional information
     *
     * @return  string  Information to display
     */
    public function getAdditionalInformation() {
        return $GLOBALS['LANG']->sL('LLL:EXT:scheduler/mod1/locallang.xml:label.email') . ': ' . $this->email;
    }
}

if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/scheduler/examples/class.tx_scheduler_testtask.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/scheduler/examples/class.tx_scheduler_testtask.php']);
}

?>