source: plugins/maintenance/inc/class.dc.maintenance.descriptor.php @ 2566:9bf417837888

<?php
# -- BEGIN LICENSE BLOCK ---------------------------------------
#
# This file is part of Dotclear 2.
#
# Copyright (c) 2003-2013 Olivier Meunier & Association Dotclear
# Licensed under the GPL version 2.0 license.
# See LICENSE file or
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
#
# -- END LICENSE BLOCK -----------------------------------------
if (!defined('DC_RC_PATH')) { return; }

/**
@ingroup PLUGIN_MAINTENANCE
@nosubgrouping
@brief Simple descriptor for tabs, groups and more

At this time this class is used in same way an arrayObject
but in futur it could be completed with advance methods.
*/
class dcMaintenanceDescriptor
{
     protected $id;
     protected $name;
     protected $options;

     /**
      * Constructor (really ?!).
      *
      * @param id        <b>string<b> Tab ID
      * @param name <b>string<b> Tab name
      * @param options   <b>string<b> Options
      */
     public function __construct($id, $name, $options=array())
     {
          $this->id = (string) $id;
          $this->name = (string) $name;
          $this->options = (array) $options;
     }

     /**
      * Get ID.
      *
      * @return <b>string</b> ID
      */
     public function id()
     {
          return $this->id;
     }

     /**
      * Get name.
      *
      * @return <b>string</b> Name
      */
     public function name()
     {
          return $this->name;
     }

     /**
      * Get option.
      *
      * Option called "summary" and "description" are used.
      *
      * @param key       <b>string<b> Option key
      * @return <b>string</b> Option value
      */
     public function option($key)
     {
          return isset($this->options[$key]) ? $this->options[$key] : null;
     }

     /* @ignore */
     public function __get($key)
     {
          return $this->option($key);
     }

     /* @ignore */
     public function __isset($key)
     {
          return isset($this->options[$key]);
     }
}