* A class for directory reading and getting its contents
*
* @author Roland Haeder <webmaster@ship-simu.org>
- * @version 0.0
- * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @version 0.0.0
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
* @license GNU GPL 3.0 or any newer version
+ * @link http://www.ship-simu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class FrameworkDirectoryPointer extends BaseFrameworkSystem {
/**
private $dirPointer = null;
/**
- * Private constructor
+ * Protected constructor
*/
- private function __construct () {
+ protected function __construct () {
// Call parent constructor
- parent::constructor(__CLASS__);
-
- // Set part description
- $this->setPartDescr("Verzeichnis-Handler");
-
- // Create unique ID
- $this->createUniqueID();
+ parent::__construct(__CLASS__);
// Clean-up a little
$this->removeNumberFormaters();
+ $this->removeSystemArray();
}
/**
*
* @return string Directory and/or file names read from the current
* directory pointer
- * @throws NullPointerException If the directory pointer instance
- * is not set by setPointer()
- * @throws InvalidDirectoryResourceException If there is being set
- * an invalid directory resource
*/
public function readRawDirectory () {
- 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 InvalidDirectoryResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
- }
-
// Read data from the directory pointer and return it
return readdir($this->getPointer());
}
* to empty
*
* @return void
- * @throws NullPointerException If the directory pointer instance
- * is not set by setPointer()
- * @throws InvalidDirectoryResourceException If there is being set
*/
public function closeDirectory () {
- if (is_null($this->getPointer())) {
- // Pointer not initialized
- return;
- } elseif (!is_resource($this->getPointer())) {
- // Pointer is not a valid resource!
- throw new InvalidDirectoryResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
- }
-
// Close the directory pointer and reset the instance variable
@closedir($this->getPointer());
$this->setPointer(null);
* @return void
*/
public final function setPointer ($dirPointer) {
- // Sanity-check if the pointer is a valid directory resource
+ // Sanity-check if pointer is a valid directory resource
if (is_resource($dirPointer) || is_null($dirPointer)) {
// Is a valid resource
$this->dirPointer = $dirPointer;