Updated 'core' + renamed 'main' -> 'classes'.
[hub.git] / application / hub / classes / helper / messages / crypto / class_CryptoRandomUnitMessageHelper.php
1 <?php
2 /**
3  * A CryptoRandom message helper
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 CryptoRandomUnitMessageHelper extends BaseMessageHelper implements MessageHelper {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this class
37          *
38          * @param       $sourceType                     Type of the source
39          * @return      $messageInstance        An instance of a UnitHelper class
40          */
41         public final static function createCryptoRandomUnitMessageHelper ($sourceType) {
42                 // Get new instance
43                 $messageInstance = new CryptoRandomUnitMessageHelper();
44
45                 // Generate a source instance
46                 $sourceInstance = UnitSourceFactory::createUnitSourceInstance($sourceType);
47
48                 // Set the source instance
49                 $messageInstance->setSourceInstance($sourceInstance);
50
51                 // Return the prepared instance
52                 return $messageInstance;
53         }
54
55         /**
56          * Generates an encrypted random message
57          *
58          * @return      $encryptedMessage       The encrypted random message
59          */
60         public function generateRandomMessage () {
61                 // Get the message from our source
62                 $encryptedMessage = $this->getSourceInstance()->generateMessageFromSource();
63
64                 // Return it
65                 return $encryptedMessage;
66         }
67
68         /**
69          * "Getter" for an iterator for keys
70          *
71          * @return      $iteratorInstance       An instance of a Iterator class
72          */
73         public function getKeyIterator () {
74                 // Create the iterator instance
75                 $iteratorInstance = ObjectFactory::createObjectByConfiguredName('test_unit_producer_key_iterator_class');
76
77                 // And return it
78                 return $iteratorInstance;
79         }
80 }
81
82 // [EOF]
83 ?>