class_FrameworkFileInputPointer.php

Go to the documentation of this file.

<?php
class FrameworkFileInputPointer extends BaseFrameworkSystem {
        private $fileName = "";

        private $filePointer = null;

        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);

                // Clean-up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
        }

        public final function __destruct() {
                // Is there a resource pointer? Then we have to close the file here!
                if (is_resource($this->getPointer())) {
                        // Try to close a file
                        $this->closeFile();
                }

                // Call the parent destructor
                parent::__destruct();
        }

        public final static function createFrameworkFileInputPointer ($fileName) {
                // Some pre-sanity checks...
                if ((is_null($fileName)) || (empty($fileName))) {
                        // No filename given
                        throw new FileIsEmptyException(null, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } elseif (!file_exists($fileName)) {
                        // File does not exist!
                        throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
                } elseif (!is_readable($fileName)) {
                        // File does not exist!
                        throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
                }

                // Try to open a handler
                $filePointer = @fopen($fileName, 'rb');
                if ((is_null($filePointer)) || ($filePointer === false)) {
                        // Something bad happend
                        throw new FilePointerNotOpenedException ($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
                } // END - if

                // Create new instance
                $pointerInstance = new FrameworkFileInputPointer();

                // Set file pointer and file name
                $pointerInstance->setPointer($filePointer);
                $pointerInstance->setFileName($fileName);

                // Return the instance
                return $pointerInstance;
        }

        public function readFromFile () {
                if (is_null($this->getPointer())) {
                        // 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 InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
                }

                // Read data from the file pointer and return it
                return fread($this->getPointer(), 1024);
        }

        public function readLinesFromFile () {
                if (is_null($this->getPointer())) {
                        // 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 InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
                }

                // Read data from the file pointer and return it
                return fgets($this->getPointer(), 1024);
        }

        public function closeFile () {
                if (is_null($this->getPointer())) {
                        // 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 InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
                }

                // Close the file pointer and reset the instance variable
                @fclose($this->getPointer());
                $this->setPointer(null);
                $this->setFileName("");
        }

        public final function setPointer ($filePointer) {
                // Sanity-check if pointer is a valid file resource
                if (is_resource($filePointer) || is_null($filePointer)) {
                        // Is a valid resource
                        $this->filePointer = $filePointer;
                } else {
                        // Throw exception
                        throw new InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
                }
        }

        public final function getPointer () {
                return $this->filePointer;
        }

        public final function setFileName ($fileName) {
                $fileName = (string) $fileName;
                $this->fileName = $fileName;
        }

        public final function getFileName () {
                return $this->fileName;
        }
}

// [EOF]
?>