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