[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

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

(no description)

Copyright: Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: file.php 19177 2010-10-21 03:08:56Z ian $
File Size: 391 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JFile:: (11 methods):
  getExt()
  stripExt()
  makeSafe()
  copy()
  delete()
  move()
  read()
  write()
  upload()
  exists()
  getName()


Class: JFile  - X-Ref

A File handling class

getExt($file)   X-Ref
Gets the extension of a file name

param: string $file The file name
return: string The file extension

stripExt($file)   X-Ref
Strips the last extension off a file name

param: string $file The file name
return: string The file name without the extension

makeSafe($file)   X-Ref
Makes file name safe to use

param: string $file The name of the file [not full path]
return: string The sanitised string

copy($src, $dest, $path = null)   X-Ref
Copies a file

param: string $src The path to the source file
param: string $dest The path to the destination file
param: string $path An optional base path to prefix to the file names
return: boolean True on success

delete($file)   X-Ref
Delete a file or array of files

param: mixed $file The file name or an array of file names
return: boolean  True on success

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

param: string $src The path to the source file
param: string $dest The path to the destination file
param: string $path An optional base path to prefix to the file names
return: boolean True on success

read($filename, $incpath = false, $amount = 0, $chunksize = 8192, $offset = 0)   X-Ref
Read the contents of a file

param: string $filename The full file path
param: boolean $incpath Use include path
param: int $amount Amount of file to read
param: int $chunksize Size of chunks to read
param: int $offset Offset of the file
return: mixed Returns file contents or boolean False if failed

write($file, $buffer)   X-Ref
Write contents to a file

param: string $file The full file path
param: string $buffer The buffer to write
return: boolean True on success

upload($src, $dest)   X-Ref
Moves an uploaded file to a destination folder

param: string $src The name of the php (temporary) uploaded file
param: string $dest The path (including filename) to move the uploaded file to
return: boolean True on success

exists($file)   X-Ref
Wrapper for the standard file_exists function

param: string $file File path
return: boolean True if path is a file

getName($file)   X-Ref
Returns the name, sans any path

param string $file File path
return: string filename



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1