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