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