libraries/db_designer.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Set of functions related to designer
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 require_once 'libraries/relation.lib.php';
  13 require_once 'libraries/Template.class.php';
  14
  15 /**
  16  * Function to get html to display a page selector
  17  *
  18  * @param array  $cfgRelation information about the configuration storage
  19  * @param string $db          database name
  20  *
  21  * @return string html content
  22  */
  23 function PMA_getHtmlForPageSelector($cfgRelation, $db)
  24 {
  25     return PMA\Template::get('designer/page_selector')
  26         ->render(
  27             array(
  28                 'db' => $db,
  29                 'cfgRelation' => $cfgRelation
  30             )
  31         );
  32 }
  33
  34 /**
  35  * Function to get html for displaying the page edit/delete form
  36  *
  37  * @param string $db        database name
  38  * @param string $operation 'edit' or 'delete' depending on the operation
  39  *
  40  * @return string html content
  41  */
  42 function PMA_getHtmlForEditOrDeletePages($db, $operation)
  43 {
  44     return PMA\Template::get('designer/edit_delete_pages')
  45         ->render(
  46             array(
  47                 'db' => $db,
  48                 'operation' => $operation
  49             )
  50         );
  51 }
  52
  53 /**
  54  * Function to get html for displaying the page save as form
  55  *
  56  * @param string $db database name
  57  *
  58  * @return string html content
  59  */
  60 function PMA_getHtmlForPageSaveAs($db)
  61 {
  62     return PMA\Template::get('designer/page_save_as')
  63         ->render(
  64             array(
  65                 'db' => $db
  66             )
  67         );
  68 }
  69
  70 /**
  71  * Retrieve IDs and names of schema pages
  72  *
  73  * @param string $db database name
  74  *
  75  * @return array array of schema page id and names
  76  */
  77 function PMA_getPageIdsAndNames($db)
  78 {
  79     $cfgRelation = PMA_getRelationsParam();
  80     $page_query = "SELECT `page_nr`, `page_descr` FROM "
  81         . PMA_Util::backquote($cfgRelation['db']) . "."
  82         . PMA_Util::backquote($cfgRelation['pdf_pages'])
  83         . " WHERE db_name = '" . PMA_Util::sqlAddSlashes($db) . "'"
  84         . " ORDER BY `page_descr`";
  85     $page_rs = PMA_queryAsControlUser(
  86         $page_query, false, PMA_DatabaseInterface::QUERY_STORE
  87     );
  88
  89     $result = array();
  90     while ($curr_page = $GLOBALS['dbi']->fetchAssoc($page_rs)) {
  91         $result[$curr_page['page_nr']] = $curr_page['page_descr'];
  92     }
  93     return $result;
  94 }
  95
  96 /**
  97  * Function to get html for displaying the schema export
  98  *
  99  * @param string $db   database name
 100  * @param int    $page the page to be exported
 101  *
 102  * @return string
 103  */
 104 function PMA_getHtmlForSchemaExport($db, $page)
 105 {
 106     /* Scan for schema plugins */
 107     $export_list = PMA_getPlugins(
 108         "schema",
 109         'libraries/plugins/schema/',
 110         null
 111     );
 112
 113     /* Fail if we didn't find any schema plugin */
 114     if (empty($export_list)) {
 115         return PMA_Message::error(
 116             __('Could not load schema plugins, please check your installation!')
 117         )->getDisplay();
 118     }
 119
 120     return PMA\Template::get('designer/schema_export')
 121         ->render(
 122             array(
 123                 'db' => $db,
 124                 'page' => $page,
 125                 'export_list' => $export_list
 126             )
 127         );
 128 }
 129
 130 /**
 131  * Returns HTML for including some variable to be accessed by JavaScript
 132  *
 133  * @param array $script_tables        array on foreign key support for each table
 134  * @param array $script_contr         initialization data array
 135  * @param array $script_display_field display fields of each table
 136  * @param int   $display_page         page number of the selected page
 137  *
 138  * @return string html
 139  */
 140 function PMA_getHtmlForJSFields(
 141     $script_tables, $script_contr, $script_display_field, $display_page
 142 ) {
 143     return PMA\Template::get('designer/js_fields')
 144         ->render(
 145             array(
 146                 'script_tables' => $script_tables,
 147                 'script_contr' => $script_contr,
 148                 'script_display_field' => $script_display_field,
 149                 'display_page' => $display_page
 150             )
 151         );
 152 }
 153
 154 /**
 155  * Returns HTML for the menu bar of the designer page
 156  *
 157  * @param boolean $visualBuilder whether this is visual query builder
 158  * @param string  $selected_page name of the selected page
 159  *
 160  * @return string html
 161  */
 162 function PMA_getDesignerPageMenu($visualBuilder, $selected_page)
 163 {
 164     return PMA\Template::get('designer/side_menu')
 165         ->render(
 166             array(
 167                 'visualBuilder' => $visualBuilder,
 168                 'selected_page' => $selected_page
 169             )
 170         );
 171 }
 172
 173 /**
 174  * Returns HTML for the canvas element
 175  *
 176  * @return string html
 177  */
 178 function PMA_getHTMLCanvas()
 179 {
 180     return PMA\Template::get('designer/canvas')->render();
 181 }
 182
 183 /**
 184  * Return HTML for the table list
 185  *
 186  * @param array $tab_pos      table positions
 187  * @param int   $display_page page number of the selected page
 188  *
 189  * @return string html
 190  */
 191 function PMA_getHTMLTableList($tab_pos, $display_page)
 192 {
 193     return PMA\Template::get('designer/table_list')
 194         ->render(
 195             array(
 196                 'tab_pos' => $tab_pos,
 197                 'display_page' => $display_page
 198             )
 199         );
 200 }
 201
 202 /**
 203  * Get HTML to display tables on designer page
 204  *
 205  * @param array $tab_pos                  tables positions
 206  * @param int   $display_page             page number of the selected page
 207  * @param array $tab_column               table column info
 208  * @param array $tables_all_keys          all indices
 209  * @param array $tables_pk_or_unique_keys unique or primary indices
 210  *
 211  * @return string html
 212  */
 213 function PMA_getDatabaseTables(
 214     $tab_pos, $display_page, $tab_column, $tables_all_keys, $tables_pk_or_unique_keys
 215 ) {
 216     return PMA\Template::get('designer/database_tables')
 217         ->render(
 218             array(
 219                 'tab_pos' => $tab_pos,
 220                 'display_page' => $display_page,
 221                 'tab_column' => $tab_column,
 222                 'tables_all_keys' => $tables_all_keys,
 223                 'tables_pk_or_unique_keys' => $tables_pk_or_unique_keys
 224             )
 225         );
 226 }
 227
 228 /**
 229  * Returns HTML for the new relations panel.
 230  *
 231  * @return string html
 232  */
 233 function PMA_getNewRelationPanel()
 234 {
 235     return PMA\Template::get('designer/new_relation_panel')->render();
 236 }
 237
 238 /**
 239  * Returns HTML for the relations delete panel
 240  *
 241  * @return string html
 242  */
 243 function PMA_getDeleteRelationPanel()
 244 {
 245     return PMA\Template::get('designer/delete_relation_panel')->render();
 246 }
 247
 248 /**
 249  * Returns HTML for the options panel
 250  *
 251  * @return string html
 252  */
 253 function PMA_getOptionsPanel()
 254 {
 255     return PMA\Template::get('designer/options_panel')->render();
 256 }
 257
 258 /**
 259  * Get HTML for the 'rename to' panel
 260  *
 261  * @return string html
 262  */
 263 function PMA_getRenameToPanel()
 264 {
 265     return PMA\Template::get('designer/rename_to_panel')->render();
 266 }
 267
 268 /**
 269  * Returns HTML for the 'having' panel
 270  *
 271  * @return string html
 272  */
 273 function PMA_getHavingQueryPanel()
 274 {
 275     return PMA\Template::get('designer/having_query_panel')->render();
 276 }
 277
 278 /**
 279  * Returns HTML for the 'aggregate' panel
 280  *
 281  * @return string html
 282  */
 283 function PMA_getAggregateQueryPanel()
 284 {
 285     return PMA\Template::get('designer/aggregate_query_panel')->render();
 286 }
 287
 288 /**
 289  * Returns HTML for the 'where' panel
 290  *
 291  * @return string html
 292  */
 293 function PMA_getWhereQueryPanel()
 294 {
 295     return PMA\Template::get('designer/where_query_panel')->render();
 296 }
 297
 298 /**
 299  * Returns HTML for the query details panel
 300  *
 301  * @return string html
 302  */
 303 function PMA_getQueryDetails()
 304 {
 305     return PMA\Template::get('designer/query_details')->render();
 306 }
 307 ?>