FbScanDir Class Reference
[FileBrowser]

Scan directory for files and directories and sort list by desired column. More...

List of all members.

Public Member Functions
	__construct ($dir)
	Scan directory for files and directories and sort list by desired column.
	currentSort ()
	Current sort string.
	dirList ()
	Sorted directory list.
	fileList ()
	Sorted file-only list.
	setLocale ($l10n)
	Set localization for visible output.
	sortLinkArray ()
	Build array of visible file list table headers.
Static Public Member Functions
static	mtimeDateToString ($timeStamp)
	Convert file's last modification timestamp date to human readable format.
static	mtimeTimeToString ($timeStamp)
	Convert file's last modification timestamp time to human readable format.
static	mtimeToString ($timeStamp)
	Convert file's last modification timestamp to human readable format.
static	sizeToString ($countOfBytes)
	Convert file size to human readable format.

---

Detailed Description

Scan directory for files and directories and sort list by desired column.

Definition at line 13 of file FbScanDir.class.php.

---

Constructor & Destructor Documentation

FbScanDir::__construct

(

$

dir

)

Scan directory for files and directories and sort list by desired column.

Parameters:

dir

Directory to scan.

Exceptions:

ExceptionNotFound

Exception is thrown when directory not exists.

Definition at line 23 of file FbScanDir.class.php.

---

Member Function Documentation

FbScanDir::currentSort

(

)

Current sort string.

Note:

Do not call this method static!

Definition at line 68 of file FbScanDir.class.php.

Referenced by sortLinkArray().

FbScanDir::dirList

(

)

Sorted directory list.

Each array item is associative array of:

• 'name' => directory name (relative)
• 'mtime' => file last modification as unix timestamp

  Returns:

  Return directory list as array.

Definition at line 161 of file FbScanDir.class.php.

FbScanDir::fileList

(

)

Sorted file-only list.

Each array item is associative array of:

• 'name' => file name (relative)
• 'size' => file size in bytes
• 'mtime' => file last modification as unix timestamp

  Returns:

  Return file list as array.

Definition at line 173 of file FbScanDir.class.php.

static FbScanDir::mtimeDateToString

(

$

timeStamp

)

[static]

Convert file's last modification timestamp date to human readable format.

Parameters:

timeStamp

File's last modification as unix timestamp.

Returns:

Return File's last modification date as string.

Definition at line 210 of file FbScanDir.class.php.

static FbScanDir::mtimeTimeToString

(

$

timeStamp

)

[static]

Convert file's last modification timestamp time to human readable format.

Parameters:

timeStamp

File's last modification as unix timestamp.

Returns:

Return File's last modification time as string.

Definition at line 219 of file FbScanDir.class.php.

static FbScanDir::mtimeToString

(

$

timeStamp

)

[static]

Convert file's last modification timestamp to human readable format.

Parameters:

timeStamp

File's last modification as unix timestamp.

Returns:

Return File's last modification as string.

Definition at line 201 of file FbScanDir.class.php.

FbScanDir::setLocale

(

$

l10n

)

Set localization for visible output.

Parameters:

l10n

Reference to initialized L10n object.

Definition at line 61 of file FbScanDir.class.php.

static FbScanDir::sizeToString

(

$

countOfBytes

)

[static]

Convert file size to human readable format.

Parameters:

countOfBytes

File size in bytes.

Returns:

Return file size converted to string.

Definition at line 182 of file FbScanDir.class.php.

FbScanDir::sortLinkArray

(

)

Build array of visible file list table headers.

Returns:

Return prepared array for FileBrowser.tpl Smarty template.

Definition at line 75 of file FbScanDir.class.php.

References currentSort().

Here is the call graph for this function:

---

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

• lib/FbScanDir.class.php

---