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  * @version $Id$
   7  */
   8
   9 /**
  10  * @todo add caching
  11  * @since phpMyAdmin 2.9.10
  12  * @abstract
  13  */
  14 abstract class PMA_List extends ArrayObject
  15 {
  16     /**
  17      * @var mixed   empty item
  18      */
  19     protected $item_empty = '';
  20
  21     public function __construct($array = array(), $flags = 0, $iterator_class = "ArrayIterator")
  22     {
  23         parent::__construct($array, $flags, $iterator_class);
  24     }
  25
  26     /**
  27      * returns item only if there is only one in the list
  28      *
  29      * @uses    count()
  30      * @uses    reset()
  31      * @uses    PMA_List::getEmpty() to return it
  32      * @return  single item
  33      */
  34     public function getSingleItem()
  35     {
  36         if (count($this) === 1) {
  37             return reset($this);
  38         }
  39
  40         return $this->getEmpty();
  41     }
  42
  43     /**
  44      * defines what is an empty item (0, '', false or null)
  45      *
  46      * @uses    PMA_List::$item_empty as return value
  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      * @uses    PMA_List::$items to check for existence of specific item
  59      * @uses    func_get_args()
  60      * @uses    in_array() to check if given arguments exists in PMA_List::$items
  61      * @param   string  $db_name,..     one or more mysql result resources
  62      * @return  boolean true if all items exists, otheriwse false
  63      */
  64     public function exists()
  65     {
  66         $this_elements = $this->getArrayCopy();
  67         foreach (func_get_args() as $result) {
  68             if (! in_array($result, $this_elements)) {
  69                 return false;
  70             }
  71         }
  72
  73         return true;
  74     }
  75
  76     /**
  77      * returns HTML <option>-tags to be used inside <select></select>
  78      *
  79      * @uses    PMA_List::$items to build up the option items
  80      * @uses    PMA_List::getDefault() to mark this as selected if requested
  81      * @uses    htmlspecialchars() to escape items
  82      * @param   mixed   $selected   the selected db or true for selecting current db
  83      * @param   boolean $include_information_schema
  84      * @return  string  HTML option tags
  85      */
  86     public function getHtmlOptions($selected = '', $include_information_schema = true)
  87     {
  88         if (true === $selected) {
  89             $selected = $this->getDefault();
  90         }
  91
  92         $options = '';
  93         foreach ($this as $each_item) {
  94             if (false === $include_information_schema && 'information_schema' === $each_item) {
  95                 continue;
  96             }
  97             $options .= '<option value="' . htmlspecialchars($each_item) . '"';
  98             if ($selected === $each_item) {
  99                 $options .= ' selected="selected"';
 100             }
 101             $options .= '>' . htmlspecialchars($each_item) . '</option>' . "\n";
 102         }
 103
 104         return $options;
 105     }
 106
 107     /**
 108      * returns default item
 109      *
 110      * @uses    PMA_List::getEmpty() as fallback
 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      */
 122     abstract public function build();
 123 }
 124 ?>