phpmyadmin/libraries/List.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * hold the PMA_List base class
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * @todo add caching
  14  * @abstract
  15  * @package PhpMyAdmin
  16  * @since   phpMyAdmin 2.9.10
  17  */
  18 abstract class PMA_List extends ArrayObject
  19 {
  20     /**
  21      * @var mixed   empty item
  22      */
  23     protected $item_empty = '';
  24
  25     public function __construct($array = array(), $flags = 0, $iterator_class = "ArrayIterator")
  26     {
  27         parent::__construct($array, $flags, $iterator_class);
  28     }
  29
  30     /**
  31      * returns item only if there is only one in the list
  32      *
  33      * @return single item
  34      */
  35     public function getSingleItem()
  36     {
  37         if (count($this) === 1) {
  38             return reset($this);
  39         }
  40
  41         return $this->getEmpty();
  42     }
  43
  44     /**
  45      * defines what is an empty item (0, '', false or null)
  46      *
  47      * @return mixed   an empty item
  48      */
  49     public function getEmpty()
  50     {
  51         return $this->item_empty;
  52     }
  53
  54     /**
  55      * checks if the given db names exists in the current list, if there is
  56      * missing at least one item it returns false otherwise true
  57      *
  58      * @return boolean true if all items exists, otheriwse false
  59      */
  60     public function exists()
  61     {
  62         $this_elements = $this->getArrayCopy();
  63         foreach (func_get_args() as $result) {
  64             if (! in_array($result, $this_elements)) {
  65                 return false;
  66             }
  67         }
  68
  69         return true;
  70     }
  71
  72     /**
  73      * returns HTML <option>-tags to be used inside <select></select>
  74      *
  75      * @param mixed   $selected                   the selected db or true for
  76      *                                            selecting current db
  77      * @param boolean $include_information_schema whether include information schema
  78      *
  79      * @return string  HTML option tags
  80      */
  81     public function getHtmlOptions($selected = '', $include_information_schema = true)
  82     {
  83         if (true === $selected) {
  84             $selected = $this->getDefault();
  85         }
  86
  87         $options = '';
  88         foreach ($this as $each_item) {
  89             if (false === $include_information_schema
  90                 && PMA_is_system_schema($each_item)
  91             ) {
  92                 continue;
  93             }
  94             $options .= '<option value="' . htmlspecialchars($each_item) . '"';
  95             if ($selected === $each_item) {
  96                 $options .= ' selected="selected"';
  97             }
  98             $options .= '>' . htmlspecialchars($each_item) . '</option>' . "\n";
  99         }
 100
 101         return $options;
 102     }
 103
 104     /**
 105      * returns default item
 106      *
 107      * @return string  default item
 108      */
 109     public function getDefault()
 110     {
 111         return $this->getEmpty();
 112     }
 113
 114     /**
 115      * builds up the list
 116      *
 117      * @return void
 118      */
 119     abstract public function build();
 120 }
 121 ?>