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