phpmyadmin/libraries/properties/PropertyItem.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * The top-level class of the object-oriented properties system.
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * Provides an interface for Property classes
  14  *
  15  * @package PhpMyAdmin
  16  */
  17 abstract class PropertyItem
  18 {
  19     /**
  20      * Returns the property type ( either "Options", or "Plugin" ).
  21      *
  22      * @return string
  23      */
  24     public abstract function getPropertyType();
  25
  26     /**
  27      * Returns the property item type of either an instance of
  28      *  - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or
  29      *  - OptionsPropertyGroup   ( "root", "main" or "subgroup" )
  30      *  - PluginPropertyItem     ( "export", "import", "transformations" )
  31      *
  32      * @return string
  33      */
  34     public abstract function getItemType();
  35
  36     /**
  37      * Only overwritten in the OptionsPropertyGroup class:
  38      * Used to tell whether we can use the current item as a group by calling
  39      * the addProperty() or removeProperty() methods, which are not available
  40      * for simple OptionsPropertyOneItem subclasses.
  41      *
  42      * @return string
  43      */
  44     public function getGroup()
  45     {
  46         return null;
  47     }
  48 }
  49 ?>