*
* @author Roland Haeder <webmaster@ship-simu.org>
* @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
*
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class BaseFile extends BaseFrameworkSystem {
+ /**
+ * Counter for total entries
+ */
+ private $totalEntries = 0;
+
/**
* The current file we are working in
*/
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
*
* @throws UnsupportedOperationException If this method is called
*/
public final function getPointer () {
- self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}
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
$this->setFileName('');
}
- /**
- * Determines seek position
- *
- * @return $seekPosition Current seek position
- */
- public 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
*
* @todo Handle seekStatus
*/
public function size () {
+ // Call pointer instance
return $this->getPointerInstance()->size();
}
* @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
*
* 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();
}
}