Class XoopsFolderHandler

Folder structure browser, lists folders and files.

Long description for class

Package: cake\cake\libs
Copyright: (c) 2005-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Taiwen Jiang phppp@users.sourceforge.net
Located at lass/file/folder.php

Methods summary
`public`	# `__construct( boolean\|string $path = false, boolean $create = true, mixed $mode = false )` Constructor. Constructor. Parameters `$path` Path to folder `$create` Create folder if not found `$mode` Mode (CHMOD) to apply to created folder, false to ignore
`public string`	# `pwd( )` Return current path. Return current path. Returns string Current path
`public string`	# `cd( string $path )` Change directory to $desired_path. Change directory to $desired_path. Parameters `$path` Path to the directory to change to Returns string The new path. Returns false on failure
`public mixed`	# `read( boolean $sort = true, mixed $exceptions = false )` Returns an array of the contents of the current directory, or false on failure. The returned array holds two arrays: one of dirs and one of files. Returns an array of the contents of the current directory, or false on failure. The returned array holds two arrays: one of dirs and one of files. Parameters `$sort` `$exceptions` either an array or boolean true will no grab dot files Returns mixed Contents of current directory as an array, false on failure
`public array`	# `find( string $regexp_pattern = '.', boolean $sort = false )` Returns an array of all matching files in current directory. Returns an array of all matching files in current directory. Parameters `$regexp_pattern` Preg_match pattern (Defaults to: .) `$sort` Returns array Files that match given pattern
`public array`	# `findRecursive( string $pattern = '.', boolean $sort = false )` Returns an array of all matching files in and below current directory. Returns an array of all matching files in and below current directory. Parameters `$pattern` Preg_match pattern (Defaults to: .) `$sort` Returns array Files matching $pattern
`public array`	# `_findRecursive( string $pattern, boolean $sort = false )` Private helper function for findRecursive. Private helper function for findRecursive. Parameters `$pattern` Pattern to match against `$sort` Returns array Files matching pattern
`public boolean`	# `isWindowsPath( string $path )` Returns true if given $path is a Windows path. Returns true if given $path is a Windows path. Parameters `$path` Path to check Returns boolean true if windows path, false otherwise
`public boolean`	# `isAbsolute( string $path )` Returns true if given $path is an absolute path. Returns true if given $path is an absolute path. Parameters `$path` Path to check Returns boolean
`public string`	# `normalizePath( string $path )` Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.) Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.) Parameters `$path` Path to check Returns string Set of slashes ("\" or "/")
`public string`	# `correctSlashFor( string $path )` Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.) Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.) Parameters `$path` Path to check Returns string Set of slashes ("\" or "/")
`public string`	# `slashTerm( string $path )` Returns $path with added terminating slash (corrected for Windows or other OS). Returns $path with added terminating slash (corrected for Windows or other OS). Parameters `$path` Path to check Returns string Path with ending slash
`public string`	# `addPathElement( string $path, string $element )` Returns $path with $element added, with correct slash in-between. Returns $path with $element added, with correct slash in-between. Parameters `$path` Path `$element` Element to and at end of path Returns string Combined path
`public boolean`	# `inXoopsPath( string $path = '' )` Returns true if the File is in a given XoopsPath. Returns true if the File is in a given XoopsPath. Parameters `$path` Returns boolean
`public boolean`	# `inPath( string $path = '', boolean $reverse = false )` Returns true if the File is in given path. Returns true if the File is in given path. Parameters `$path` `$reverse` Returns boolean
`public boolean`	# `chmod( string $path, boolean\|integer $mode = false, boolean $recursive = true, array $exceptions = array() )` Change the mode on a directory structure recursively. Change the mode on a directory structure recursively. Parameters `$path` The path to chmod `$mode` octal value 0755 `$recursive` chmod recursively `$exceptions` array of files, directories to skip Returns boolean Returns TRUE on success, FALSE on failure
`public mixed`	# `tree( string $path, boolean $hidden = true, string $type = null )` Returns an array of nested directories and files in each directory Returns an array of nested directories and files in each directory Parameters `$path` the directory path to build the tree from `$hidden` return hidden files and directories `$type` either file or dir. null returns both files and directories Returns mixed array of nested directories and files in each directory
`public`	# `_tree( string $path, $hidden )` Private method to list directories and files in each directory Private method to list directories and files in each directory Parameters `$path` `$hidden`
`public boolean`	# `create( string $pathname, boolean\|integer $mode = false )` Create a directory structure recursively. Create a directory structure recursively. Parameters `$pathname` The directory structure to create `$mode` octal value 0755 Returns boolean Returns TRUE on success, FALSE on failure
`public integer`	# `dirsize( )` Returns the size in bytes of this Folder. Returns the size in bytes of this Folder. Returns integer $size
`public boolean`	# `delete( string $path )` Recursively Remove directories if system allow. Recursively Remove directories if system allow. Parameters `$path` Path of directory to delete Returns boolean Success
`public boolean`	# `copy( array\|string $options = array() )` Recursive directory copy. Recursive directory copy. Parameters `$options` (to, from, chmod, skip) Returns boolean
`public boolean`	# `move( array\|string $options )` Recursive directory move. Recursive directory move. Parameters `$options` (to, from, chmod, skip) Returns boolean Success
`public array`	# `messages( )` get messages from latest method get messages from latest method Returns array
`public array`	# `errors( )` get error from latest method get error from latest method Returns array
`public string`	# `realpath( string $path )` Get the real path (taking ".." and such into account) Get the real path (taking ".." and such into account) Parameters `$path` Path to resolve Returns string The resolved path
`public boolean`	# `isSlashTerm( string $path )` Returns true if given $path ends in a slash (i.e. is slash-terminated). Returns true if given $path ends in a slash (i.e. is slash-terminated). Parameters `$path` Path to check Returns boolean true if path ends with slash, false otherwise

Properties summary
`public string`	`$path` Path to Folder. Path to Folder.	#
`public boolean`	`$sort` Sortedness. Sortedness.	# `false`
`public boolean`	`$mode` mode to be used on create. mode to be used on create.	# `'0755'`
`public array`	`$messages` holds messages from last method. holds messages from last method.	# `array()`
`public array`	`$errors` holds errors from last method. holds errors from last method.	# `false`
`public array`	`$directories` holds array of complete directory paths. holds array of complete directory paths.	#
`public array`	`$files` holds array of complete file paths. holds array of complete file paths.	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsFolderHandler

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns