tests/PHPUnit/Extensions/Database/Operation/Factory.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Mike Lively <m@digitalsandwich.com>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.2.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49
  50 require_once 'PHPUnit/Extensions/Database/Operation/IDatabaseOperation.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 require_once 'PHPUnit/Extensions/Database/Operation/Composite.php';
  55 require_once 'PHPUnit/Extensions/Database/Operation/DeleteAll.php';
  56 require_once 'PHPUnit/Extensions/Database/Operation/Delete.php';
  57 require_once 'PHPUnit/Extensions/Database/Operation/Insert.php';
  58 require_once 'PHPUnit/Extensions/Database/Operation/Null.php';
  59 require_once 'PHPUnit/Extensions/Database/Operation/Update.php';
  60 require_once 'PHPUnit/Extensions/Database/Operation/Truncate.php';
  61
  62 /**
  63  * A class factory to easily return database operations.
  64  *
  65  * @category   Testing
  66  * @package    PHPUnit
  67  * @author     Mike Lively <m@digitalsandwich.com>
  68  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  69  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  70  * @version    Release: 3.3.17
  71  * @link       http://www.phpunit.de/
  72  * @since      Class available since Release 3.2.0
  73  */
  74 class PHPUnit_Extensions_Database_Operation_Factory
  75 {
  76
  77     /**
  78      * Returns a null database operation
  79      *
  80      * @return PHPUnit_Extensions_Database_Operation_IDatabaseOperation
  81      */
  82     public static function NONE()
  83     {
  84         return new PHPUnit_Extensions_Database_Operation_Null();
  85     }
  86
  87     /**
  88      * Returns a clean insert database operation. It will remove all contents
  89      * from the table prior to re-inserting rows.
  90      *
  91      * @param bool $cascadeTruncates Set to true to force truncates to cascade on databases that support this.
  92      * @return PHPUnit_Extensions_Database_Operation_IDatabaseOperation
  93      */
  94     public static function CLEAN_INSERT($cascadeTruncates = FALSE)
  95     {
  96         return new PHPUnit_Extensions_Database_Operation_Composite(array(
  97             self::TRUNCATE($cascadeTruncates),
  98             self::INSERT()
  99         ));
 100     }
 101
 102     /**
 103      * Returns an insert database operation.
 104      *
 105      * @return PHPUnit_Extensions_Database_Operation_IDatabaseOperation
 106      */
 107     public static function INSERT()
 108     {
 109         return new PHPUnit_Extensions_Database_Operation_Insert();
 110     }
 111
 112     /**
 113      * Returns a truncate database operation.
 114      *
 115      * @param bool $cascadeTruncates Set to true to force truncates to cascade on databases that support this.
 116      * @return PHPUnit_Extensions_Database_Operation_IDatabaseOperation
 117      */
 118     public static function TRUNCATE($cascadeTruncates = FALSE)
 119     {
 120         $truncate = new PHPUnit_Extensions_Database_Operation_Truncate();
 121         $truncate->setCascade($cascadeTruncates);
 122
 123         return $truncate;
 124     }
 125
 126     /**
 127      * Returns a delete database operation.
 128      *
 129      * @return PHPUnit_Extensions_Database_Operation_IDatabaseOperation
 130      */
 131     public static function DELETE()
 132     {
 133         return new PHPUnit_Extensions_Database_Operation_Delete();
 134     }
 135
 136     /**
 137      * Returns a delete_all database operation.
 138      *
 139      * @return PHPUnit_Extensions_Database_Operation_IDatabaseOperation
 140      */
 141     public static function DELETE_ALL()
 142     {
 143         return new PHPUnit_Extensions_Database_Operation_DeleteAll();
 144     }
 145
 146     /**
 147      * Returns an update database operation.
 148      *
 149      * @return PHPUnit_Extensions_Database_Operation_IDatabaseOperation
 150      */
 151     public static function UPDATE()
 152     {
 153         return new PHPUnit_Extensions_Database_Operation_Update();
 154     }
 155
 156 }
 157 ?>