framework/main/classes/file_directories/binary/stack/class_StackFile.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem\Stack;
   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 use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
  10
  11 // Import SPL stuff
  12 use \SplFileInfo;
  13
  14 /**
  15  * A stack file class
  16  *
  17  * @author              Roland Haeder <webmaster@ship-simu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.ship-simu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class StackFile extends BaseBinaryFile implements Block {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this File class and prepares it for usage
  49          *
  50          * @param       $infoInstance   An instance of a SplFileInfo class
  51          * @param       $blockInstance  An instance of a Block class
  52          * @return      $fileInstance   An instance of this File class
  53          */
  54         public final static function createStackFile (SplFileInfo $infoInstance, Block $blockInstance) {
  55                 // Get a new instance
  56                 $fileInstance = new StackFile();
  57
  58                 // Set block instance here for callbacks
  59                 $fileInstance->setBlockInstance($blockInstance);
  60
  61                 // Init this abstract file
  62                 $fileInstance->initFile($infoInstance);
  63
  64                 // Return the prepared instance
  65                 return $fileInstance;
  66         }
  67
  68         /**
  69          * Writes given value to the file and returns a hash and gap position for it
  70          *
  71          * @param       $groupId        Group identifier
  72          * @param       $value          Value to be added to the stack
  73          * @return      $data           Hash and gap position
  74          */
  75         public function writeValueToFile ($groupId, $value) {
  76                 // Make sure no objects/resources are added as the serialization may fail
  77                 assert(!is_object($value));
  78                 assert(!is_resource($value));
  79
  80                 // Encode/convert the value into a "binary format"
  81                 $encoded = StringUtils::encodeData($value);
  82
  83                 // Get a strong hash for the "encoded" data
  84                 $hash = self::hash($encoded);
  85
  86                 // Then write it to the next free gap
  87                 $data = $this->getBlockInstance()->writeDataToFreeGap($groupId, $hash, $encoded);
  88
  89                 // Return info
  90                 return $data;
  91         }
  92
  93         /**
  94          * Writes given raw data to the file and returns a gap position and length
  95          *
  96          * @param       $groupId        Group identifier
  97          * @param       $hash           Hash from encoded value
  98          * @param       $encoded        Encoded value to be written to the file
  99          * @return      $data           Gap position and length of the raw data
 100          * @throws      UnsupportedOperationException   If this method is called
 101          */
 102         public function writeDataToFreeGap (string $groupId, string $hash, string $encoded) {
 103                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] groupId=' . $groupId . ',hash=' . $hash . ',encoded()=' . strlen($encoded));
 104                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 105         }
 106
 107 }