PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of folder.php

(no description)

Copyright:	Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License:	GNU/GPL, see LICENSE.php
Version:	$Id: folder.php 16421 2010-04-24 23:57:12Z dextercowley $
File Size:	571 lines (16 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

JFolder:: (9 methods):
  copy()
  create()
  delete()
  move()
  exists()
  files()
  folders()
  listFolderTree()
  makeSafe()

Class: JFolder - X-Ref

A Folder handling class

copy($src, $dest, $path = '', $force = false) X-Ref

Copy a folder.

param: string    The path to the source folder.
param: string    The path to the destination folder.
param: string    An optional base path to prefix to the file names.
param: boolean    Optionally force folder/file overwrites.
return: mixed    JError object on failure or boolean True on success.

create($path = '', $mode = 0755) X-Ref

Create a folder -- and all necessary parent folders.

param: string A path to create from the base path.
param: int Directory permissions to set for folders created.
return: boolean True if successful.

delete($path) X-Ref

Delete a folder.

param: string The path to the folder to delete.
return: boolean True on success.

move($src, $dest, $path = '') X-Ref

Moves a folder.

param: string The path to the source folder.
param: string The path to the destination folder.
param: string An optional base path to prefix to the file names.
return: mixed Error message on false or boolean true on success.

exists($path) X-Ref

Wrapper for the standard file_exists function

param: string Folder name relative to installation dir
return: boolean True if path is a folder

files($path, $filter = '.', $recurse = false, $fullpath = false, $exclude = array('.svn', 'CVS') X-Ref

Utility function to read the files in a folder.

param: string    The path of the folder to read.
param: string    A filter for file names.
param: mixed    True to recursively search into sub-folders, or an
param: boolean    True to return the full path to the file.
param: array    Array with names of files which should not be shown in
return: array    Files in the given folder.

folders($path, $filter = '.', $recurse = false, $fullpath = false, $exclude = array('.svn', 'CVS') X-Ref

Utility function to read the folders in a folder.

param: string    The path of the folder to read.
param: string    A filter for folder names.
param: mixed    True to recursively search into sub-folders, or an
param: boolean    True to return the full path to the folders.
param: array    Array with names of folders which should not be shown in
return: array    Folders in the given folder.

listFolderTree($path, $filter, $maxLevel = 3, $level = 0, $parent = 0) X-Ref

Lists folder in format suitable for tree display.

param: string    The path of the folder to read.
param: string    A filter for folder names.
param: integer    The maximum number of levels to recursively read,
param: integer    The current level, optional.
param: integer    Unique identifier of the parent folder, if any.
return: array    Folders in the given folder.

makeSafe($path) X-Ref

Makes path name safe to use.

param: string The full path to sanitise.
return: string The sanitised string.

PHP Cross Reference of Joomla 1.5.26 DE

/libraries/joomla/filesystem/ -> folder.php (summary)

Defines 1 class