FileUloader Class Reference

Public Member Functions
	__construct ($baseDir, $params=array())
	getBasedir ()
	run ($files, $multiply=false)
	generateFileName ($origFileName, $newName=null)

Static Public Member Functions
static	getSafeFileName ($name)

Static Public Attributes
static	$VERSION = '1.0'

Protected Member Functions
	setBasedir ($basedir)
	removeEmptyFields ($data)
	checkFileSize ($file_size)
	let_to_num ($v)
	checkFileExtension ($file)

Protected Attributes
	$baseDir
	$params

Static Protected Attributes
static	$BANNED_EXTENSIONS = array('php','php3','php4','php5','inc')
static	$DEFAULT_BASEDIR = '/upload/temp/'

Constructor & Destructor Documentation

__construct()

__construct	(		$baseDir,
			$params = array()
	)

Konstruktor

pokud bude $params zadano:
$params['maxFileSize'] - maximalni velikost uploadovaneho suboru v bajtech
$params['checkFileExtension'] - [true | false] - pokud se maji kontrolovat podezdrele pripony souboru. Defaultne zapnute
$params['addTimeStamp'] - [true | false] - pokud se ma k nazvu souboru pripojit jednoznacne cislo (unix time stamp). Defaultne vypnuto.
$params['newName'] - {[cislo][hodnota]} jmena, pod kterym budou soubory ulozeny (jmeno je prohnano pres validator a "skodlive" znaky budou nahrazeny "-"). Dale je potreba, aby pole zacinalo od 0, tj. aby "cislo" prvniho prvku pole byla 0.
$params['acceptedExtensions'] - pole s priponami akceptovanych souboru, napr.: array('jpg', 'png')

Nebude-li zadan newName, pouzije se puvodni nazev souboru.
Nebude-li zadan $baseDir, pouzije se defaultne self::$DEFAULT_BASEDIR.

Parameters

string	$baseDir	- zakladni adresar
array	$params	- nepovinna polozka, umoznujici nektera dalsi nastaveni. public

Member Function Documentation

checkFileExtension()

checkFileExtension (   $file )

protected

Kontroluje, jestli uploadovany soubor nema zakazanou priponu

Parameters

type

$file

Exceptions

checkFileSize()

checkFileSize (   $file_size )

protected

Zjisti, jestli upladovany soubor neni moc veliky

Parameters

type

$file_size

Exceptions

generateFileName()

generateFileName	(		$origFileName,
			$newName = null
	)

Vygeneruje nazev souboru, pod kterym bude ulozen

Parameters

string	$origFileName	- nazev puvodniho souboru
string	$newName	- nazev noveho souboru

Returns

string

getBasedir()

getBasedir

(

)

funkce vraci zakladni adresar pro upload souboru

Returns

string public

getSafeFileName()

static getSafeFileName (   $name )

static

funkce vraci "bezpecny" nazev souboru a prevede jej na mala pismena

Parameters

string

$name

Returns

string protected

let_to_num()

let_to_num (   $v )

protected

This function transforms the php.ini notation for numbers (like '2M') to an integer (2*1024*1024 in this case)

Parameters

int

$v

Returns

int protected

removeEmptyFields()

removeEmptyFields (   $data )

protected

smaze vsecka prazdna pole. Dobre predefinovat v potomkovi, pokud se uploadovane soubory predavaji v poli. Proste si pripadne parametry preskladame tak, jak je ocekava metoda move();

Parameters

array

$data

Returns

mixed protected

run()

run	(		$files,
			$multiply = false
	)

Funkce na upload souboru.

$files - uploadovane soubory vraci pole $ret[uploaded][counter]['origName'] - puvodni jmeno souboru
$ret[uploaded][counter]['newName'] - nove jmeno souboru (je-li zadano)
$ret[uploaded][counter]['inputName']
V pripade selhani uploadu souboru:
$ret[failed][_counter][file] - puvodni nazev souboru $ret[failed][_counter][error] - chybova hlaska

Parameters

array	$files
boolean	$multiply	- jestli se jedna o nahravani jednoho nebo vice souboru, defaultne false public

Returns

array

setBasedir()

setBasedir (   $basedir )

protected

funkce nastavuje zakladni adresar pro upload souboru

Parameters

string

$basedir

Returns

no return value public

Member Data Documentation

$BANNED_EXTENSIONS

$BANNED_EXTENSIONS = array('php','php3','php4','php5','inc')

staticprotected

$baseDir

$baseDir

protected

$DEFAULT_BASEDIR

$DEFAULT_BASEDIR = '/upload/temp/'

staticprotected

$params

$params

protected

$VERSION

$VERSION = '1.0'

static

---

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

• FileUloader.php