libraries/export/php_array.php

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