FSTools Class Reference

Filesystem tools not provided by default; can recursively create, copy and delete folders. More...

Inheritance diagram for FSTools:

Collaboration diagram for FSTools:

Public Member Functions
	mkdirr ($folder)
	Recursively creates a directory. More...
	copyr ($source, $dest)
	Copy a file, or recursively copy a folder and its contents; modified so that copied files, if PHP, have includes removed. More...
	copyable ($file)
	Overloadable function that tests a filename for copyability. More...
	rmdirr ($dirname)
	Delete a file, or a folder and its contents. More...
	globr ($dir, $pattern, $flags=NULL)
	Recursively globs a directory. More...
	__call ($name, $args)
	Allows for PHP functions to be called and be stubbed. More...

Static Public Member Functions
static	singleton ()
	Returns a global instance of FSTools. More...
static	setSingleton ($singleton)
	Sets our global singleton to something else; useful for overloading functions. More...

Static Private Attributes
static	$singleton

Detailed Description

Filesystem tools not provided by default; can recursively create, copy and delete folders.

Some template methods are provided for extensibility.

Note

This class must be instantiated to be used, although it does not maintain state.

Definition at line 10 of file FSTools.php.

Member Function Documentation

__call()

FSTools::__call	(		$name,
			$args
	)

Allows for PHP functions to be called and be stubbed.

Warning

This function will not work for functions that need to pass references; manually define a stub function for those.

Definition at line 157 of file FSTools.php.

    {
        return call_user_func_array($name, $args);
    }

copyable()

FSTools::copyable

(

$file

)

Overloadable function that tests a filename for copyability.

By default, everything should be copied; you can restrict things to ignore hidden files, unreadable files, etc. This function applies to copyr().

Definition at line 99 of file FSTools.php.

Referenced by copyr().

    {
        return true;
    }

Here is the caller graph for this function:

copyr()

FSTools::copyr	(		$source,
			$dest
	)

Copy a file, or recursively copy a folder and its contents; modified so that copied files, if PHP, have includes removed.

Note

Adapted from http://aidanlister.com/repos/v/function.copyr.php

Definition at line 63 of file FSTools.php.

References copyable().

    {
        // Simple copy for a file
        if (is_file($source)) {
            return $this->copy($source, $dest);
        }
        // Make destination directory
        if (!is_dir($dest)) {
            $this->mkdir($dest);
        }
        // Loop through the folder
        $dir = $this->dir($source);
        while ( false !== ($entry = $dir->read()) ) {
            // Skip pointers
            if ($entry == '.' || $entry == '..') {
                continue;
            }
            if (!$this->copyable($entry)) {
                continue;
            }
            // Deep copy directories
            if ($dest !== "$source/$entry") {
                $this->copyr("$source/$entry", "$dest/$entry");
            }
        }
        // Clean up
        $dir->close();
        return true;
    }

Here is the call graph for this function:

globr()

FSTools::globr	(		$dir,
			$pattern,
			$flags = NULL
	)

Recursively globs a directory.

Definition at line 139 of file FSTools.php.

References $files, and array.

    {
        $files = $this->glob("$dir/$pattern", $flags);
        if ($files === false) $files = array();
        $sub_dirs = $this->glob("$dir/*", GLOB_ONLYDIR);
        if ($sub_dirs === false) $sub_dirs = array();
        foreach ($sub_dirs as $sub_dir) {
            $sub_files = $this->globr($sub_dir, $pattern, $flags);
            $files = array_merge($files, $sub_files);
        }
        return $files;
    }

mkdirr()

FSTools::mkdirr

(

$folder

)

Recursively creates a directory.

Parameters

string

$folder

Name of folder to create

Note

Adapted from the PHP manual comment 76612

Definition at line 38 of file FSTools.php.

    {
        $folders = preg_split("#[\\\\/]#", $folder);
        $base = '';
        for($i = 0, $c = count($folders); $i < $c; $i++) {
            if(empty($folders[$i])) {
                if (!$i) {
                    // special case for root level
                    $base .= DIRECTORY_SEPARATOR;
                }
                continue;
            }
            $base .= $folders[$i];
            if(!is_dir($base)){
                $this->mkdir($base);
            }
            $base .= DIRECTORY_SEPARATOR;
        }
    }

rmdirr()

FSTools::rmdirr

(

$dirname

)

Delete a file, or a folder and its contents.

Note

Adapted from http://aidanlister.com/repos/v/function.rmdirr.php

Definition at line 108 of file FSTools.php.

    {
        // Sanity check
        if (!$this->file_exists($dirname)) {
            return false;
        }

        // Simple delete for a file
        if ($this->is_file($dirname) || $this->is_link($dirname)) {
            return $this->unlink($dirname);
        }

        // Loop through the folder
        $dir = $this->dir($dirname);
        while (false !== $entry = $dir->read()) {
            // Skip pointers
            if ($entry == '.' || $entry == '..') {
                continue;
            }
            // Recurse
            $this->rmdirr($dirname . DIRECTORY_SEPARATOR . $entry);
        }

        // Clean up
        $dir->close();
        return $this->rmdir($dirname);
    }

setSingleton()

static FSTools::setSingleton (   $singleton )

static

Sets our global singleton to something else; useful for overloading functions.

Definition at line 28 of file FSTools.php.

References $singleton.

    {
        FSTools::$singleton = $singleton;
    }

singleton()

static FSTools::singleton ( )

static

Returns a global instance of FSTools.

Definition at line 18 of file FSTools.php.

References $singleton.

Referenced by FSTools_File\__construct().

    {
        if (empty(FSTools::$singleton)) FSTools::$singleton = new FSTools();
        return FSTools::$singleton;
    }

Here is the caller graph for this function:

Field Documentation

$singleton

FSTools::$singleton

staticprivate

Definition at line 13 of file FSTools.php.

Referenced by setSingleton(), and singleton().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/ezyang/htmlpurifier/extras/FSTools.php