Class JFilesystemWrapperFolder

Wrapper class for JFilesystemFolder

Package: Joomla\Platform\FileSystem
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 3.4
Located at joomla/filesystem/wrapper/folder.php

Methods summary

`public boolean`	# `copy( string $src, string $dest, string $path = '', boolean $force = false, boolean $use_streams = false )` Helper wrapper method for copy Helper wrapper method for copy Parameters `$src` `string` - $src The path to the source folder. `$dest` `string` - $dest The path to the destination folder. `$path` `string` - $path An optional base path to prefix to the file names. `$force` `boolean` - $force Force copy. `$use_streams` `boolean` - $use_streams Optionally force folder/file overwrites. Returns `boolean` - True on success. Throws `RuntimeException` Since 3.4 See `JFolder::copy()`
`public boolean`	# `create( string $path = '', integer $mode = 493 )` Helper wrapper method for create Helper wrapper method for create Parameters `$path` `string` - $path A path to create from the base path. `$mode` `integer` - $mode Directory permissions to set for folders created. 0755 by default. Returns `boolean` - True if successful. Since 3.4 See `JFolder::create()`
`public boolean`	# `delete( string $path )` Helper wrapper method for delete Helper wrapper method for delete Parameters `$path` `string` - $path The path to the folder to delete. Returns `boolean` - True on success. Throws `UnexpectedValueException` Since 3.4 See `JFolder::delete()`
`public mixed`	# `move( string $src, string $dest, string $path = '', boolean $use_streams = false )` Helper wrapper method for move Helper wrapper method for move Parameters `$src` `string` - $src The path to the source folder. `$dest` `string` - $dest The path to the destination folder. `$path` `string` - $path An optional base path to prefix to the file names. `$use_streams` `boolean` - $use_streams Optionally use streams. Returns `mixed` - Error message on false or boolean true on success. Since 3.4 See `JFolder::move()`
`public boolean`	# `exists( string $path )` Helper wrapper method for exists Helper wrapper method for exists Parameters `$path` `string` - $path Folder name relative to installation dir. Returns `boolean` - True if path is a folder. Since 3.4 See `JFolder::exists()`
`public array`	# `files( string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\..', '.~'), boolean $naturalSort = false )` Helper wrapper method for files Helper wrapper method for files Parameters `$path` `string` - $path The path of the folder to read. `$filter` `string` - $filter A filter for file names. `$recurse` `mixed` - $recurse True to recursively search into sub-folders, or an integer to specify the maximum depth. `$full` `boolean` - $full True to return the full path to the file. `$exclude` `array` - $exclude Array with names of files which should not be shown in the result. `$excludefilter` `array` - $excludefilter Array of filter to exclude. `$naturalSort` `boolean` - $naturalSort False for asort, true for natsort. Returns `array` - Files in the given folder. Since 3.4 See `JFolder::files()`
`public array`	# `folders( string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\..*') )` Helper wrapper method for folders Helper wrapper method for folders Parameters `$path` `string` - $path The path of the folder to read. `$filter` `string` - $filter A filter for folder names. `$recurse` `mixed` - $recurse True to recursively search into sub-folders, or an integer to specify the maximum depth. `$full` `boolean` - $full True to return the full path to the folders. `$exclude` `array` - $exclude Array with names of folders which should not be shown in the result. `$excludefilter` `array` - $excludefilter Array with regular expressions matching folders which should not be shown in the result. Returns `array` - Folders in the given folder. Since 3.4 See `JFolder::folders()`
`public array`	# `listFolderTree( string $path, string $filter, integer $maxLevel = 3, integer $level = 0, integer $parent = 0 )` Helper wrapper method for listFolderTree Helper wrapper method for listFolderTree Parameters `$path` `string` - $path The path of the folder to read. `$filter` `string` - $filter A filter for folder names. `$maxLevel` `integer` - $maxLevel The maximum number of levels to recursively read, defaults to three. `$level` `integer` - $level The current level, optional. `$parent` `integer` - $parent Unique identifier of the parent folder, if any. Returns `array` - Folders in the given folder. Since 3.4 See `JFolder::listFolderTree()`
`public string`	# `makeSafe( string $path )` Helper wrapper method for makeSafe Helper wrapper method for makeSafe Parameters `$path` `string` - $path The full path to sanitise. Returns `string` - The sanitised string Since 3.4 See `JFolder::makeSafe()`

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFilesystemWrapperFolder

Methods summary

Parameters

Returns

Throws

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Throws

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Magic methods summary