// Import framework stuff
use Org\Mxchange\CoreFramework\Filesystem\BaseFileIo;
+use Org\Mxchange\CoreFramework\Filesystem\FileIoException;
use Org\Mxchange\CoreFramework\Filesystem\Pointer\OutputPointer;
use Org\Mxchange\CoreFramework\Generic\NullPointerException;
// Import SPL stuff
use \InvalidArgumentException;
use \SplFileInfo;
+use \SplFileObject;
/**
* A class for writing files
* Create a file pointer based on the given file. The file will also
* be verified here.
*
- * @param $infoInstance An instance of a SplFileInfo class
+ * @param $fileInstance An instance of a SplFileInfo class
* @param $mode The output mode ('w', 'a' are valid)
+ * @return void
* @throws InvalidArgumentException If parameter mode is empty
* @throws FileIoException If fopen() returns not a file resource
- * @return void
*/
- public static final function createFrameworkRawFileOutputPointer (SplFileInfo $infoInstance, $mode) {
- // Some pre-sanity checks...
- if (is_null($mode)) {
- // No infoInstance given
+ public static final function createFrameworkRawFileOutputPointer (SplFileInfo $fileInstance, string $mode) {
+ // Is the parameter valid?
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('RAW-FILE-OUTPUT-POINTER: fileInstance=%s,mode=%s - CALLED!', $fileInstance->__toString(), $mode));
+ if (empty($mode)) {
+ // No fileInstance given
throw new InvalidArgumentException('Parameter "mode" is empty');
}
// Try to open a handler
- $fileObject = $infoInstance->openFile($mode);
- if ((is_null($fileObject)) || ($fileObject === false)) {
+ $fileObject = $fileInstance->openFile($mode);
+
+ // Is it valid?
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('RAW-FILE-OUTPUT-POINTER: fileObject[]=%s', gettype($fileObject)));
+ if (!($fileObject instanceof SplFileObject)) {
// Something bad happend
- throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID);
+ throw new FileIoException($fileInstance, self::EXCEPTION_FILE_POINTER_INVALID);
}
// Create new instance
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('RAW-FILE-OUTPUT-POINTER: Creating pointer instance ...');
$pointerInstance = new FrameworkRawFileOutputPointer();
// Set file pointer and file name
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('RAW-FILE-OUTPUT-POINTER: pointerInstance=%s,fileObject=%s', $pointerInstance->__toString(), $fileObject->__toString()));
$pointerInstance->setFileObject($fileObject);
// Return the instance
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('RAW-FILE-OUTPUT-POINTER: pointerInstance=%s - EXIT!', $pointerInstance->__toString()));
return $pointerInstance;
}
*
* @param $dataStream The data stream we shall write to the file
* @return mixed Number of writes bytes or false on error
+ * @throws InvalidArgumentException If a parameter is invalid
* @throws NullPointerException If the file pointer instance is not set by setFileObject()
* @throws LogicException If there is no object being set
*/
public function writeToFile (string $dataStream) {
- if (is_null($this->getFileObject())) {
+ // Validate parameter and class own attributes
+ if (empty($dataStream)) {
+ // Empty data stream
+ throw new InvalidArgumentException('Parameter "dataStream" is empty');
+ } elseif (is_null($this->getFileObject())) {
// Pointer not initialized
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
} elseif (!is_object($this->getFileObject())) {