phpmyadmin/libraries/plugins/export/ExportPhparray.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Set of functions used to build dumps of tables as PHP Arrays
   5  *
   6  * @package    PhpMyAdmin-Export
   7  * @subpackage PHP
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /* Get the export interface */
  14 require_once 'libraries/plugins/ExportPlugin.class.php';
  15
  16 /**
  17  * Handles the export for the PHP Array class
  18  *
  19  * @package    PhpMyAdmin-Export
  20  * @subpackage PHP
  21  */
  22 class ExportPhparray extends ExportPlugin
  23 {
  24     /**
  25      * Constructor
  26      */
  27     public function __construct()
  28     {
  29         $this->setProperties();
  30     }
  31
  32     /**
  33      * Sets the export PHP Array properties
  34      *
  35      * @return void
  36      */
  37     protected function setProperties()
  38     {
  39         $props = 'libraries/properties/';
  40         include_once "$props/plugins/ExportPluginProperties.class.php";
  41         include_once "$props/options/groups/OptionsPropertyRootGroup.class.php";
  42         include_once "$props/options/groups/OptionsPropertyMainGroup.class.php";
  43         include_once "$props/options/items/HiddenPropertyItem.class.php";
  44
  45         $exportPluginProperties = new ExportPluginProperties();
  46         $exportPluginProperties->setText('PHP array');
  47         $exportPluginProperties->setExtension('php');
  48         $exportPluginProperties->setMimeType('text/plain');
  49         $exportPluginProperties->setOptionsText(__('Options'));
  50
  51         // create the root group that will be the options field for
  52         // $exportPluginProperties
  53         // this will be shown as "Format specific options"
  54         $exportSpecificOptions = new OptionsPropertyRootGroup();
  55         $exportSpecificOptions->setName("Format Specific Options");
  56
  57         // general options main group
  58         $generalOptions = new OptionsPropertyMainGroup();
  59         $generalOptions->setName("general_opts");
  60         // create primary items and add them to the group
  61         $leaf = new HiddenPropertyItem();
  62         $leaf->setName("structure_or_data");
  63         $generalOptions->addProperty($leaf);
  64         // add the main group to the root group
  65         $exportSpecificOptions->addProperty($generalOptions);
  66
  67         // set the options for the export plugin property item
  68         $exportPluginProperties->setOptions($exportSpecificOptions);
  69         $this->properties = $exportPluginProperties;
  70     }
  71
  72     /**
  73      * This method is called when any PluginManager to which the observer
  74      * is attached calls PluginManager::notify()
  75      *
  76      * @param SplSubject $subject The PluginManager notifying the observer
  77      *                            of an update.
  78      *
  79      * @return void
  80      */
  81     public function update (SplSubject $subject)
  82     {
  83     }
  84
  85     /**
  86      * Outputs export header
  87      *
  88      * @return bool Whether it succeeded
  89      */
  90     public function exportHeader ()
  91     {
  92         PMA_exportOutputHandler(
  93             '<?php' . $GLOBALS['crlf']
  94             . '/**' . $GLOBALS['crlf']
  95             . ' * Export to PHP Array plugin for PHPMyAdmin' . $GLOBALS['crlf']
  96             . ' * @version 0.2b' . $GLOBALS['crlf']
  97             . ' */' . $GLOBALS['crlf'] . $GLOBALS['crlf']
  98         );
  99         return true;
 100     }
 101
 102     /**
 103      * Outputs export footer
 104      *
 105      * @return bool Whether it succeeded
 106      */
 107     public function exportFooter ()
 108     {
 109         return true;
 110     }
 111
 112     /**
 113      * Outputs database header
 114      *
 115      * @param string $db Database name
 116      *
 117      * @return bool Whether it succeeded
 118      */
 119     public function exportDBHeader ($db)
 120     {
 121         PMA_exportOutputHandler(
 122             '//' . $GLOBALS['crlf']
 123             . '// Database ' . PMA_Util::backquote($db)
 124             . $GLOBALS['crlf'] . '//' . $GLOBALS['crlf']
 125         );
 126         return true;
 127     }
 128
 129     /**
 130      * Outputs database footer
 131      *
 132      * @param string $db Database name
 133      *
 134      * @return bool Whether it succeeded
 135      */
 136     public function exportDBFooter ($db)
 137     {
 138         return true;
 139     }
 140
 141     /**
 142      * Outputs CREATE DATABASE statement
 143      *
 144      * @param string $db Database name
 145      *
 146      * @return bool Whether it succeeded
 147      */
 148     public function exportDBCreate($db)
 149     {
 150         return true;
 151     }
 152
 153     /**
 154      * Outputs the content of a table in NHibernate format
 155      *
 156      * @param string $db        database name
 157      * @param string $table     table name
 158      * @param string $crlf      the end of line sequence
 159      * @param string $error_url the url to go back in case of error
 160      * @param string $sql_query SQL query for obtaining data
 161      *
 162      * @return bool Whether it succeeded
 163      */
 164     public function exportData($db, $table, $crlf, $error_url, $sql_query)
 165     {
 166         $result = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
 167
 168         $columns_cnt = PMA_DBI_num_fields($result);
 169         for ($i = 0; $i < $columns_cnt; $i++) {
 170             $columns[$i] = stripslashes(PMA_DBI_field_name($result, $i));
 171         }
 172         unset($i);
 173
 174         // fix variable names (based on
 175         // http://www.php.net/manual/language.variables.basics.php)
 176         if (! preg_match(
 177             '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/',
 178             $table
 179         )) {
 180             // fix invalid characters in variable names by replacing them with
 181             // underscores
 182             $tablefixed = preg_replace('/[^a-zA-Z0-9_\x7f-\xff]/', '_', $table);
 183
 184             // variable name must not start with a number or dash...
 185             if (preg_match('/^[a-zA-Z_\x7f-\xff]/', $tablefixed) == false) {
 186                 $tablefixed = '_' . $tablefixed;
 187             }
 188         } else {
 189             $tablefixed = $table;
 190         }
 191
 192         $buffer = '';
 193         $record_cnt = 0;
 194         // Output table name as comment
 195         $buffer .= $crlf . '// '
 196                     . PMA_Util::backquote($db) . '.'
 197                     . PMA_Util::backquote($table) . $crlf;
 198         $buffer .= '$' . $tablefixed . ' = array(';
 199
 200         while ($record = PMA_DBI_fetch_row($result)) {
 201             $record_cnt++;
 202
 203             if ($record_cnt == 1) {
 204                 $buffer .= $crlf . '  array(';
 205             } else {
 206                 $buffer .= ',' . $crlf . '  array(';
 207             }
 208
 209             for ($i = 0; $i < $columns_cnt; $i++) {
 210                 $buffer .= var_export($columns[$i], true)
 211                     . " => " . var_export($record[$i], true)
 212                     . (($i + 1 >= $columns_cnt) ? '' : ',');
 213             }
 214
 215             $buffer .= ')';
 216         }
 217
 218         $buffer .= $crlf . ');' . $crlf;
 219         if (! PMA_exportOutputHandler($buffer)) {
 220             return false;
 221         }
 222
 223         PMA_DBI_free_result($result);
 224         return true;
 225     }
 226 }
 227 ?>