libraries/export/yaml.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Set of functions used to build YAML dumps of tables
   5  *
   6  * @package phpMyAdmin-Export
   7  * @subpackage YAML
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /**
  14  *
  15  */
  16 if (isset($plugin_list)) {
  17     $plugin_list['yaml'] = array(
  18         'text'          => 'YAML',
  19         'extension'     => 'yml',
  20         'mime_type'     => 'text/yaml',
  21         'force_file'    => true,
  22         'options'       => array(
  23             array('type' => 'begin_group', 'name' => 'general_opts'),
  24             array(
  25                 'type' => 'hidden',
  26                 'name' => 'structure_or_data',
  27             ),
  28             array('type' => 'end_group')
  29         ),
  30         'options_text'  => __('Options'),
  31     );
  32 } else {
  33
  34     /**
  35      * Set of functions used to build exports of tables
  36      */
  37
  38     /**
  39      * Outputs export footer
  40      *
  41      * @return  bool        Whether it suceeded
  42      *
  43      * @access  public
  44      */
  45     function PMA_exportFooter()
  46     {
  47         PMA_exportOutputHandler('...' . $GLOBALS['crlf']);
  48         return true;
  49     }
  50
  51     /**
  52      * Outputs export header
  53      *
  54      * @return  bool        Whether it suceeded
  55      *
  56      * @access  public
  57      */
  58     function PMA_exportHeader()
  59     {
  60         PMA_exportOutputHandler('%YAML 1.1' . $GLOBALS['crlf'] . '---' . $GLOBALS['crlf']);
  61         return true;
  62     }
  63
  64     /**
  65      * Outputs database header
  66      *
  67      * @param string  $db Database name
  68      * @return  bool        Whether it suceeded
  69      *
  70      * @access  public
  71      */
  72     function PMA_exportDBHeader($db)
  73     {
  74         return true;
  75     }
  76
  77     /**
  78      * Outputs database footer
  79      *
  80      * @param string  $db Database name
  81      * @return  bool        Whether it suceeded
  82      *
  83      * @access  public
  84      */
  85     function PMA_exportDBFooter($db)
  86     {
  87         return true;
  88     }
  89
  90     /**
  91      * Outputs CREATE DATABASE statement
  92      *
  93      * @param string  $db Database name
  94      * @return  bool        Whether it suceeded
  95      *
  96      * @access  public
  97      */
  98     function PMA_exportDBCreate($db)
  99     {
 100         return true;
 101     }
 102
 103     /**
 104      * Outputs the content of a table in YAML format
 105      *
 106      * @param string  $db         database name
 107      * @param string  $table      table name
 108      * @param string  $crlf       the end of line sequence
 109      * @param string  $error_url  the url to go back in case of error
 110      * @param string  $sql_query  SQL query for obtaining data
 111      * @return  bool        Whether it suceeded
 112      *
 113      * @access  public
 114      */
 115     function PMA_exportData($db, $table, $crlf, $error_url, $sql_query)
 116     {
 117         $result      = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
 118
 119         $columns_cnt = PMA_DBI_num_fields($result);
 120         for ($i = 0; $i < $columns_cnt; $i++) {
 121             $columns[$i] = stripslashes(PMA_DBI_field_name($result, $i));
 122         }
 123         unset($i);
 124
 125         $buffer = '';
 126         $record_cnt = 0;
 127         while ($record = PMA_DBI_fetch_row($result)) {
 128             $record_cnt++;
 129
 130             // Output table name as comment if this is the first record of the table
 131             if ($record_cnt == 1) {
 132                 $buffer = '# ' . $db . '.' . $table . $crlf;
 133                 $buffer .= '-' . $crlf;
 134             } else {
 135                 $buffer = '-' . $crlf;
 136             }
 137
 138             for ($i = 0; $i < $columns_cnt; $i++) {
 139                 if (! isset($record[$i])) {
 140                     continue;
 141                 }
 142
 143                 $column = $columns[$i];
 144
 145                 if (is_null($record[$i])) {
 146                     $buffer .= '  ' . $column . ': null' . $crlf;
 147                     continue;
 148                 }
 149
 150                 if (is_numeric($record[$i])) {
 151                     $buffer .= '  ' . $column . ': '  . $record[$i] . $crlf;
 152                     continue;
 153                 }
 154
 155                 $record[$i] = str_replace(array('\\', '"', "\n", "\r"), array('\\\\', '\"', '\n', '\r'), $record[$i]);
 156                 $buffer .= '  ' . $column . ': "' . $record[$i] . '"' . $crlf;
 157             }
 158
 159             if (! PMA_exportOutputHandler($buffer)) {
 160                 return false;
 161             }
 162         }
 163         PMA_DBI_free_result($result);
 164
 165         return true;
 166     }
 167
 168 }
 169 ?>