     1: <?php
     2:
     3: /**
     4:  * The interface for all cron tasks placed in [webapp]/tasks
     5:  *
     6:  * @package alpha::util
     7:  * @since 1.0
     8:  * @author John Collins <dev@alphaframework.org>
     9:  * @version $Id: AlphaTaskInterface.inc 1496 2012-02-12 20:32:21Z alphadev $
    10:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
    11:  * @copyright Copyright (c) 2012, John Collins (founder of Alpha Framework).
    12:  * All rights reserved.
    13:  *
    14:  * <pre>
    15:  * Redistribution and use in source and binary forms, with or
    16:  * without modification, are permitted provided that the
    17:  * following conditions are met:
    18:  *
    19:  * * Redistributions of source code must retain the above
    20:  *   copyright notice, this list of conditions and the
    21:  *   following disclaimer.
    22:  * * Redistributions in binary form must reproduce the above
    23:  *   copyright notice, this list of conditions and the
    24:  *   following disclaimer in the documentation and/or other
    25:  *   materials provided with the distribution.
    26:  * * Neither the name of the Alpha Framework nor the names
    27:  *   of its contributors may be used to endorse or promote
    28:  *   products derived from this software without specific
    29:  *   prior written permission.
    30:  *
    31:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
    32:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
    33:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    34:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    35:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
    36:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    37:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    38:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    39:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    40:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    41:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
    42:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    43:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    44:  * </pre>
    45:  *
    46:  */
    47: interface AlphaTaskInterface {
    48:     /**
    49:      * Runs the functional code that makes up the task
    50:      *
    51:      * @since 1.0
    52:      */
    53:     public function doTask();
    54:
    55:     /**
    56:      * Gets the maximum allowed runtime for this cron (in seconds)
    57:      *
    58:      * @return integer
    59:      * @since 1.0
    60:      */
    61:     public function getMaxRunTime();
    62: }
    63:
    64: ?>