_init()
append()
close_file()
copy()
copy_dir()
create()
create_dir()
delete()
delete_dir()
download()
exists()
file_info()
forge()
get()
get_permissions()
get_size()
get_time()
get_url()
instance()
open_file()
read()
read_dir()
rename()
rename_dir()
symlink()
update()
$areas
File Class
| package | Fuel |
|---|---|
| subpackage | Core |
| category | Core |
_init()
append(string $basepath, string $name, string $contents, string | \Fuel\Core\File_Area | null $area) : bool
stringdirectory where to write the file
stringfilename
stringcontents of file
\InvalidPathException |
|
|---|---|
\FileAccessException |
|
\OutsideAreaException |
boolclose_file(resource $resource, string | \Fuel\Core\File_Area | null $area)
resourceopen file resource
copy(string $path, string $new_path, string | \Fuel\Core\File_Area | null $source_area, string | \Fuel\Core\File_Area | null $target_area) : bool
stringpath path to file to copy
stringnew_path new base directory (full path)
string\Fuel\Core\File_Areanullsource_area source path file area name, object or null for non-specific
string\Fuel\Core\File_Areanulltarget_area target path file area name, object or null for non-specific. Defaults to source_area if not set.
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
boolcopy_dir(string $path, string $new_path, string | \Fuel\Core\File_Area | null $source_area, string | \Fuel\Core\File_Area | null $target_area)
stringpath to directory which contents will be copied
stringnew base directory (full path)
string\Fuel\Core\File_Areanullsource path file area name, object or null for non-specific
string\Fuel\Core\File_Areanulltarget path file area name, object or null for non-specific. Defaults to source_area if not set.
\FileAccessException |
when something went wrong |
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
create(string $basepath, string $name, null $contents, string | \Fuel\Core\File_Area | null $area) : bool
stringdirectory where to create file
stringfilename
nullcontents of file
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
boolcreate_dir(string $basepath, string $name, int $chmod, string | \Fuel\Core\File_Area | null $area) : bool
stringdirectory where to create new dir
stringdirname
int(octal) file permissions
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
booldelete(string $path, string | \Fuel\Core\File_Area | null $area) : bool
stringpath to file to delete
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
booldelete_dir(string $path, bool $recursive, bool $delete_top, string | \Fuel\Core\File_Area | null $area) : bool
stringpath to directory to delete
boolwhether to also delete contents of subdirectories
boolwhether to delete the parent dir itself when empty
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
booldownload(string $path, string | null $name, string | null $mime, string | \Fuel\Core\File_Area | null $area, bool $delete, string $disposition)
stringfile path
stringnullcustom name for the file to be downloaded
stringnullcustom mime type or null for file mime type
booldelete the file after download when true
stringdisposition, must be 'attachment' or 'inline'
exists(string $path, string | \Fuel\Core\File_Area | null $area) : bool
stringpath to file to check
boolfile_info(string $path, string | \Fuel\Core\File_Area | null $area) : array
stringfile path
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
arrayforge(array $config)
get(string $path, array $config, string | \Fuel\Core\File_Area | null $area) : \Fuel\Core\File_Handler_File
stringpath to the file or directory
arrayconfiguration items
get_size(string $path, mixed $area) : int
stringpath to the file or directory
mixedfile area name, object or null for base area
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
intthe file's size in bytesget_time(string $path, string $type, string | \Fuel\Core\File_Area | null $area) : int
stringpath to the file or directory
stringmodified or created
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
intUnix Timestampget_url(string $path, array $config, null $area) : bool
string
array
null
boolinstance(string | \Fuel\Core\File_Area | null $area) : \Fuel\Core\File_Area
open_file(resource | string $path, \Fuel\Core\constant | bool $lock, string | \Fuel\Core\File_Area | null $area) : bool | resource
resourcestringfile resource or path
\Fuel\Core\constantbooleither valid lock constant or true=LOCK_EX / false=LOCK_UN
\FileAccessException |
|
|---|---|
\OutsideAreaException |
boolresource
read(string $path, bool $as_string, string | \Fuel\Core\File_Area | null $area) : \Fuel\Core\IO | string
stringfile to read
boolwhether to use readfile() or file_get_contents()
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
\Fuel\Core\IOstringfile contentsread_dir(string $path, int $depth, Array | null $filter, string | \Fuel\Core\File_Area | null $area) : array
stringdirectory to read
intdepth to recurse directory, 1 is only current and 0 or smaller is unlimited
Arraynullarray of partial regexps or non-array for default
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
arrayrename(string $path, string $new_path, string | \Fuel\Core\File_Area | null $source_area, string | \Fuel\Core\File_Area | null $target_area) : bool
stringpath to file or directory to rename
stringnew path (full path, can also cause move)
string\Fuel\Core\File_Areanullsource path file area name, object or null for non-specific
string\Fuel\Core\File_Areanulltarget path file area name, object or null for non-specific. Defaults to source_area if not set.
\FileAccessException |
|
|---|---|
\OutsideAreaException |
boolrename_dir(string $path, string $new_path, string | \Fuel\Core\File_Area | null $source_area, string | \Fuel\Core\File_Area | null $target_area) : bool
stringpath to directory to rename
stringnew path (full path, can also cause move)
string\Fuel\Core\File_Areanullsource path file area name, object or null for non-specific
string\Fuel\Core\File_Areanulltarget path file area name, object or null for non-specific. Defaults to source_area if not set.
\FileAccessException |
|
|---|---|
\OutsideAreaException |
boolsymlink(string $path, string $link_path, bool $is_file, string | \Fuel\Core\File_Area | null $area) : bool
stringtarget of symlink
stringdestination of symlink
booltrue for file, false for directory
\FileAccessException |
|
|---|---|
\InvalidPathException |
|
\OutsideAreaException |
boolupdate(string $basepath, string $name, string $contents, string | \Fuel\Core\File_Area | null $area) : bool
stringdirectory where to write the file
stringfilename
stringcontents of file
\InvalidPathException |
|
|---|---|
\FileAccessException |
|
\OutsideAreaException |
bool$areas : array
