libraries/Console.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Used to render the console of PMA's pages
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 namespace PMA\libraries;
   9
  10 use PMA\libraries\Template;
  11 use PMA\libraries\Bookmark;
  12
  13 if (! defined('PHPMYADMIN')) {
  14     exit;
  15 }
  16
  17 /**
  18  * Class used to output the console
  19  *
  20  * @package PhpMyAdmin
  21  */
  22 class Console
  23 {
  24     /**
  25      * Whether to display anything
  26      *
  27      * @access private
  28      * @var bool
  29      */
  30     private $_isEnabled;
  31
  32     /**
  33      * Creates a new class instance
  34      */
  35     public function __construct()
  36     {
  37         $this->_isEnabled = true;
  38     }
  39
  40     /**
  41      * Whether we are servicing an ajax request.
  42      *
  43      * @access private
  44      * @var bool
  45      */
  46     private $_isAjax;
  47
  48     /**
  49      * Set the ajax flag to indicate whether
  50      * we are servicing an ajax request
  51      *
  52      * @param bool $isAjax Whether we are servicing an ajax request
  53      *
  54      * @return void
  55      */
  56     public function setAjax($isAjax)
  57     {
  58         $this->_isAjax = (boolean) $isAjax;
  59     }
  60
  61     /**
  62      * Disables the rendering of the footer
  63      *
  64      * @return void
  65      */
  66     public function disable()
  67     {
  68         $this->_isEnabled = false;
  69     }
  70
  71     /**
  72      * Renders the bookmark content
  73      *
  74      * @access public
  75      * @return string
  76      */
  77     public static function getBookmarkContent()
  78     {
  79         $cfgBookmark = Bookmark::getParams();
  80         if ($cfgBookmark) {
  81             $bookmarks = Bookmark::getList();
  82             $count_bookmarks = count($bookmarks);
  83             if ($count_bookmarks > 0) {
  84                 $welcomeMessage = sprintf(
  85                     _ngettext(
  86                         'Showing %1$d bookmark (both private and shared)',
  87                         'Showing %1$d bookmarks (both private and shared)',
  88                         $count_bookmarks
  89                     ),
  90                     $count_bookmarks
  91                 );
  92             } else {
  93                 $welcomeMessage = __('No bookmarks');
  94             }
  95             unset($count_bookmarks, $private_message, $shared_message);
  96             return Template::get('console/bookmark_content')
  97                 ->render(
  98                     array(
  99                         'welcomeMessage'    => $welcomeMessage,
 100                         'bookmarks'         => $bookmarks,
 101                     )
 102                 );
 103         }
 104         return '';
 105     }
 106
 107     /**
 108      * Returns the list of JS scripts required by console
 109      *
 110      * @return array list of scripts
 111      */
 112     public function getScripts()
 113     {
 114         return array('console.js');
 115     }
 116
 117     /**
 118      * Renders the console
 119      *
 120      * @access public
 121      * @return string
 122      */
 123     public function getDisplay()
 124     {
 125         if ((! $this->_isAjax) && $this->_isEnabled) {
 126             $cfgBookmark = Bookmark::getParams();
 127
 128             $image = Util::getImage('console.png', __('SQL Query Console'));
 129             $_sql_history = PMA_getHistory($GLOBALS['cfg']['Server']['user']);
 130             $bookmarkContent = static::getBookmarkContent();
 131
 132             return Template::get('console/display')
 133                 ->render(
 134                     array(
 135                         'cfgBookmark'       => $cfgBookmark,
 136                         'image'             => $image,
 137                         '_sql_history'      => $_sql_history,
 138                         'bookmarkContent'   => $bookmarkContent,
 139                     )
 140                 );
 141         }
 142         return '';
 143     }
 144
 145 }