133f346c635ea74d7cfd74f32c696d8f0131131a
[core.git] / framework / main / classes / file_directories / binary / index / class_IndexFile.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Filesystem\Index;
4
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;
9
10 // Import SPL stuff
11 use \SplFileInfo;
12
13 /**
14  * An index file class
15  *
16  * @author              Roland Haeder <webmaster@ship-simu.org>
17  * @version             0.0.0
18 <<<<<<< HEAD:framework/main/classes/file_directories/binary/index/class_IndexFile.php
19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 =======
21  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
22 >>>>>>> Some updates::inc/main/classes/file_directories/binary/index/class_IndexFile.php
23  * @license             GNU GPL 3.0 or any newer version
24  * @link                http://www.ship-simu.org
25  *
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.
30  *
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.
35  *
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/>.
38  */
39 class IndexFile extends BaseBinaryFile implements Block {
40         /**
41          * Protected constructor
42          *
43          * @return      void
44          */
45         protected function __construct () {
46                 // Call parent constructor
47                 parent::__construct(__CLASS__);
48         }
49
50         /**
51          * Creates an instance of this File class and prepares it for usage
52          *
53          * @param       $fileInfoInstance       An instance of a SplFileInfo class
54          * @param       $blockInstance  An instance of a Block class
55          * @return      $fileInstance   An instance of this File class
56          */
57         public final static function createIndexFile (SplFileInfo $fileInfoInstance, Block $blockInstance) {
58                 // Get a new instance
59                 $fileInstance = new IndexFile();
60
61                 // Set block instance here for callbacks
62                 $fileInstance->setBlockInstance($blockInstance);
63
64                 // Init this abstract file
65                 $fileInstance->initFile($fileInfoInstance);
66
67                 // Return the prepared instance
68                 return $fileInstance;
69         }
70
71         /**
72          * Writes given value to the file and returns a hash and gap position for it
73          *
74          * @param       $groupId        Group identifier
75          * @param       $value          Value to be added to the stack
76          * @return      $data           Hash and gap position
77          * @throws      UnsupportedOperationException   If this method is called
78          */
79         public function writeValueToFile ($groupId, $value) {
80                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] groupId=' . $groupId . ',value[' . gettype($value) . ']=' . print_r($value, true));
81                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
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__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] groupId=' . $groupId . ',encoded()=' . strlen($encoded));
95                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
96         }
97
98 }