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  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  19  * @license             GNU GPL 3.0 or any newer version
  20  * @link                http://www.ship-simu.org
  21  *
  22  * This program is free software: you can redistribute it and/or modify
  23  * it under the terms of the GNU General Public License as published by
  24  * the Free Software Foundation, either version 3 of the License, or
  25  * (at your option) any later version.
  26  *
  27  * This program is distributed in the hope that it will be useful,
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  * GNU General Public License for more details.
  31  *
  32  * You should have received a copy of the GNU General Public License
  33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  34  */
  35 class IndexFile extends BaseBinaryFile implements Block {
  36         /**
  37          * Protected constructor
  38          *
  39          * @return      void
  40          */
  41         protected function __construct () {
  42                 // Call parent constructor
  43                 parent::__construct(__CLASS__);
  44         }
  45
  46         /**
  47          * Creates an instance of this File class and prepares it for usage
  48          *
  49          * @param       $fileInfoInstance       An instance of a SplFileInfo class
  50          * @param       $blockInstance  An instance of a Block class
  51          * @return      $fileInstance   An instance of this File class
  52          */
  53         public final static function createIndexFile (SplFileInfo $fileInfoInstance, Block $blockInstance) {
  54                 // Get a new instance
  55                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: fileInfoInstance=%s,blockInstance=%s - CALLED!', $fileInfoInstance, $blockInstance->__toString()));
  56                 $fileInstance = new IndexFile();
  57
  58                 // Set block instance here for callbacks
  59                 $fileInstance->setBlockInstance($blockInstance);
  60
  61                 // Expand file name with .idx
  62                 $indexInfoInstance = new SplFileInfo(sprintf('%s.idx', $fileInfoInstance->__toString()));
  63
  64                 // Init this abstract file
  65                 $fileInstance->initFile($indexInfoInstance);
  66
  67                 // Return the prepared instance
  68                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: fileInstance=%s - EXIT!', $fileInstance->__toString()));
  69                 return $fileInstance;
  70         }
  71
  72         /**
  73          * Writes given value to the file and returns a hash and gap position for it
  74          *
  75          * @param       $groupId        Group identifier
  76          * @param       $value          Value to be added to the stack
  77          * @return      $data           Hash and gap position
  78          * @throws      UnsupportedOperationException   If this method is called
  79          */
  80         public function writeValueToFile (string $groupId, $value) {
  81                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] groupId=' . $groupId . ',value[' . gettype($value) . ']=' . print_r($value, true));
  82                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  83         }
  84
  85         /**
  86          * Writes given raw data to the file and returns a gap position and length
  87          *
  88          * @param       $groupId        Group identifier
  89          * @param       $hash           Hash from encoded value
  90          * @param       $encoded        Encoded value to be written to the file
  91          * @return      $data           Gap position and length of the raw data
  92          * @throws      UnsupportedOperationException   If this method is called
  93          */
  94         public function writeDataToFreeGap (string $groupId, string $hash, string $encoded) {
  95                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] groupId=' . $groupId . ',encoded()=' . strlen($encoded));
  96                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  97         }
  98
  99 }