PHP Класс FileUpload\FileUpload

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$callbacks array Callbacks to be run
$fileContainer FileUpload\File File Container instance
$filename_generator FileUpload\FileNameGenerator\FileNameGenerator Path resolver instance
$files array The array of uploaded files
$filesystem FileUpload\FileSystem\FileSystem File system instance
$logger Psr\Log\LoggerInterface Optional logger
$messages array Default messages
$pathresolver FileUpload\PathResolver\PathResolver Path resolver instance
$server array $_SERVER
$upload array $_FILES
$validators array Validators to be run

Открытые методы

Метод Описание
__construct ( array $upload, array $server, FileUpload\FileNameGenerator\FileNameGenerator $generator = null ) Construct this mother
addCallback ( string $event, Closure $callback ) Register callback for an event
addValidator ( FileUpload\Validator\Validator $v ) Add another validator
getFileContainer ( ) : FileUpload\File
getFileNameGenerator ( ) : FileUpload\FileNameGenerator\FileNameGenerator
getFileSystem ( ) : FileUpload\FileSystem\FileSystem
getFiles ( ) : array Returns an array of all uploaded files
getLogger ( ) : Psr\Log\LoggerInterface
getMessage ( integer $code ) : string Get an error message
getPathResolver ( ) : FileUpload\PathResolver\PathResolver
processAll ( ) : array Process entire submitted request
setFileNameGenerator ( FileUpload\FileNameGenerator\FileNameGenerator $fng ) Set filename generator
setFileSystem ( FileUpload\FileSystem\FileSystem $fs ) Set file system
setLogger ( Psr\Log\LoggerInterface $logger ) Set logger, optionally
setMessages ( array $new_messages ) Merge (overwrite) default error messages
setPathResolver ( FileUpload\PathResolver\PathResolver $pr ) Set path resolver

Защищенные методы

Метод Описание
fixIntegerOverflow ( integer $int ) : float Ensure correct value for big integers
getConfigBytes ( string $val ) : float Convert size format from PHP config into bytes
getContentLength ( ) : integer Content-length header
getContentRange ( ) : array Content-range header
getContentType ( ) : string Content-type header
getFilename ( string $name, string $type, integer $index, array $content_range, string $tmp_name ) : string Get filename for submitted filename
getFilesize ( string $path, boolean $clear_cache = false ) : float Get size of file
getNewHeaders ( array $files, array $content_range ) : array Generate headers for response
getSize ( ) : integer Request size
process ( string $tmp_name, string $name, integer $size, string $type, integer $error, integer $index, array $content_range = null ) : FileUpload\File Process single submitted file
processCallbacksFor ( string $eventName, FileUpload\File $file ) : void Process callbacks for a given event
trimFilename ( string $name, string $type, integer $index, array $content_range ) : string Remove harmful characters from filename
validate ( string $tmp_name, FileUpload\File $file, integer $error, integer $index ) : boolean Validate upload using some default rules, and custom validators added via addValidator. Default rules:

Приватные методы

Метод Описание
prepareMessages ( ) Converts $messages array into a hash with strings as keys This allows us to work with the keys and values as if it was a hash Which it really should be but, well, arrays in PHP, am I right?

Описание методов

__construct() публичный Метод

Construct this mother
public __construct ( array $upload, array $server, FileUpload\FileNameGenerator\FileNameGenerator $generator = null )
$upload array
$server array
$generator FileUpload\FileNameGenerator\FileNameGenerator

addCallback() публичный Метод

Register callback for an event
public addCallback ( string $event, Closure $callback )
$event string
$callback Closure

addValidator() публичный Метод

Add another validator
public addValidator ( FileUpload\Validator\Validator $v )
$v FileUpload\Validator\Validator

fixIntegerOverflow() защищенный Метод

Ensure correct value for big integers
protected fixIntegerOverflow ( integer $int ) : float
$int integer
Результат float

getConfigBytes() защищенный Метод

Convert size format from PHP config into bytes
protected getConfigBytes ( string $val ) : float
$val string
Результат float

getContentLength() защищенный Метод

Content-length header
protected getContentLength ( ) : integer
Результат integer

getContentRange() защищенный Метод

Content-range header
protected getContentRange ( ) : array
Результат array

getContentType() защищенный Метод

Content-type header
protected getContentType ( ) : string
Результат string

getFileContainer() публичный Метод

public getFileContainer ( ) : FileUpload\File
Результат FileUpload\File

getFileNameGenerator() публичный Метод

public getFileNameGenerator ( ) : FileUpload\FileNameGenerator\FileNameGenerator
Результат FileUpload\FileNameGenerator\FileNameGenerator

getFileSystem() публичный Метод

public getFileSystem ( ) : FileUpload\FileSystem\FileSystem
Результат FileUpload\FileSystem\FileSystem

getFilename() защищенный Метод

Get filename for submitted filename
protected getFilename ( string $name, string $type, integer $index, array $content_range, string $tmp_name ) : string
$name string
$type string
$index integer
$content_range array
$tmp_name string
Результат string

getFiles() публичный Метод

Returns an array of all uploaded files
public getFiles ( ) : array
Результат array

getFilesize() защищенный Метод

Get size of file
protected getFilesize ( string $path, boolean $clear_cache = false ) : float
$path string
$clear_cache boolean
Результат float

getLogger() публичный Метод

public getLogger ( ) : Psr\Log\LoggerInterface
Результат Psr\Log\LoggerInterface

getMessage() публичный Метод

Get an error message
public getMessage ( integer $code ) : string
$code integer
Результат string

getNewHeaders() защищенный Метод

Generate headers for response
protected getNewHeaders ( array $files, array $content_range ) : array
$files array
$content_range array
Результат array

getPathResolver() публичный Метод

public getPathResolver ( ) : FileUpload\PathResolver\PathResolver
Результат FileUpload\PathResolver\PathResolver

getSize() защищенный Метод

Request size
protected getSize ( ) : integer
Результат integer

process() защищенный Метод

Process single submitted file
protected process ( string $tmp_name, string $name, integer $size, string $type, integer $error, integer $index, array $content_range = null ) : FileUpload\File
$tmp_name string
$name string
$size integer
$type string
$error integer
$index integer
$content_range array
Результат FileUpload\File

processAll() публичный Метод

Process entire submitted request
public processAll ( ) : array
Результат array Files and response headers

processCallbacksFor() защищенный Метод

Process callbacks for a given event
protected processCallbacksFor ( string $eventName, FileUpload\File $file ) : void
$eventName string
$file FileUpload\File
Результат void

setFileNameGenerator() публичный Метод

Set filename generator
public setFileNameGenerator ( FileUpload\FileNameGenerator\FileNameGenerator $fng )
$fng FileUpload\FileNameGenerator\FileNameGenerator

setFileSystem() публичный Метод

Set file system
public setFileSystem ( FileUpload\FileSystem\FileSystem $fs )
$fs FileUpload\FileSystem\FileSystem

setLogger() публичный Метод

Set logger, optionally
public setLogger ( Psr\Log\LoggerInterface $logger )
$logger Psr\Log\LoggerInterface

setMessages() публичный Метод

Merge (overwrite) default error messages
public setMessages ( array $new_messages )
$new_messages array

setPathResolver() публичный Метод

Set path resolver
public setPathResolver ( FileUpload\PathResolver\PathResolver $pr )
$pr FileUpload\PathResolver\PathResolver

trimFilename() защищенный Метод

Remove harmful characters from filename
protected trimFilename ( string $name, string $type, integer $index, array $content_range ) : string
$name string
$type string
$index integer
$content_range array
Результат string

validate() защищенный Метод

- No PHP errors from $_FILES - File size permitted by PHP config
protected validate ( string $tmp_name, FileUpload\File $file, integer $error, integer $index ) : boolean
$tmp_name string
$file FileUpload\File
$error integer
$index integer
Результат boolean

Описание свойств

$callbacks защищенное свойство

Callbacks to be run
protected array $callbacks
Результат array

$fileContainer защищенное свойство

File Container instance
protected File,FileUpload $fileContainer
Результат FileUpload\File

$filename_generator защищенное свойство

Path resolver instance
protected FileNameGenerator,FileUpload\FileNameGenerator $filename_generator
Результат FileUpload\FileNameGenerator\FileNameGenerator

$files защищенное свойство

The array of uploaded files
protected array $files
Результат array

$filesystem защищенное свойство

File system instance
protected FileSystem,FileUpload\FileSystem $filesystem
Результат FileUpload\FileSystem\FileSystem

$logger защищенное свойство

Optional logger
protected LoggerInterface,Psr\Log $logger
Результат Psr\Log\LoggerInterface

$messages защищенное свойство

Default messages
protected array $messages
Результат array

$pathresolver защищенное свойство

Path resolver instance
protected PathResolver,FileUpload\PathResolver $pathresolver
Результат FileUpload\PathResolver\PathResolver

$server защищенное свойство

$_SERVER
protected array $server
Результат array

$upload защищенное свойство

$_FILES
protected array $upload
Результат array

$validators защищенное свойство

Validators to be run
protected array $validators
Результат array