framework/main/interfaces/index/file/class_FileIndexer.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Index\File;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Index\Indexable;
   7
   8 /**
   9  * An interface for indexable file classes
  10  *
  11  * @author              Roland Haeder <webmaster@ship-simu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.ship-simu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface FileIndexer extends Indexable {
  31         /**
  32          * Adds given data's hash to the index file
  33          *
  34          * @param       $stackName      Name of stack to add hash
  35          * @param       $data           Hash and gap position to be added to the index
  36          * @return      void
  37          * @throws      InvalidArgumentException        If a parameter is not valid
  38          */
  39         function addHashedDataToIndex (string $stackName, array $data);
  40
  41         /**
  42          * Searches for next suitable gap the given length of data can fit in
  43          * including padding bytes.
  44          *
  45          * @param       $length                 Length of raw data
  46          * @return      $seekPosition   Found next gap's seek position
  47          * @throws      InvalidArgumentException        If the parameter is not valid
  48          */
  49         function searchNextGap (int $length);
  50
  51         /**
  52          * Writes at given position by seeking to it.
  53          *
  54          * @param       $seekPosition   Seek position in file
  55          * @param       $dataStream             Data to be written
  56          * @return      mixed                   Number of writes bytes or false on error
  57          * @throws      InvalidArgumentException        If a parameter is not valid
  58          */
  59         function writeAtPosition (int $seekPosition, string $dataStream);
  60
  61 }