Folder structure browser, lists folders and files.
Provides an Object interface for Common directory related tasks.
string 'merge' string 'overwrite' string 'skip' string 'name' string 'time' arrayHolds array of complete directory paths.
arrayHolds errors from last method.
arrayHolds array of complete file paths.
string[]Functions array to be called depending on the sort type chosen.
arrayHolds messages from last method.
intMode to be used on create. Does nothing on windows platforms.
stringPath to Folder.
boolSortedness. Whether or not list results should be sorted by name.
Change the mode on a directory structure recursively. This includes changing the mode on files as well.
Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.)
Returns true if given $path is a registered stream wrapper.
Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.)
Returns $path with added terminating slash (corrected for Windows or other OS).
__construct(?string $path, bool $create, ?int $mode)
Constructor.
string|null $path optional Path to folder
bool $create optional Create folder if not found
int|null $mode optional Mode (CHMOD) to apply to created folder, false to ignore
_findRecursive(string $pattern, bool $sort)
Private helper function for findRecursive.
string $pattern Pattern to match against
bool $sort optional Whether results should be sorted.
arrayFiles matching pattern
addPathElement(string $path, mixed $element)
Returns $path with $element added, with correct slash in-between.
string $path Path
string|array $element Element to add at end of path
stringCombined path
cd(string $path)
Change directory to $path.
string $path Path to the directory to change to
string|falseThe new path. Returns false on failure
chmod(string $path, ?int $mode, bool $recursive, array $exceptions)
Change the mode on a directory structure recursively. This includes changing the mode on files as well.
string $path The path to chmod.
int|null $mode optional Octal value, e.g. 0755.
bool $recursive optional Chmod recursively, set to false to only change the current directory.
string[] $exceptions optional Array of files, directories to skip.
boolSuccess.
copy(string $to, array $options)
Recursive directory copy.
from The directory to copy from, this will cause a cd() to occur, changing the results of pwd().mode The mode to copy the files/directories with as integer, e.g. 0775.skip Files/directories to skip.scheme Folder::MERGE, Folder::OVERWRITE, Folder::SKIPrecursive Whether to copy recursively or not (default: true - recursive)string $to The directory to copy to.
array $options optional Array of options (see above).
boolSuccess.
correctSlashFor(string $path)
Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.)
string $path Path to check
stringSet of slashes ("\" or "/")
create(string $pathname, ?int $mode)
Create a directory structure recursively.
Can be used to create deep path structures like /foo/bar/baz/shoe/horn
string $pathname The directory structure to create. Either an absolute or relative path. If the path is relative and exists in the process' cwd it will not be created. Otherwise relative paths will be prefixed with the current pwd().
int|null $mode optional octal value 0755
boolReturns TRUE on success, FALSE on failure
delete(?string $path)
Recursively Remove directories if the system allows.
string|null $path optional Path of directory to delete
boolSuccess
dirsize()
Returns the size in bytes of this Folder and its contents.
intsize in bytes of current folder
errors(bool $reset)
get error from latest method
bool $reset optional Reset error stack after reading
arrayfind(string $regexpPattern, mixed $sort)
Returns an array of all matching files in current directory.
string $regexpPattern optional Preg_match pattern (Defaults to: .*)
string|bool $sort optional Whether results should be sorted.
arrayFiles that match given pattern
findRecursive(string $pattern, mixed $sort)
Returns an array of all matching files in and below current directory.
string $pattern optional Preg_match pattern (Defaults to: .*)
string|bool $sort optional Whether results should be sorted.
arrayFiles matching $pattern
inPath(string $path, bool $reverse)
Returns true if the Folder is in the given path.
string $path The absolute path to check that the current pwd() resides within.
bool $reverse optional Reverse the search, check if the given $path resides within the current pwd().
boolInvalidArgumentExceptionisAbsolute(string $path)
Returns true if given $path is an absolute path.
string $path Path to check
booltrue if path is absolute.
isRegisteredStreamWrapper(string $path)
Returns true if given $path is a registered stream wrapper.
string $path Path to check
boolTrue if path is registered stream wrapper.
isSlashTerm(string $path)
Returns true if given $path ends in a slash (i.e. is slash-terminated).
string $path Path to check
booltrue if path ends with slash, false otherwise
isWindowsPath(string $path)
Returns true if given $path is a Windows path.
string $path Path to check
booltrue if windows path, false otherwise
messages(bool $reset)
get messages from latest method
bool $reset optional Reset message stack after reading
arraymove(string $to, array $options)
Recursive directory move.
from The directory to copy from, this will cause a cd() to occur, changing the results of pwd().mode The mode to copy the files/directories with as integer, e.g. 0775.skip Files/directories to skip.scheme Folder::MERGE, Folder::OVERWRITE, Folder::SKIPrecursive Whether to copy recursively or not (default: true - recursive)string $to The directory to move to.
array $options optional Array of options (see above).
boolSuccess
normalizeFullPath(string $path)
Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.)
string $path Path to transform
stringPath with the correct set of slashes ("\" or "/")
pwd()
Return current path.
string|nullCurrent path
read(mixed $sort, mixed $exceptions, bool $fullPath)
Returns an array of the contents of the current directory.
The returned array holds two arrays: One of directories and one of files.
string|bool $sort optional Whether you want the results sorted, set this and the sort property to false to get unsorted results.
array|bool $exceptions optional Either an array or boolean true will not grab dot files
bool $fullPath optional True returns the full path
arrayContents of current directory as an array, an empty array on failure
realpath(mixed $path)
Get the real path (taking ".." and such into account)
string $path Path to resolve
string|falseThe resolved path
slashTerm(string $path)
Returns $path with added terminating slash (corrected for Windows or other OS).
string $path Path to check
stringPath with ending slash
subdirectories(?string $path, bool $fullPath)
Returns an array of subdirectories for the provided or current path.
string|null $path optional The directory path to get subdirectories for.
bool $fullPath optional Whether to return the full path or only the directory name.
arrayArray of subdirectories for the provided or current path.
tree(?string $path, mixed $exceptions, ?string $type)
Returns an array of nested directories and files in each directory
string|null $path optional the directory path to build the tree from
array|bool $exceptions optional Either an array of files/folder to exclude or boolean true to not grab dot files/folders
string|null $type optional either 'file' or 'dir'. Null returns both files and directories
arrayArray of nested directories and files in each directory
Holds array of complete directory paths.
arrayHolds errors from last method.
arrayHolds array of complete file paths.
arrayFunctions array to be called depending on the sort type chosen.
string[]Holds messages from last method.
arrayMode to be used on create. Does nothing on windows platforms.
intPath to Folder.
stringSortedness. Whether or not list results should be sorted by name.
bool
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Filesystem.Folder.html