tests/PHPUnit/Extensions/Database/DataSet/Persistors/FlatXml.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/DataSet/Persistors/Abstract.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * A Flat XML dataset persistor.
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  59  * @author     Mike Lively <m@digitalsandwich.com>
  60  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.3.17
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 3.2.0
  65  */
  66 class PHPUnit_Extensions_Database_DataSet_Persistors_FlatXml extends PHPUnit_Extensions_Database_DataSet_Persistors_Abstract
  67 {
  68     /**
  69      * @var string
  70      */
  71     protected $filename;
  72
  73     /**
  74      * @var resource
  75      */
  76     protected $fh;
  77
  78     /**
  79      * Sets the filename that this persistor will save to.
  80      *
  81      * @param string $filename
  82      */
  83     public function setFileName($filename)
  84     {
  85         $this->filename = $filename;
  86     }
  87
  88     /**
  89      * Override to save the start of a dataset.
  90      *
  91      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $dataset
  92      */
  93     protected function startDataSet(PHPUnit_Extensions_Database_DataSet_IDataSet $dataset)
  94     {
  95         $this->fh = fopen($this->filename, 'w');
  96
  97         if ($this->fh === FALSE) {
  98            throw new RuntimeException("Could not open {$this->filename} for writing see " . __CLASS__ . "::setFileName()");
  99         }
 100
 101         fwrite($this->fh, "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n");
 102         fwrite($this->fh, "<dataset>\n");
 103     }
 104
 105     /**
 106      * Override to save the end of a dataset.
 107      *
 108      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $dataset
 109      */
 110     protected function endDataSet(PHPUnit_Extensions_Database_DataSet_IDataSet $dataset)
 111     {
 112         fwrite($this->fh, "</dataset>\n");
 113     }
 114
 115     /**
 116      * Override to save the start of a table.
 117      *
 118      * @param PHPUnit_Extensions_Database_DataSet_ITable $table
 119      */
 120     protected function startTable(PHPUnit_Extensions_Database_DataSet_ITable $table)
 121     {
 122         if ($table->getRowCount() == 0) {
 123             fwrite($this->fh, "\t<{$table->getTableMetaData()->getTableName()} />\n");
 124         }
 125     }
 126
 127     /**
 128      * Override to save the end of a table.
 129      *
 130      * @param PHPUnit_Extensions_Database_DataSet_ITable $table
 131      */
 132     protected function endTable(PHPUnit_Extensions_Database_DataSet_ITable $table)
 133     {
 134         //do nothing
 135     }
 136
 137     /**
 138      * Override to save a table row.
 139      *
 140      * @param array $row
 141      * @param PHPUnit_Extensions_Database_DataSet_ITable $table
 142      */
 143     protected function row(Array $row, PHPUnit_Extensions_Database_DataSet_ITable $table)
 144     {
 145         fwrite($this->fh, "\t<{$table->getTableMetaData()->getTableName()}\n");
 146
 147         foreach ($table->getTableMetaData()->getColumns() as $columnName) {
 148             if (isset($row[$columnName])) {
 149                 fwrite($this->fh, "\t\t{$columnName}=\"". htmlspecialchars($row[$columnName]) . "\"\n");
 150             }
 151         }
 152
 153         fwrite($this->fh, "\t/>\n");
 154     }
 155 }
 156
 157 ?>