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