]> git.mxchange.org Git - core.git/blob - inc/classes/main/streams/crypto/class_NullCryptoStream.php
Rewrote core:
[core.git] / inc / classes / main / streams / crypto / class_NullCryptoStream.php
1 <?php
2 /**
3  * A null-encryption stream does not encrypt anything but can be used if e.e.
4  * mcrypt is not installed.
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009  Developer Team
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 class NullCryptoStream extends BaseStream implements EncryptableStream {
26         /**
27          * Protected constructor
28          *
29          * @return      void
30          */
31         protected function __construct () {
32                 // Call parent constructor
33                 parent::__construct(__CLASS__);
34         }
35
36         /**
37          * Creates an instance of this node class
38          *
39          * @return      $streamInstance         An instance of this node class
40          */
41         public static final function createNullCryptoStream () {
42                 // Get a new instance
43                 $streamInstance = new NullCryptoStream();
44
45                 // Return the instance
46                 return $streamInstance;
47         }
48
49         /**
50          * Encrypt the string with fixed salt
51          *
52          * @param       $str            The unencrypted string
53          * @return      $encrypted      Encrypted string
54          */
55         public function encryptStream ($str) {
56                 // Just handle it over
57                 $encrypted = (string) $str;
58
59                 // Return it
60                 return $encrypted;
61         }
62
63         /**
64          * Decrypt the string with fixed salt
65          *
66          * @param       $encrypted      Encrypted string
67          * @return      $str            The unencrypted string
68          */
69         public function decryptStream ($encrypted) {
70                 // Just handle it over
71                 $str = (string) $encrypted;
72
73                 // Return it
74                 return $str;
75         }
76
77         /**
78          * Streams the data and maybe does something to it
79          *
80          * @param       $data   The data (string mostly) to "stream"
81          * @return      $data   The data (string mostly) to "stream"
82          * @throws      UnsupportedOperationException   If this method is called (which is a mistake)
83          */
84         public function streamData ($data) {
85                 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
86                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
87         }
88 }
89
90 // [EOF]
91 ?>