Folder Class Info:
- Class Declaration:
class Folder extends Object
- File name:
- cake/libs/folder.php
- Description:
Folder structure browser, lists folders and files. Provides an Object interface for Common directory related tasks.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs
Properties:
-
mode integer
Mode to be used on create. Does nothing on windows platforms.
-
path string
Path to Folder.
-
sort boolean
Sortedness. Whether or not list results should be sorted by name.
Method Summary:
- addPathElement( $path, $element )
- cakeError( $method, $messages = array ( ) )
- cd( $path )
- chmod( $path, $mode = false, $recursive = true, $exceptions = array ( ) )
- __construct( $path = false, $create = false, $mode = false )
- copy( $options = array ( ) )
- correctSlashFor( $path )
- create( $pathname, $mode = false )
- delete( $path = NULL )
- dirsize( )
- dispatchMethod( $method, $params = array ( ) )
- errors( )
- find( $regexpPattern = '.*', $sort = false )
- findRecursive( $pattern = '.*', $sort = false )
- inCakePath( $path = '' )
- inPath( $path = '', $reverse = false )
- isAbsolute( $path )
- isSlashTerm( $path )
- isWindowsPath( $path )
- log( $msg, $type = 2 )
- messages( )
- move( $options )
- normalizePath( $path )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- pwd( )
- read( $sort = true, $exceptions = false, $fullPath = false )
- realpath( $path )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- slashTerm( $path )
- _stop( $status = 0 )
- toString( )
- tree( $path, $exceptions = true, $type = NULL )
addPathElement
topReturns $path with $element added, with correct slash in-between.
- Parameters:
-
-
string $path required
Path
-
string $element required
Element to and at end of path
-
- Method defined in:
- cake/libs/folder.php on line 324
- Return
string Combined path
- Access
public
- Static
cakeError
topUsed to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
- Parameters:
-
-
string $method required
Method to be called in the error class (AppError or ErrorHandler classes)
-
array $messages optional array ( )
Message that is to be displayed by the error class
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
cd
topChange directory to $path.
- Parameters:
-
-
string $path required
Path to the directory to change to
-
- Method defined in:
- cake/libs/folder.php on line 139
- Return
string The new path. Returns false on failure
- Access
public
chmod
topChange the mode on a directory structure recursively. This includes changing the mode on files as well.
- Parameters:
-
-
string $path required
The path to chmod
-
integer $mode optional false
octal value 0755
-
boolean $recursive optional true
chmod recursively, set to false to only change the current directory.
-
array $exceptions optional array ( )
array of files, directories to skip
-
- Method defined in:
- cake/libs/folder.php on line 372
- Return
boolean Returns TRUE on success, FALSE on failure
- Access
public
__construct
topConstructor.
- Parameters:
-
-
string $path optional false
Path to folder
-
boolean $create optional false
Create folder if not found
-
mixed $mode optional false
Mode (CHMOD) to apply to created folder, false to ignore
-
- Method defined in:
- cake/libs/folder.php on line 102
copy
topRecursive directory copy.
Options
toThe directory to copy to.fromThe directory to copy from, this will cause a cd() to occur, changing the results of pwd().chmodThe mode to copy the files/directories with.skipFiles/directories to skip.
- Parameters:
-
-
mixed $options optional array ( )
Either an array of options (see above) or a string of the destination directory.
-
- Method defined in:
- cake/libs/folder.php on line 613
- Return
bool Success
- Access
public
correctSlashFor
topReturns a correct set of slashes for given $path. (\\ for Windows paths and / for other paths.)
- Parameters:
-
-
string $path required
Path to check
-
- Method defined in:
- cake/libs/folder.php on line 296
- Return
string Set of slashes ("\\" or "/")
- Access
public
- Static
create
topCreate a directory structure recursively. Can be used to create
deep path structures like /foo/bar/baz/shoe/horn
- Parameters:
-
-
string $pathname required
The directory structure to create
-
integer $mode optional false
octal value 0755
-
- Method defined in:
- cake/libs/folder.php on line 479
- Return
boolean Returns TRUE on success, FALSE on failure
- Access
public
delete
topRecursively Remove directories if the system allows.
- Parameters:
-
-
string $path optional NULL
Path of directory to delete
-
- Method defined in:
- cake/libs/folder.php on line 556
- Return
boolean Success
- Access
public
dirsize
topReturns the size in bytes of this Folder and its contents.
- Method defined in:
- cake/libs/folder.php on line 519
- Return
int size in bytes of current folder
- Access
public
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
errors
topget error from latest method
- Method defined in:
- cake/libs/folder.php on line 731
- Return
array
- Access
public
find
topReturns an array of all matching files in current directory.
- Parameters:
-
-
$regexpPattern optional '.*'
-
boolean $sort optional false
Whether results should be sorted.
-
- Method defined in:
- cake/libs/folder.php on line 203
- Return
array Files that match given pattern
- Access
public
findRecursive
topReturns an array of all matching files in and below current directory.
- Parameters:
-
-
string $pattern optional '.*'
Preg_match pattern (Defaults to: .*)
-
boolean $sort optional false
Whether results should be sorted.
-
- Method defined in:
- cake/libs/folder.php on line 216
- Return
array Files matching $pattern
- Access
public
inCakePath
topReturns true if the File is in a given CakePath.
- Parameters:
-
-
string $path optional ''
The path to check.
-
- Method defined in:
- cake/libs/folder.php on line 335
- Return
bool
- Access
public
inPath
topReturns true if the File is in given path.
- Parameters:
-
-
string $path optional ''
The path to check that the current pwd() resides with in.
-
boolean $reverse optional false
The path to check that the current pwd() resides with in.
-
- Method defined in:
- cake/libs/folder.php on line 350
- Return
bool
- Access
public
isAbsolute
topReturns true if given $path is an absolute path.
- Parameters:
-
-
string $path required
Path to check
-
- Method defined in:
- cake/libs/folder.php on line 272
- Return
bool true if path is absolute.
- Access
public
- Static
isSlashTerm
topReturns true if given $path ends in a slash (i.e. is slash-terminated).
- Parameters:
-
-
string $path required
Path to check
-
- Method defined in:
- cake/libs/folder.php on line 783
- Return
boolean true if path ends with slash, false otherwise
- Access
public
- Static
isWindowsPath
topReturns true if given $path is a Windows path.
- Parameters:
-
-
string $path required
Path to check
-
- Method defined in:
- cake/libs/folder.php on line 260
- Return
boolean true if windows path, false otherwise
- Access
public
- Static
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
messages
topget messages from latest method
- Method defined in:
- cake/libs/folder.php on line 721
- Return
array
- Access
public
move
topRecursive directory move.
Options
toThe directory to copy to.fromThe directory to copy from, this will cause a cd() to occur, changing the results of pwd().chmodThe mode to copy the files/directories with.skipFiles/directories to skip.
- Parameters:
-
-
array $options required
(to, from, chmod, skip)
-
- Method defined in:
- cake/libs/folder.php on line 699
- Return
boolean Success
- Access
public
normalizePath
topReturns a correct set of slashes for given $path. (\\ for Windows paths and / for other paths.)
- Parameters:
-
-
string $path required
Path to check
-
- Method defined in:
- cake/libs/folder.php on line 284
- Return
string Set of slashes ("\\" or "/")
- Access
public
- Static
Object
topA hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
_persist
topChecks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
pwd
topReturn current path.
- Method defined in:
- cake/libs/folder.php on line 128
- Return
string Current path
- Access
public
read
topReturns an array of the contents of the current directory. The returned array holds two arrays: One of directories and one of files.
- Parameters:
-
-
boolean $sort optional true
Whether you want the results sorted, set this and the sort property to false to get unsorted results.
-
mixed $exceptions optional false
Either an array or boolean true will not grab dot files
-
boolean $fullPath optional false
True returns the full path
-
- Method defined in:
- cake/libs/folder.php on line 158
- Return
mixed Contents of current directory as an array, an empty array on failure
- Access
public
realpath
topGet the real path (taking ".." and such into account)
- Parameters:
-
-
string $path required
Path to resolve
-
- Method defined in:
- cake/libs/folder.php on line 741
- Return
string The resolved path
requestAction
topCalls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
- Parameters:
-
-
mixed $url required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
- Parameters:
-
-
array $properties optional array ( )
An associative array containing properties and corresponding values.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
slashTerm
topReturns $path with added terminating slash (corrected for Windows or other OS).
- Parameters:
-
-
string $path required
Path to check
-
- Method defined in:
- cake/libs/folder.php on line 308
- Return
string Path with ending slash
- Access
public
- Static
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
tree
topReturns an array of nested directories and files in each directory
- Parameters:
-
-
string $path required
the directory path to build the tree from
-
mixed $exceptions optional true
Array of files to exclude, defaults to excluding hidden files.
-
string $type optional NULL
either file or dir. null returns both files and directories
-
- Method defined in:
- cake/libs/folder.php on line 423
- Return
mixed array of nested directories and files in each directory
- Access
public
