Rewritten:
[core.git] / framework / main / classes / file_directories / binary / stack / class_StackFile.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Filesystem\Stack;
4
5 // Import framework stuff
6 use CoreFramework\Filesystem\Block;
7 use CoreFramework\Filesystem\File\BaseBinaryFile;
8 use CoreFramework\Generic\UnsupportedOperationException;
9
10 // Import SPL stuff
11 use \SplFileInfo;
12
13 /**
14  * A stack file class
15  *
16  * @author              Roland Haeder <webmaster@ship-simu.org>
17  * @version             0.0.0
18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
19  * @license             GNU GPL 3.0 or any newer version
20  * @link                http://www.ship-simu.org
21  *
22  * This program is free software: you can redistribute it and/or modify
23  * it under the terms of the GNU General Public License as published by
24  * the Free Software Foundation, either version 3 of the License, or
25  * (at your option) any later version.
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  * GNU General Public License for more details.
31  *
32  * You should have received a copy of the GNU General Public License
33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
34  */
35 class StackFile extends BaseBinaryFile implements Block {
36         /**
37          * Protected constructor
38          *
39          * @return      void
40          */
41         protected function __construct () {
42                 // Call parent constructor
43                 parent::__construct(__CLASS__);
44         }
45
46         /**
47          * Creates an instance of this File class and prepares it for usage
48          *
49          * @param       $infoInstance   An instance of a SplFileInfo class
50          * @param       $blockInstance  An instance of a Block class
51          * @return      $fileInstance   An instance of this File class
52          */
53         public final static function createStackFile (SplFileInfo $infoInstance, Block $blockInstance) {
54                 // Get a new instance
55                 $fileInstance = new StackFile();
56
57                 // Set block instance here for callbacks
58                 $fileInstance->setBlockInstance($blockInstance);
59
60                 // Init this abstract file
61                 $fileInstance->initFile($infoInstance);
62
63                 // Return the prepared instance
64                 return $fileInstance;
65         }
66
67         /**
68          * Writes given value to the file and returns a hash and gap position for it
69          *
70          * @param       $groupId        Group identifier
71          * @param       $value          Value to be added to the stack
72          * @return      $data           Hash and gap position
73          */
74         public function writeValueToFile ($groupId, $value) {
75                 // Make sure no objects/resources are added as the serialization may fail
76                 assert(!is_object($value));
77                 assert(!is_resource($value));
78
79                 // Encode/convert the value into a "binary format"
80                 $encoded = $this->encodeData($value);
81
82                 // Get a strong hash for the "encoded" data
83                 $hash = self::hash($encoded);
84
85                 // Then write it to the next free gap
86                 $data = $this->getBlockInstance()->writeDataToFreeGap($groupId, $hash, $encoded);
87
88                 // Return info
89                 return $data;
90         }
91
92         /**
93          * Writes given raw data to the file and returns a gap position and length
94          *
95          * @param       $groupId        Group identifier
96          * @param       $hash           Hash from encoded value
97          * @param       $encoded        Encoded value to be written to the file
98          * @return      $data           Gap position and length of the raw data
99          * @throws      UnsupportedOperationException   If this method is called
100          */
101         public function writeDataToFreeGap ($groupId, $hash, $encoded) {
102                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] groupId=' . $groupId . ',hash=' . $hash . ',encoded()=' . strlen($encoded));
103                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
104         }
105
106 }