phpmyadmin/libraries/properties/options/OptionsPropertyGroup.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Superclass for the Property Group classes.
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /* This class extends the OptionsPropertyItem class */
  13 require_once 'OptionsPropertyItem.class.php';
  14
  15 /**
  16  * Parents group property items and provides methods to manage groups of
  17  * properties.
  18  *
  19  * @todo modify descriptions if needed, when the options are integrated
  20  * @package PhpMyAdmin
  21  */
  22 abstract class OptionsPropertyGroup extends OptionsPropertyItem
  23 {
  24     /**
  25      * Holds a group of properties (OptionsPropertyItem instances)
  26      *
  27      * @var array
  28      */
  29     private $_properties;
  30
  31     /**
  32      * Adds a property to the group of properties
  33      *
  34      * @param OptionsPropertyItem $property the property instance to be added
  35      *                                      to the group
  36      *
  37      * @return void
  38      */
  39     public function addProperty($property)
  40     {
  41         if (! $this->getProperties() == null
  42             && in_array($property, $this->getProperties(), true)
  43         ) {
  44             return;
  45         }
  46         $this->_properties [] = $property;
  47     }
  48
  49     /**
  50      * Removes a property from the group of properties
  51      *
  52      * @param OptionsPropertyItem $property the property instance to be removed
  53      *                                      from the group
  54      *
  55      * @return void
  56      */
  57     public function removeProperty($property)
  58     {
  59         $this->_properties = array_udiff(
  60             $this->getProperties(),
  61             array($property),
  62             // for PHP 5.2 compability
  63             create_function(
  64                 '$a, $b',
  65                 'return ($a === $b ) ? 0 : 1'
  66             )
  67         );
  68     }
  69
  70
  71     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  72
  73
  74     /**
  75      * Gets the instance of the class
  76      *
  77      * @return array
  78      */
  79     public function getGroup()
  80     {
  81         return $this;
  82     }
  83
  84     /**
  85      * Gets the group of properties
  86      *
  87      * @return array
  88      */
  89     public function getProperties()
  90     {
  91         return $this->_properties;
  92     }
  93
  94     /**
  95      * Gets the number of properties
  96      *
  97      * @return int
  98      */
  99     public function getNrOfProperties()
 100     {
 101         return count($this->_properties);
 102     }
 103 }
 104 ?>