application/hub/main/helper/hub/answer/class_BaseHubAnswerHelper.php

   1 <?php
   2 /**
   3  * A general hub message answer helper class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseHubAnswerHelper extends BaseHubHelper {
  25         /**
  26          * Message data array
  27          */
  28         private $messageData = array();
  29
  30         /**
  31          * Package tags
  32          */
  33         private $packageTags = array();
  34
  35
  36         /**
  37          * Protected constructor
  38          *
  39          * @param       $className      Name of the concrete class
  40          * @return      void
  41          */
  42         protected function __construct ($className) {
  43                 // Call parent constructor
  44                 parent::__construct($className);
  45         }
  46
  47         /**
  48          * Setter for message data
  49          *
  50          * @return      $messageData    An array with message data
  51          */
  52         protected final function setMessageData (array $messageData) {
  53                 $this->messageData = $messageData;
  54         }
  55
  56         /**
  57          * Getter for message data
  58          *
  59          * @return      $messageData    An array with message data
  60          */
  61         public final function getMessageData () {
  62                 return $this->messageData;
  63         }
  64
  65         /**
  66          * Getter for package tags in a simple array
  67          *
  68          * @return      $packageTags    An array with all tags for the currently handled package
  69          */
  70         public final function getPackageTags () {
  71                 return $this->packageTags;
  72         }
  73
  74         /**
  75          * Setter for package tags in a simple array
  76          *
  77          * @param       $packageTags    An array with all tags for the currently handled package
  78          * @return      void
  79          */
  80         public final function setPackageTags (array $packageTags) {
  81                 $this->packageTags = $packageTags;
  82         }
  83 }
  84
  85 // [EOF]
  86 ?>