X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=framework%2Fmain%2Finterfaces%2Fiterator%2Ffile%2Fclass_SeekableWritableFileIterator.php;h=5c3b67cc122241a57c53ed422cfe0c112f4b4cd5;hb=refs%2Fheads%2Fmaster;hp=728a3457266998c2ea1b348482fb82e0e9ff629a;hpb=fc83e6b1ac6fe3a5e09a3e4f8bad20fa2240cae4;p=core.git

diff --git a/framework/main/interfaces/iterator/file/class_SeekableWritableFileIterator.php b/framework/main/interfaces/iterator/file/class_SeekableWritableFileIterator.php
deleted file mode 100644
index 728a3457..00000000
--- a/framework/main/interfaces/iterator/file/class_SeekableWritableFileIterator.php
+++ /dev/null
@@ -1,201 +0,0 @@
-<?php
-// Own namespace
-namespace Org\Mxchange\CoreFramework\Iterator\Filesystem;
-
-// Import SPL stuff
-use \SeekableIterator;
-
-/**
- * An interface for seekable iterators which also allow to write to the file
- * in different ways.
- *
- * @author		Roland Haeder <webmaster@ship-simu.org>
- * @version		0.0.0
- * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
- * @license		GNU GPL 3.0 or any newer version
- * @link		http://www.ship-simu.org
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-interface SeekableWritableFileIterator extends SeekableIterator {
-	/**
-	 * Seeks to given position
-	 *
-	 * @param	$seekPosition	Seek position in file
-	 * @return	$status			Status of this operation
-	 */
-	function seek (int $seekPosition);
-
-	/**
-	 * Size of file stack
-	 *
-	 * @return	$size	Size (in bytes) of file
-	 */
-	function size ();
-
-	/**
-	 * Reads given amount of bytes from file.
-	 *
-	 * @param	$bytes	Amount of bytes to read
-	 * @return	$data	Data read from file
-	 */
-	function read (int $bytes = 0);
-
-	/**
-	 * Analyzes entries in index file. This will count all found (and valid)
-	 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
-	 * only gaps are found, the file is considered as "virgin" (no entries).
-	 *
-	 * @return	void
-	 */
-	function analyzeFile ();
-
-	/**
-	 * Checks whether the file header is initialized
-	 *
-	 * @return	$isInitialized	Whether the file header is initialized
-	 */
-	function isFileHeaderInitialized ();
-
-	/**
-	 * Creates the assigned file
-	 *
-	 * @return	void
-	 */
-	function createFileHeader ();
-
-	/**
-	 * Pre-allocates file (if enabled) with some space for later faster write access.
-	 *
-	 * @param	$type	Type of the file
-	 * @return	void
-	 */
-	function preAllocateFile (string $type);
-
-	/**
-	 * Initializes counter for valid entries, arrays for damaged entries and
-	 * an array for gap seek positions. If you call this method on your own,
-	 * please re-analyze the file structure. So you are better to call
-	 * analyzeFile() instead of this method.
-	 *
-	 * @return	void
-	 */
-	function initCountersGapsArray ();
-
-	/**
-	 * Getter for header size
-	 *
-	 * @return	$totalEntries	Size of file header
-	 */
-	function getHeaderSize ();
-
-	/**
-	 * Setter for header size
-	 *
-	 * @param	$headerSize		Size of file header
-	 * @return	void
-	 */
-	function setHeaderSize (int $headerSize);
-
-	/**
-	 * Getter for header array
-	 *
-	 * @return	$totalEntries	Size of file header
-	 */
-	function getHeader ();
-
-	/**
-	 * Setter for header
-	 *
-	 * @param	$header		Array for a file header
-	 * @return	void
-	 */
-	function setHeader (array $header);
-
-	/**
-	 * Updates seekPosition attribute from file to avoid to much access on file.
-	 *
-	 * @return	void
-	 */
-	function updateSeekPosition ();
-
-	/**
-	 * Getter for total entries
-	 *
-	 * @return	$totalEntries	Total entries in this file
-	 */
-	function getCounter ();
-
-	/**
-	 * "Getter" for file size
-	 *
-	 * @return	$fileSize	Size of currently loaded file
-	 */
-	function getFileSize ();
-
-	/**
-	 * Writes data at given position
-	 *
-	 * @param	$seekPosition	Seek position
-	 * @param	$data			Data to be written
-	 * @param	$flushHeader	Whether to flush the header (default: flush)
-	 * @return	void
-	 */
-	function writeData (int $seekPosition, string $data, bool $flushHeader = true);
-
-	/**
-	 * Writes at given position by seeking to it.
-	 *
-	 * @param	$seekPosition	Seek position in file
-	 * @param	$data			Data to be written
-	 * @return	mixed			Number of writes bytes or false on error
-	 */
-	function writeAtPosition (int $seedPosition, string $data);
-
-	/**
-	 * Getter for seek position
-	 *
-	 * @return	$seekPosition	Current seek position (stored here in object)
-	 */
-	function getSeekPosition ();
-
-	/**
-	 * Writes given value to the file and returns a hash and gap position for it
-	 *
-	 * @param	$groupId	Group identifier
-	 * @param	$value		Value to be added to the stack
-	 * @return	$data		Hash and gap position
-	 */
-	function writeValueToFile (string $groupId, $value);
-
-	/**
-	 * Writes given raw data to the file and returns a gap position and length
-	 *
-	 * @param	$groupId	Group identifier
-	 * @param	$hash		Hash from encoded value
-	 * @param	$encoded	Encoded value to be written to the file
-	 * @return	$data		Gap position and length of the raw data
-	 */
-	function writeDataToFreeGap (string $groupId, string $hash, string $encoded);
-
-	/**
-	 * Searches for next suitable gap the given length of data can fit in
-	 * including padding bytes.
-	 *
-	 * @param	$length			Length of raw data
-	 * @return	$seekPosition	Found next gap's seek position
-	 */
-	function searchNextGap (int $length);
-
-}