Source for file OCSP_DT_COLLECTION.phpclass

Documentation is available at OCSP_DT_COLLECTION.phpclass

  1. <?php
  2. /**
  3.   * openCSP class file OCSP_DT_COLLECTION.phpclass
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package datatypes
  7.   *
  8.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  9.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.   *
  11.   * @since pk-01.08.2008
  12.   * @version $Id: OCSP_DT_COLLECTION.phpclass,v 1.1 2008/08/02 01:03:29 pitlinz Exp $
  13.   */
  14.  
  15.     // ---------------------------------------------------------
  16.     // requirements
  17.     // ---------------------------------------------------------
  18.  
  19. /**
  20.   * openCSP class OCSP_DT_COLLECTION
  21.   *
  22.   * @project Open CSP-Management
  23.   * @package datatypes
  24.   *
  25.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  26.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  27.   *
  28.   * @since pk-01.08.2008
  29.   * @version $Id: OCSP_DT_COLLECTION.phpclass,v 1.1 2008/08/02 01:03:29 pitlinz Exp $
  30.   */
  31. class OCSP_DT_COLLECTION 
  32. {
  33.     // ---------------------------------------------------------------------------
  34.     // constants
  35.     // ---------------------------------------------------------------------------
  36.     
  37.     /**
  38.      * @constant string CLASS_SRC_FILE
  39.      */
  40.     const CLASS_SRC_FILE = __FILE__;
  41.  
  42.     // ---------------------------------------------------------------------------
  43.     // class (static)
  44.     // ---------------------------------------------------------------------------
  45.     
  46.     /*** class vars ------------------------------------------------------ */
  47.     
  48.     /*** class methods --------------------------------------------------- */
  49.     
  50.     // ---------------------------------------------------------------------------
  51.     // object vars
  52.     // ---------------------------------------------------------------------------
  53.     
  54.     /*** compostion --------------------------------------------------- */
  55.     
  56.     /**
  57.      * array of items represents the collection
  58.      *
  59.      * @var array $myItems 
  60.      */
  61.     protected $myItems = array();
  62.     
  63.     /*** attributes  -------------------------------------------------- */
  64.     
  65.     /**
  66.      * the collection id
  67.      *
  68.      * @var mixed $myId 
  69.      */
  70.     protected $myId = Null;
  71.     
  72.     // ---------------------------------------------------------------------------
  73.     // factory / construct
  74.     // ---------------------------------------------------------------------------
  75.     
  76.     // ---------------------------------------------------------------------------
  77.     // getter / setter
  78.     // ---------------------------------------------------------------------------    
  79.  
  80.     public function getNofItems()
  81.     {
  82.         return sizeof($this->myItems);
  83.     }
  84.     
  85.     // ---------------------------------------------------------------------------
  86.     // item methods
  87.     // ---------------------------------------------------------------------------    
  88.     
  89.     /**
  90.      * adds an item to the collection
  91.      *
  92.      * @param mixed $aItem 
  93.      */
  94.     public function addItem(&$aItem)
  95.     {
  96.         $this->myItems[] = $aItem;
  97.     }
  98.     
  99.     /**
  100.      * returns the items
  101.      *
  102.      * @return array 
  103.      */
  104.     public function getItems()
  105.     {
  106.         return $this->myItems;
  107.     }
  108.     
  109. }
  110.  
  111. ?>

Documentation generated on Thu, 08 Jan 2009 17:45:36 +0100 by phpDocumentor 1.4.0a2