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