FSFile Class Reference

File system file object library. More...

Public Member Functions
	__construct ($path='', $file=null)
	get_mimeIcon ($size=32, $styles='')
	get_mimeIconURL ($size=32)
	download ($title=null)
	send ($title=null)
	md5 ($raw_output=false)
	get_contents ()
	get_base64Data ()

Public Attributes
	$filename
	File name. More...
	$path
	File path. More...
	$fullpath
	Full file path with file name. More...
	$exists
	File exists. More...
	$size
	File size in octet/byte. More...
	$hsize
	Human readable file size. More...
	$mime
	File mime. More...
	$type
	File type, first part of mime value. More...
	$ext
	File extension. More...
	$atime
	File last opening time. More...
	$mtime
	File last modification time. More...
	$ctime
	File inode change time. More...
	$mimedesc
	File mime description. More...
	$typedesc
	File type description. More...
	$moreinfos
	File additional information. More...

Private Member Functions
	get ()
	get_mime ()
	get_stat ()
	get_descriptions ()
	get_moreInfos ()
	get_imageInfos ()

Detailed Description

File system file object library.

Engine / Object Library

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.2.1

Date

Creation: Jun 2007

Modification: Jul 2025

Copyright

2007 - 2025 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. FSFile class.

Constructor & Destructor Documentation

__construct()

FSFile::__construct	(		$path = '',
			$file = null
	)

Class constructor.

Parameters

string	$path	the path to the file
string	$file	the file name

Member Function Documentation

get()

FSFile::get ( )

private

Load file description.

Returns

void

get_mime()

FSFile::get_mime ( )

private

Load file mime.

Returns

void

get_stat()

FSFile::get_stat ( )

private

Load file stats.

Returns

void

get_descriptions()

FSFile::get_descriptions ( )

private

Load file description.

Returns

void

get_moreInfos()

FSFile::get_moreInfos ( )

private

Load more information from file.

Returns

void

get_imageInfos()

FSFile::get_imageInfos ( )

private

Load more information from image file.

Returns

void

get_mimeIcon()

FSFile::get_mimeIcon	(		$size = 32,
			$styles = ''
	)

Return mime relative icon.

Parameters

int	$size
string	$styles

Returns

string

get_mimeIconURL()

FSFile::get_mimeIconURL

(

$size = 32

)

Return mime relative icon URL.

Parameters

int

$size

Returns

string

download()

FSFile::download

(

$title = null

)

Download file to client browser.

Parameters

string

$title

Returns

void

send()

FSFile::send

(

$title = null

)

Send file to client browser.

Parameters

string

$title

Returns

void

md5()

FSFile::md5

(

$raw_output = false

)

Return MD5 checksum of the file.

Parameters

boolean

$raw_output

Returns

string

get_contents()

FSFile::get_contents

(

)

Return file content.

Returns

string

get_base64Data()

FSFile::get_base64Data

(

)

Return file content as base64 data.

Returns

string

Member Data Documentation

$filename

string FSFile::$filename

File name.

$path

string FSFile::$path

File path.

$fullpath

string FSFile::$fullpath

Full file path with file name.

$exists

boolean FSFile::$exists

File exists.

$size

integer FSFile::$size

File size in octet/byte.

$hsize

string FSFile::$hsize

Human readable file size.

$mime

string FSFile::$mime

File mime.

$type

string FSFile::$type

File type, first part of mime value.

$ext

string FSFile::$ext

File extension.

$atime

integer FSFile::$atime

File last opening time.

$mtime

integer FSFile::$mtime

File last modification time.

$ctime

integer FSFile::$ctime

File inode change time.

$mimedesc

string FSFile::$mimedesc

File mime description.

$typedesc

string FSFile::$typedesc

File type description.

$moreinfos

array FSFile::$moreinfos

File additional information.

---

The documentation for this class was generated from the following file:

• CaMykS/engine/lib/object/FSFile.php.inc