class CKunenaFolder extends JFolder


Located at : UKNOWVA_ROOT/components/com_kunena/lib/kunena.file.class.1.6.php

Methods

static mixed
copy($src, $dest, $path = '', $force = false, $use_streams = false)

Copy a folder.

from JFolder
static boolean
create(string $path = '', integer $mode = 493, boolean $add_index_file = false)

Create a folder -- and all necessary parent folders.

from JFolder
static boolean
delete(string $path)

Delete a folder.

from JFolder
static mixed
move(string $src, string $dest, string $path = '', boolean $use_streams = false)

Moves a folder.

from JFolder
static boolean
exists(string $path)

Wrapper for the standard file_exists function

from JFolder
static array
files(string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\\..*', '.*~'))

Utility function to read the files in a folder.

from JFolder
static array
folders(string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\\..*'))

Utility function to read the folders in a folder.

from JFolder
static array
listFolderTree(string $path, string $filter, integer $maxLevel = 3, integer $level, integer $parent)

Lists folder in format suitable for tree display.

from JFolder
static string
makeSafe(string $path)

Makes path name safe to use.

from JFolder
static 
createIndex($folder)

No description

Details

in JFolder at line 34
static mixed copy($src, $dest, $path = '', $force = false, $use_streams = false)

Copy a folder.

Parameters

$src
$dest
$path
$force
$use_streams

Return Value

mixed JError object on failure or boolean True on success.

in JFolder at line 156
static boolean create(string $path = '', integer $mode = 493, boolean $add_index_file = false)

Create a folder -- and all necessary parent folders.

Parameters

string $path A path to create from the base path.
integer $mode Directory permissions to set for folders created. 0755 by default.
boolean $add_index_file if set to yes, then add an index.html file as well in the newly created folder

Return Value

boolean True if successful.

in JFolder at line 284
static boolean delete(string $path)

Delete a folder.

Parameters

string $path The path to the folder to delete.

Return Value

boolean True on success.

in JFolder at line 382
static mixed move(string $src, string $dest, string $path = '', boolean $use_streams = false)

Moves a folder.

Parameters

string $src The path to the source folder.
string $dest The path to the destination folder.
string $path An optional base path to prefix to the file names.
boolean $use_streams

Return Value

mixed Error message on false or boolean true on success.

in JFolder at line 448
static boolean exists(string $path)

Wrapper for the standard file_exists function

Parameters

string $path Folder name relative to installation dir

Return Value

boolean True if path is a folder

in JFolder at line 468
static array files(string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\\..*', '.*~'))

Utility function to read the files in a folder.

Parameters

string $path The path of the folder to read.
string $filter A filter for file names.
mixed $recurse True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean $full True to return the full path to the file.
array $exclude Array with names of files which should not be shown in the result.
array $excludefilter Array of filter to exclude

Return Value

array Files in the given folder.

in JFolder at line 512
static array folders(string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\\..*'))

Utility function to read the folders in a folder.

Parameters

string $path The path of the folder to read.
string $filter A filter for folder names.
mixed $recurse True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean $full True to return the full path to the folders.
array $exclude Array with names of folders which should not be shown in the result.
array $excludefilter Array with regular expressions matching folders which should not be shown in the result.

Return Value

array Folders in the given folder.

in JFolder at line 617
static array listFolderTree(string $path, string $filter, integer $maxLevel = 3, integer $level, integer $parent)

Lists folder in format suitable for tree display.

Parameters

string $path The path of the folder to read.
string $filter A filter for folder names.
integer $maxLevel The maximum number of levels to recursively read, defaults to three.
integer $level The current level, optional.
integer $parent Unique identifier of the parent folder, if any.

Return Value

array Folders in the given folder.

in JFolder at line 653
static string makeSafe(string $path)

Makes path name safe to use.

Parameters

string $path The full path to sanitise.

Return Value

string The sanitised string.

at line 56
static createIndex($folder)

Parameters

$folder