application/hub/main/helper/class_BaseHubSystemHelper.php

   1 <?php
   2 /**
   3  * A general hub helper class. This class does not extend BaseHelper.
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 BaseHubSystemHelper extends BaseHubSystem implements HubHelper {
  25         /**
  26          * Recipient type
  27          */
  28         private $recipientType = 'invalid';
  29
  30         /**
  31          * Package tags
  32          */
  33         private $packageTags = array();
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the concrete class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Setter for recipient type
  48          *
  49          * @return      $recipientType  Type of a recipient (the helper is made for)
  50          */
  51         protected final function setRecipientType ($recipientType) {
  52                 $this->recipientType = $recipientType;
  53         }
  54
  55         /**
  56          * Getter for recipient type
  57          *
  58          * @return      $recipientType  Type of a recipient (the helper is made for)
  59          */
  60         public final function getRecipientType () {
  61                 return $this->recipientType;
  62         }
  63
  64         /**
  65          * Getter for package tags in a simple array
  66          *
  67          * @return      $packageTags    An array with all tags for the currently handled package
  68          */
  69         public final function getPackageTags () {
  70                 return $this->packageTags;
  71         }
  72
  73         /**
  74          * Setter for package tags in a simple array
  75          *
  76          * @param       $packageTags    An array with all tags for the currently handled package
  77          * @return      void
  78          */
  79         public final function setPackageTags (array $packageTags) {
  80                 $this->packageTags = $packageTags;
  81         }
  82
  83         /**
  84          * Tries to determine the used protocol for this package (this helper is helping to send out)
  85          *
  86          * @return      $protocolType   Type of protocol to use, usually TCP
  87          * @todo        0% done
  88          */
  89         public function determineProtocolType () {
  90                 die(__METHOD__ . ':' . print_r($this, TRUE));
  91                 // Return it
  92         }
  93 }
  94
  95 // [EOF]
  96 ?>