libraries/export/php_array.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 /**
  14  *
  15  */
  16 if (isset($plugin_list)) {
  17     $plugin_list['php_array'] = array(
  18         'text'          => __('PHP array'),
  19         'extension'     => 'php',
  20         'mime_type'     => 'text/plain',
  21         'options'       => array(
  22         array('type' => 'begin_group', 'name' => 'general_opts'),
  23             array(
  24                 'type' => 'hidden',
  25                 'name' => 'structure_or_data',
  26             ),
  27         array('type' => 'end_group')
  28         ),
  29         'options_text'  => __('Options'),
  30     );
  31 } else {
  32
  33     /**
  34      * Set of functions used to build exports of tables
  35      */
  36
  37     /**
  38      * Outputs export footer
  39      *
  40      * @return  bool        Whether it succeeded
  41      *
  42      * @access  public
  43      */
  44     function PMA_exportFooter()
  45     {
  46         return true;
  47     }
  48
  49     /**
  50      * Outputs export header
  51      *
  52      * @return  bool        Whether it succeeded
  53      *
  54      * @access  public
  55      */
  56     function PMA_exportHeader()
  57     {
  58         PMA_exportOutputHandler(
  59               '<?php' . $GLOBALS['crlf']
  60             . '/**' . $GLOBALS['crlf']
  61             . ' * Export to PHP Array plugin for PHPMyAdmin' . $GLOBALS['crlf']
  62             . ' * @version 0.2b' . $GLOBALS['crlf']
  63             . ' */' . $GLOBALS['crlf'] . $GLOBALS['crlf']
  64         );
  65         return true;
  66     }
  67
  68     /**
  69      * Outputs database header
  70      *
  71      * @param string  $db Database name
  72      * @return  bool        Whether it succeeded
  73      *
  74      * @access  public
  75      */
  76     function PMA_exportDBHeader($db)
  77     {
  78         PMA_exportOutputHandler('//' . $GLOBALS['crlf'] . '// Database ' . PMA_backquote($db) . $GLOBALS['crlf'] . '//' . $GLOBALS['crlf']);
  79         return true;
  80     }
  81
  82     /**
  83      * Outputs database footer
  84      *
  85      * @param string  $db Database name
  86      * @return  bool        Whether it succeeded
  87      *
  88      * @access  public
  89      */
  90     function PMA_exportDBFooter($db)
  91     {
  92         return true;
  93     }
  94
  95     /**
  96      * Outputs CREATE DATABASE statement
  97      *
  98      * @param string  $db Database name
  99      * @return  bool        Whether it succeeded
 100      *
 101      * @access  public
 102      */
 103     function PMA_exportDBCreate($db)
 104     {
 105         return true;
 106     }
 107
 108     /**
 109      * Outputs the content of a table as a fragment of PHP code
 110      *
 111      * @param string  $db         database name
 112      * @param string  $table      table name
 113      * @param string  $crlf       the end of line sequence
 114      * @param string  $error_url  the url to go back in case of error
 115      * @param string  $sql_query  SQL query for obtaining data
 116      * @return  bool        Whether it succeeded
 117      *
 118      * @access  public
 119      */
 120     function PMA_exportData($db, $table, $crlf, $error_url, $sql_query)
 121     {
 122         $result      = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
 123
 124         $columns_cnt = PMA_DBI_num_fields($result);
 125         for ($i = 0; $i < $columns_cnt; $i++) {
 126             $columns[$i] = stripslashes(PMA_DBI_field_name($result, $i));
 127         }
 128         unset($i);
 129
 130         // fix variable names (based on http://www.php.net/manual/language.variables.basics.php)
 131         if (preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $table) == false) {
 132             // fix invalid chars in variable names by replacing them with underscores
 133             $tablefixed = preg_replace('/[^a-zA-Z0-9_\x7f-\xff]/', '_', $table);
 134
 135             // variable name must not start with a number or dash...
 136             if (preg_match('/^[a-zA-Z_\x7f-\xff]/', $tablefixed) == false) {
 137                 $tablefixed = '_' . $tablefixed;
 138             }
 139         } else {
 140             $tablefixed = $table;
 141         }
 142
 143         $buffer = '';
 144         $record_cnt = 0;
 145         while ($record = PMA_DBI_fetch_row($result)) {
 146
 147             $record_cnt++;
 148
 149             // Output table name as comment if this is the first record of the table
 150             if ($record_cnt == 1) {
 151                 $buffer .= $crlf . '// ' . PMA_backquote($db) . '.' . PMA_backquote($table) . $crlf;
 152                 $buffer .= '$' . $tablefixed . ' = array(' . $crlf;
 153                 $buffer .= '  array(';
 154             } else {
 155                 $buffer .= ',' . $crlf . '  array(';
 156             }
 157
 158             for ($i = 0; $i < $columns_cnt; $i++) {
 159                 $buffer .= var_export($columns[$i], true) . " => " . var_export($record[$i], true) . (($i + 1 >= $columns_cnt) ? '' : ',');
 160             }
 161
 162             $buffer .= ')';
 163         }
 164
 165         $buffer .= $crlf . ');' . $crlf;
 166         if (! PMA_exportOutputHandler($buffer)) {
 167             return false;
 168         }
 169
 170         PMA_DBI_free_result($result);
 171
 172         return true;
 173     }
 174
 175 }