<?php
// Own namespace
-namespace CoreFramework\Filesystem\Pointer\Text;
+namespace Org\Mxchange\CoreFramework\Filesystem\Pointer\Text;
// Import framework stuff
-use CoreFramework\FileSystem\BaseFileIo;
-use CoreFramework\Filesystem\Pointer\OutputPointer;
-use CoreFramework\Generic\NullPointerException;
+use Org\Mxchange\CoreFramework\Filesystem\BaseFileIo;
+use Org\Mxchange\CoreFramework\Filesystem\Pointer\OutputPointer;
+use Org\Mxchange\CoreFramework\Generic\NullPointerException;
+use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
+
+// Import SPL stuff
+use \InvalidArgumentException;
+use \SplFileInfo;
/**
* A class for writing files
*
* @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.shipsimu.org
*
* 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 FrameworkRawFileOutputPointer extends BaseFileIo implements OutputPointer {
+class FrameworkTextFileOutputPointer extends BaseFileIo implements OutputPointer {
/**
* Protected constructor
*
* @return void
*/
- protected function __construct () {
+ private function __construct () {
// Call parent constructor
parent::__construct(__CLASS__);
}
* Create a file pointer based on the given file. The file will also
* be verified here.
*
- * @param $fileName The file name we shall pass to fopen()
+ * @param $fileInstance An instance of a SplFileInfo class
* @param $mode The output mode ('w', 'a' are valid)
- * @throws FileIsEmptyException If the provided file name is empty.
+ * @throws InvalidArgumentException If mode is empty
* @throws FileIoException If fopen() returns not a file resource
* @return void
*/
- public static final function createFrameworkRawFileOutputPointer ($fileName, $mode) {
+ public static final function createFrameworkTextFileOutputPointer (SplFileInfo $fileInstance, $mode) {
// Some pre-sanity checks...
- if (is_null($fileName)) {
+ if (empty($mode)) {
// No filename given
- throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
- } // END - if
+ throw new InvalidArgumentException('Parameter "mode" is empty');
+ }
// Try to open a handler
- $filePointer = @fopen($fileName, $mode);
- if ((is_null($filePointer)) || ($filePointer === FALSE)) {
+ $fileObject = $fileInstance->openFile($mode);
+
+ // Is it valid?
+ if ((is_null($fileObject)) || ($fileObject === false)) {
// Something bad happend
- throw new FileIoException ($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
- } // END - if
+ throw new FileIoException($fileInstance, self::EXCEPTION_FILE_POINTER_INVALID);
+ }
// Create new instance
- $pointerInstance = new FrameworkRawFileOutputPointer();
+ $pointerInstance = new FrameworkTextFileOutputPointer();
- // Set file pointer and file name
- $pointerInstance->setPointer($filePointer);
- $pointerInstance->setFileName($fileName);
+ // Set file object
+ $pointerInstance->setFileObject($fileObject);
// Return the instance
return $pointerInstance;
* 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
+ * @return mixed Number of writes bytes or false on error
+ * @throws NullPointerException If the file pointer instance is not set by setFileObject()
+ * @throws LogicException If there is no object being set
*/
- public function writeToFile ($dataStream) {
- if (is_null($this->getPointer())) {
+ public function writeToFile (string $dataStream) {
+ if (is_null($this->getFileObject())) {
// Pointer not initialized
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } elseif (!is_resource($this->getPointer())) {
- // Pointer is not a valid resource!
- throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
+ } elseif (!is_object($this->getFileObject())) {
+ // Pointer is not a valid object!
+ throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
}
// Write data to the file pointer and return written bytes
- return fwrite($this->getPointer(), $dataStream);
+ return $this->getFileObject()->fwrite($dataStream);
}
/**
* @return void
* @throws UnsupportedOperationException If this method is called
*/
- public function analyzeFile () {
+ public function analyzeFileStructure () {
throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}
*
* @param $seekPosition Seek position in file
* @param $data Data to be written
- * @return mixed Number of writes bytes or FALSE on error
+ * @return mixed Number of writes bytes or false on error
* @throws UnsupportedOperationException If this method is called
*/
- public function writeAtPosition ($seedPosition, $data) {
+ public function writeAtPosition (int $seedPosition, string $data) {
throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}
/**
* Checks wether the current entry is valid (not at the end of the file).
- * This method will return TRUE if an emptied (nulled) entry has been found.
+ * This method will return true if an emptied (nulled) entry has been found.
*
* @return $isValid Whether the next entry is valid
* @throws UnsupportedOperationException If this method is called