<?php
// Own namespace
-namespace CoreFramework\Filesystem\File;
+namespace Org\Mxchange\CoreFramework\Filesystem\File;
// Import framework stuff
-use CoreFramework\Object\BaseFrameworkSystem;
+use Org\Mxchange\CoreFramework\Filesystem\CloseableFile;
+use Org\Mxchange\CoreFramework\Filesystem\FilePointer;
+use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
+use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
/**
* An abstract file class
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-class BaseAbstractFile extends BaseFrameworkSystem implements FilePointer, CloseableFile {
+abstract class BaseAbstractFile extends BaseFrameworkSystem implements FilePointer, CloseableFile {
/**
* Counter for total entries
*/
private $totalEntries = 0;
- /**
- * The current file we are working in
- */
- private $fileName = '';
-
/**
* Protected constructor
*
}
/**
- * Getter for the file pointer
+ * Getter for the file object
*
- * @return $filePointer The file pointer which shall be a valid file resource
+ * @return $fileObject An instance of a SplFileObject
* @throws UnsupportedOperationException If this method is called
*/
- public final function getPointer () {
+ public final function getFileObject () {
throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}
- /**
- * Setter for file name
- *
- * @param $fileName The new file name
- * @return void
- */
- protected final function setFileName ($fileName) {
- $fileName = (string) $fileName;
- $this->fileName = $fileName;
- }
-
- /**
- * Getter for file name
- *
- * @return $fileName The current file name
- */
- public final function getFileName () {
- return $this->fileName;
- }
-
/**
* Close a file source and set it's instance to null and the file name
* to empty
*/
public function closeFile () {
// Debug message
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d]: fileName=%s - CALLED!', __METHOD__, __LINE__, $this->getFileName()));
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d]: CALLED!', __METHOD__, __LINE__));
// Close down pointer instance as well by unsetting it
$this->unsetPointerInstance();
- // Remove file name
- $this->setFileName('');
-
// Debug message
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d]: EXIT!', __METHOD__, __LINE__));
}
* 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
+ * @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