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  * @version $Id$
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  *
  14  */
  15 if (isset($plugin_list)) {
  16     $plugin_list['yaml'] = array(
  17         'text'          => 'YAML',
  18         'extension'     => 'yml',
  19         'mime_type'     => 'text/yaml',
  20         'force_file'    => true,
  21         'options'       => array(
  22             array(
  23                 'type' => 'hidden',
  24                 'name' => 'data',
  25             ),
  26         ),
  27         'options_text'  => 'strOptions',
  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     PMA_exportOutputHandler('...' . $GLOBALS['crlf']);
  58     return true;
  59 }
  60
  61 /**
  62  * Outputs export header
  63  *
  64  * @return  bool        Whether it suceeded
  65  *
  66  * @access  public
  67  */
  68 function PMA_exportHeader()
  69 {
  70     PMA_exportOutputHandler('%YAML 1.1' . $GLOBALS['crlf'] . '---' . $GLOBALS['crlf']);
  71     return true;
  72 }
  73
  74 /**
  75  * Outputs database header
  76  *
  77  * @param   string      Database name
  78  *
  79  * @return  bool        Whether it suceeded
  80  *
  81  * @access  public
  82  */
  83 function PMA_exportDBHeader($db)
  84 {
  85     return true;
  86 }
  87
  88 /**
  89  * Outputs database footer
  90  *
  91  * @param   string      Database name
  92  *
  93  * @return  bool        Whether it suceeded
  94  *
  95  * @access  public
  96  */
  97 function PMA_exportDBFooter($db)
  98 {
  99     return true;
 100 }
 101
 102 /**
 103  * Outputs create database database
 104  *
 105  * @param   string      Database name
 106  *
 107  * @return  bool        Whether it suceeded
 108  *
 109  * @access  public
 110  */
 111 function PMA_exportDBCreate($db)
 112 {
 113     return true;
 114 }
 115
 116 /**
 117  * Outputs the content of a table in YAML format
 118  *
 119  * @param   string      the database name
 120  * @param   string      the table name
 121  * @param   string      the end of line sequence
 122  * @param   string      the url to go back in case of error
 123  * @param   string      SQL query for obtaining data
 124  *
 125  * @return  bool        Whether it suceeded
 126  *
 127  * @access  public
 128  */
 129 function PMA_exportData($db, $table, $crlf, $error_url, $sql_query)
 130 {
 131     $result      = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
 132
 133     $columns_cnt = PMA_DBI_num_fields($result);
 134     for ($i = 0; $i < $columns_cnt; $i++) {
 135         $columns[$i] = stripslashes(PMA_DBI_field_name($result, $i));
 136     }
 137     unset($i);
 138
 139     $buffer = '';
 140     while ($record = PMA_DBI_fetch_row($result)) {
 141         $buffer = '-' . $crlf;
 142         for ($i = 0; $i < $columns_cnt; $i++) {
 143             if (! isset($record[$i])) {
 144                 continue;
 145             }
 146
 147             $column = $columns[$i];
 148
 149             if (is_null($record[$i])) {
 150                 $buffer .= '  ' . $column . ': null' . $crlf;
 151                 continue;
 152             }
 153
 154             if (is_numeric($record[$i])) {
 155                 $buffer .= '  ' . $column . ': '  . $record[$i] . $crlf;
 156                 continue;
 157             }
 158
 159             $record[$i] = preg_replace('/\r\n|\r|\n/', $crlf.'    ', $record[$i]);
 160             if (strstr($record[$i], $crlf))
 161               $record[$i] = '|-' . $crlf . '    '.$record[$i];
 162
 163             $buffer .= '  ' . $column . ': ' . $record[$i] . $crlf;
 164         }
 165
 166         if (!PMA_exportOutputHandler($buffer)) {
 167             return FALSE;
 168         }
 169     }
 170     PMA_DBI_free_result($result);
 171
 172     return true;
 173 }
 174
 175 }
 176 ?>