libraries/ListAbstract.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * hold the ListAbstract base class
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 namespace PMA\libraries;
   9
  10 use ArrayObject;
  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 ListAbstract extends ArrayObject
  21 {
  22     /**
  23      * @var mixed   empty item
  24      */
  25     protected $item_empty = '';
  26
  27     /**
  28      * ListAbstract constructor
  29      *
  30      * @param array  $array          The input parameter accepts an array or an
  31      *                               Object.
  32      * @param int    $flags          Flags to control the behaviour of the
  33      *                               ArrayObject object.
  34      * @param string $iterator_class Specify the class that will be used for
  35      *                               iteration of the ArrayObject object.
  36      *                               ArrayIterator is the default class used.
  37      */
  38     public function __construct(
  39         $array = array(), $flags = 0, $iterator_class = "ArrayIterator"
  40     ) {
  41         parent::__construct($array, $flags, $iterator_class);
  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, otherwise 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(
  82         $selected = '', $include_information_schema = true
  83     ) {
  84         if (true === $selected) {
  85             $selected = $this->getDefault();
  86         }
  87
  88         $options = '';
  89         foreach ($this as $each_item) {
  90             if (false === $include_information_schema
  91                 && $GLOBALS['dbi']->isSystemSchema($each_item)
  92             ) {
  93                 continue;
  94             }
  95             $options .= '<option value="' . htmlspecialchars($each_item) . '"';
  96             if ($selected === $each_item) {
  97                 $options .= ' selected="selected"';
  98             }
  99             $options .= '>' . htmlspecialchars($each_item) . '</option>' . "\n";
 100         }
 101
 102         return $options;
 103     }
 104
 105     /**
 106      * returns default item
 107      *
 108      * @return string  default item
 109      */
 110     public function getDefault()
 111     {
 112         return $this->getEmpty();
 113     }
 114
 115     /**
 116      * builds up the list
 117      *
 118      * @return void
 119      */
 120     abstract public function build();
 121 }