X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=inc%2Fclasses%2Fmain%2Ffile_directories%2Fclass_BaseFile.php;h=0d1bb418ea9be169b0357cf5b607718cbaaa46af;hb=c77663981dbaefb7d8ff039967509aa1204ee556;hp=f286fe3a7b1183a91cf54ad7685e1a489e148ac7;hpb=382d1f5cddbc8c210cbc399476820415a22ba474;p=core.git diff --git a/inc/classes/main/file_directories/class_BaseFile.php b/inc/classes/main/file_directories/class_BaseFile.php index f286fe3a..0d1bb418 100644 --- a/inc/classes/main/file_directories/class_BaseFile.php +++ b/inc/classes/main/file_directories/class_BaseFile.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -22,6 +22,11 @@ * along with this program. If not, see . */ class BaseFile extends BaseFrameworkSystem { + /** + * Counter for total entries + */ + private $totalEntries = 0; + /** * The current file we are working in */ @@ -51,6 +56,57 @@ class BaseFile extends BaseFrameworkSystem { parent::__destruct(); } + /** + * "Getter" for abstracted file size + * + * @return $fileSize Size of abstracted file + */ + public function getFileSize () { + // Call pointer instanze + return $this->getPointerInstance()->getFileSize(); + } + + /** + * Getter for total entries + * + * @return $totalEntries Total entries in this file + */ + public final function getCounter () { + // Get it + return $this->totalEntries; + } + + /** + * Setter for total entries + * + * @param $totalEntries Total entries in this file + * @return void + */ + protected final function setCounter ($counter) { + // Set it + $this->totalEntries = $counter; + } + + /** + * Increment counter + * + * @return void + */ + protected final function incrementCounter () { + // Get it + $this->totalEntries++; + } + + /** + * Getter for the file pointer + * + * @return $filePointer The file pointer which shall be a valid file resource + * @throws UnsupportedOperationException If this method is called + */ + public final function getPointer () { + throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + } + /** * Setter for file name * @@ -71,20 +127,6 @@ class BaseFile extends BaseFrameworkSystem { return $this->fileName; } - /** - * Initializes this file class - * - * @param $fileName Name of this abstract file - * @return void - */ - protected function initFile ($fileName) { - // Get a file i/o pointer instance - $pointerInstance = ObjectFactory::createObjectByConfiguredName('file_raw_input_output_class', array($fileName)); - - // ... and set it here - $this->setPointerInstance($pointerInstance); - } - /** * Close a file source and set it's instance to null and the file name * to empty @@ -99,26 +141,6 @@ class BaseFile extends BaseFrameworkSystem { $this->setFileName(''); } - /** - * Determines seek position - * - * @return $seekPosition Current seek position - */ - public final function determineSeekPosition () { - return $this->getPointerInstance()->determineSeekPosition(); - } - - /** - * Seek to given offset (default) or other possibilities as fseek() gives. - * - * @param $offset Offset to seek to (or used as "base" for other seeks) - * @param $whence Added to offset (default: only use offset to seek to) - * @return $status Status of file seek: 0 = success, -1 = failed - */ - public function seek ($offset, $whence = SEEK_SET) { - return $this->getPointerInstance()->seek($offset, $whence); - } - /** * Size of this file * @@ -126,6 +148,7 @@ class BaseFile extends BaseFrameworkSystem { * @todo Handle seekStatus */ public function size () { + // Call pointer instance return $this->getPointerInstance()->size(); } @@ -138,19 +161,10 @@ class BaseFile extends BaseFrameworkSystem { * @throws InvalidResourceException If there is being set */ public function readFromFile () { + // Call pointer instance return $this->getPointerInstance()->readFromFile(); } - /** - * Reads given amount of bytes from file. - * - * @param $bytes Amount of bytes to read - * @return $data Data read from file - */ - public function read ($bytes) { - return $this->getPointerInstance()->read($bytes); - } - /** * Write data to a file pointer * @@ -162,16 +176,18 @@ class BaseFile extends BaseFrameworkSystem { * an invalid file resource */ public function writeToFile ($dataStream) { + // Call pointer instance return $this->getPointerInstance()->writeToFile($dataStream); } /** - * Rewinds to the beginning of the file + * Determines whether the EOF has been reached * - * @return $status Status of this operation + * @return $isEndOfFileReached Whether the EOF has been reached */ - public function rewind () { - return $this->getPointerInstance()->rewind(); + public final function isEndOfFileReached () { + // Call pointer instance + return $this->getPointerInstance()->isEndOfFileReached(); } }