files Class Reference

Files manipulation utilities. More...

Static Public Member Functions
static	scandir (string $directory, bool $order=true)
static	getExtension (string $filename)
static	getMimeType (string $filename)
static	mimeTypes ()
static	registerMimeTypes (array $types)
static	isDeletable (string $filename)
static	deltree (string $directory)
static	touch (string $filename)
static	makeDir (string $name, bool $recursive=false)
static	inheritChmod (string $file)
static	putContent (string $file, string $content)
static	size (int $size)
static	str2bytes (string $size)
static	uploadStatus (array $file)
static	getDirList (string $directory, array &$list=null)
static	tidyFileName (string $filename)

Static Public Attributes
static	$dir_mode = null
static	$mime_types

Detailed Description

Files manipulation utilities.

Member Function Documentation

scandir()

static scandir ( string  $directory, bool  $order = true  )

static

Directory scanning

Returns a directory child files and directories.

Parameters

string	$directory	Path to scan
boolean	$order	Order results

Returns

array

Referenced by adminConfigThemeDuctile\init(), isDeletable(), setUp(), and testScanDir().

getExtension()

static getExtension ( string  $filename )

static

File extension

Returns a file extension.

Parameters

string

$filename

File name

Returns

string

Referenced by getMimeType(), adminMediaList\mediaLine(), dcThemeEditor\sortFilesHelper(), and testExtension().

getMimeType()

static getMimeType ( string  $filename )

static

MIME type

Returns a file MIME type, based on static var $mime_types

Parameters

string

$filename

File name

Returns

string

References getExtension(), and mimeTypes().

Referenced by fileItem\__construct(), dcMedia\createFile(), blowupConfig\createImages(), dcMedia\getDir(), dcMedia\mediaFireRecreateEvent(), adminBlogTheme\process(), dcMedia\removeFile(), testGetMimeType(), and dcThemeConfig\uploadImage().

mimeTypes()

static mimeTypes ( )

static

MIME types

Returns all defined MIME types.

Returns

array

References $mime_types.

Referenced by getMimeType(), testMimeTypes(), and testRegisterMimeType().

registerMimeTypes()

static registerMimeTypes ( array  $types )

static

New MIME types

Append new MIME types to defined MIME types.

Parameters

array

$types

New MIME types.

isDeletable()

static isDeletable ( string  $filename )

static

Is a file or directory deletable.

Returns true if $f is a file or directory and is deletable.

Parameters

string

$filename

File or directory

Returns

boolean

References scandir().

Referenced by fileItem\__construct(), filemanager\removeDir(), filemanager\removeFile(), testDirIsDeletable(), and testFileIsDeletable().

deltree()

static deltree ( string  $directory )

static

Recursive removal

Remove recursively a directory.

Parameters

string

$directory

Directory patch

Returns

boolean

References deltree().

Referenced by dcThemes\cloneModule(), dcModules\deleteModule(), deltree(), dcCore\emptyTemplatesCache(), dcModules\installPackage(), adminLangs\process(), and testDeltree().

touch()

static touch ( string  $filename )

static

Touch file

Set file modification time to now.

Parameters

string

$filename

File to change

References touch().

Referenced by touch(), dcStoreReader\withCache(), and feedReader\withCache().

makeDir()

static makeDir ( string  $name, bool  $recursive = false  )

static

Directory creation.

Creates directory $f. If $r is true, attempts to create needed parents directories.

Parameters

string	$name	Directory to create
boolean	$recursive	Create parent directories

References inheritChmod(), makeDir(), and path\real().

Referenced by dcThemeConfig\canWriteCss(), dcThemeConfig\canWriteImages(), dcThemes\cloneModule(), dcUpdate\getVersionInfo(), dcModules\installPackage(), filemanager\makeDir(), makeDir(), adminCSPReport\process(), testMakeDir(), fileUnzip\testTargetDir(), dcStoreReader\withCache(), feedReader\withCache(), and dcThemeEditor\writeFile().

inheritChmod()

static inheritChmod ( string  $file )

static

Mode inheritage

Sets file or directory mode according to its parent.

Parameters

string

$file

File to change

Referenced by makeDir(), fileUnzip\putContent(), filemanager\uploadBits(), filemanager\uploadFile(), dcStoreReader\withCache(), and feedReader\withCache().

putContent()

static putContent ( string  $file, string  $content  )

static

Changes file content.

Writes $f_content into $f file.

Parameters

string	$file	File to edit
string	$content	Content to write

Returns

bool

size()

static size ( int  $size )

static

Human readable file size.

Parameters

integer

$size

Bytes

Returns

string

Referenced by attachmentAdminBehaviors\adminPostFormItems(), dcImportFlat\gui(), adminMediaList\mediaLine(), adminMedia\render(), adminBlowupConfig\render(), and testSize().

str2bytes()

static str2bytes ( string  $size )

static

Converts a human readable file size to bytes.

Parameters

string

$size

Size

Returns

float

Referenced by fileUnzip\memoryAllocate(), fileZip\memoryAllocate(), imageTools\memoryAllocate(), and testStr2Bytes().

uploadStatus()

static uploadStatus ( array  $file )

static

Upload status

Returns true if upload status is ok, throws an exception instead.

Parameters

array

$file

File array as found in $_FILES

Returns

boolean

Referenced by adminLangs\process(), adminMedia\process(), adminMediaItem\process(), adminBlogroll\process(), adminBlowupConfig\process(), dcImportFlat\process(), and testUploadStatus().

getDirList()

static getDirList ( string  $directory, array &  $list = null  )

static

Recursive directory scanning

Returns an array of a given directory's content. The array contains two arrays: dirs and files. Directory's content is fetched recursively.

Parameters

string	$directory	Directory name
array	$list	Contents array (leave it empty)

Returns

array

References getDirList().

Referenced by dcThemes\cloneModule(), getDirList(), and filemanager\getRootDirs().

tidyFileName()

static tidyFileName ( string  $filename )

static

Filename cleanup

Removes unwanted characters in a filename.

Parameters

string

$filename

Filename

Returns

string

References text\deaccent().

Referenced by dcMedia\makeDir(), adminMedia\process(), testTidyFilename(), dcMedia\updateFile(), dcMedia\uploadBits(), and dcMedia\uploadFile().

Field Documentation

$dir_mode

$dir_mode = null

static

Referenced by testInheritChmod().

$mime_types

$mime_types

static

Referenced by mimeTypes().

---

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

• inc/libs/clearbricks/common/lib.files.php