*
* @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
*/
}
/**
- * Initializes this file class
+ * "Getter" for abstracted file size
*
- * @param $fileName Name of this abstract file
- * @return void
+ * @return $fileSize Size of abstracted file
*/
- protected function initFile ($fileName) {
- // Get a file i/o pointer instance
- $pointerInstance = ObjectFactory::createObjectByConfiguredName('file_raw_input_output_class', array($fileName));
+ public function getFileSize () {
+ // Call pointer instanze
+ return $this->getPointerInstance()->getFileSize();
+ }
- // ... and set it here
- $this->setPointerInstance($pointerInstance);
+ /**
+ * Getter for total entries
+ *
+ * @return $totalEntries Total entries in this file
+ */
+ public final function getCounter () {
+ // Get it
+ return $this->totalEntries;
}
/**
- * Close a file source and set it's instance to null and the file name
- * to empty
+ * Setter for total entries
*
+ * @param $totalEntries Total entries in this file
* @return void
- * @todo ~10% done?
*/
- public function closeFile () {
- $this->partialStub('Unfinished method.');
+ protected final function setCounter ($counter) {
+ // Set it
+ $this->totalEntries = $counter;
+ }
- // Remove file name
- $this->setFileName('');
+ /**
+ * 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);
}
/**
public final function getFileName () {
return $this->fileName;
}
+
+ /**
+ * Close a file source and set it's instance to null and the file name
+ * to empty
+ *
+ * @return void
+ * @todo ~10% done?
+ */
+ public function closeFile () {
+ $this->partialStub('Unfinished method.');
+
+ // Remove file name
+ $this->setFileName('');
+ }
+
+ /**
+ * Size of this file
+ *
+ * @return $size Size (in bytes) of file
+ * @todo Handle seekStatus
+ */
+ public function size () {
+ // Call pointer instance
+ return $this->getPointerInstance()->size();
+ }
+
+ /**
+ * Read data a file pointer
+ *
+ * @return mixed The result of fread()
+ * @throws NullPointerException If the file pointer instance
+ * is not set by setPointer()
+ * @throws InvalidResourceException If there is being set
+ */
+ public function readFromFile () {
+ // Call pointer instance
+ return $this->getPointerInstance()->readFromFile();
+ }
+
+ /**
+ * Write data to a file pointer
+ *
+ * @param $dataStream The data stream we shall write to the file
+ * @return mixed Number of writes bytes or FALSE on error
+ * @throws NullPointerException If the file pointer instance
+ * is not set by setPointer()
+ * @throws InvalidResourceException If there is being set
+ * an invalid file resource
+ */
+ public function writeToFile ($dataStream) {
+ // Call pointer instance
+ return $this->getPointerInstance()->writeToFile($dataStream);
+ }
+
+ /**
+ * Determines whether the EOF has been reached
+ *
+ * @return $isEndOfFileReached Whether the EOF has been reached
+ */
+ public final function isEndOfFileReached () {
+ // Call pointer instance
+ return $this->getPointerInstance()->isEndOfFileReached();
+ }
}
// [EOF]