libraries/properties/options/OptionsPropertyGroup.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 namespace PMA\libraries\properties\options;
   9
  10 /**
  11  * Parents group property items and provides methods to manage groups of
  12  * properties.
  13  *
  14  * @todo    modify descriptions if needed, when the options are integrated
  15  * @package PhpMyAdmin
  16  */
  17 abstract class OptionsPropertyGroup extends OptionsPropertyItem implements \Countable
  18 {
  19     /**
  20      * Holds a group of properties (PMA\libraries\properties\options\OptionsPropertyItem instances)
  21      *
  22      * @var array
  23      */
  24     private $_properties;
  25
  26     /**
  27      * Adds a property to the group of properties
  28      *
  29      * @param OptionsPropertyItem $property the property instance to be added
  30      *                                      to the group
  31      *
  32      * @return void
  33      */
  34     public function addProperty($property)
  35     {
  36         if (!$this->getProperties() == null
  37             && in_array($property, $this->getProperties(), true)
  38         ) {
  39             return;
  40         }
  41         $this->_properties [] = $property;
  42     }
  43
  44     /**
  45      * Removes a property from the group of properties
  46      *
  47      * @param OptionsPropertyItem $property the property instance to be removed
  48      *                                      from the group
  49      *
  50      * @return void
  51      */
  52     public function removeProperty($property)
  53     {
  54         $this->_properties = array_diff(
  55             $this->getProperties(),
  56             array($property)
  57         );
  58     }
  59
  60
  61     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  62
  63     /**
  64      * Gets the instance of the class
  65      *
  66      * @return array
  67      */
  68     public function getGroup()
  69     {
  70         return $this;
  71     }
  72
  73     /**
  74      * Gets the group of properties
  75      *
  76      * @return array
  77      */
  78     public function getProperties()
  79     {
  80         return $this->_properties;
  81     }
  82
  83     /**
  84      * Gets the number of properties
  85      *
  86      * @return int
  87      */
  88     public function getNrOfProperties()
  89     {
  90         if (is_null($this->_properties)) {
  91             return 0;
  92         }
  93         return count($this->_properties);
  94     }
  95
  96     /**
  97      * Countable interface implementation.
  98      *
  99      * @return int
 100      */
 101     public function count() {
 102         return $this->getNrOfProperties();
 103     }
 104 }