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