Class Env_FileList

Extended value that represents a list of uploaded files.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Value implements Core\Comparable, Core\Equality, Core\Identity

Core\Env_FileList implements ArrayAccess, Iterator

Namespace: Core
Package: Core\Env
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at Env.inc.php

Methods summary

`public`	# `__construct( string $key )` Parameters `$key` File upload input name. Since 3.1 Overrides `Core\Value::__construct`
`public integer`	# `count( )` Returns the number of uploaded files for the represented key. Returns the number of uploaded files for the represented key. Returns integer Number of uploaded files. Since 3.1
`public Core\Env_File`	# `current( )` Returns an instance for the current file (used by iterators). Returns an instance for the current file (used by iterators). Returns `Core\Env_File` Current file instance. Since 3.1 Implementation of `Iterator::current()`
`public`	# `filterIndices( )` Filters the internal indices list to filter unsuccessful file uploads. Filters the internal indices list to filter unsuccessful file uploads. Since 3.1
`public mixed`	# `key( )` Returns the index of the current file (used by iterators). Returns the index of the current file (used by iterators). Returns mixed Current index. Since 3.1 Implementation of `Iterator::key()`
`public boolean`	# `multipleFiles( )` Helper method to distinguish between multiple and single file uploads. Upon accessing the environment this method should be called on the returned object to test whether a single file has been uploaded and the object can be treated as such, or multiple files has been uploaded and the returned object is an iterator for all uploaded files. Helper method to distinguish between multiple and single file uploads. Upon accessing the environment this method should be called on the returned object to test whether a single file has been uploaded and the object can be treated as such, or multiple files has been uploaded and the returned object is an iterator for all uploaded files. Returns boolean `false`, if a single file is represented by this object, otherwise `true`. Since 3.1
`public`	# `next( )` Sets the internal pointer on the next file (used by iterators). Sets the internal pointer on the next file (used by iterators). Since 3.1 Implementation of `Iterator::next()`
`public boolean`	# `offsetExists( mixed $key )` Tests, whether a given file index exists. Tests, whether a given file index exists. Parameters `$key` File index to test for. Returns boolean `true`, if the file index exists, otherwise `false`. Since 3.1 Implementation of `ArrayAccess::offsetExists()`
`public Core\Env_File`	# `offsetGet( mixed $key )` Retrieves the file for a given index. Retrieves the file for a given index. Parameters `$key` File index to retrieve. Returns `Core\Env_File` Since 3.1 Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( mixed $key, mixed $value )` Unsupported. Unsupported. Parameters `$key` `$value` Since 3.1 Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( mixed $key )` Unsupported. Unsupported. Parameters `$key` Since 3.1 Implementation of `ArrayAccess::offsetUnset()`
`public`	# `rewind( )` Resets the internal pointer to the first file (used by iterators). Resets the internal pointer to the first file (used by iterators). Since 3.1 Implementation of `Iterator::rewind()`
`public boolean`	# `valid( )` Tests for validity of the current file index (used by iterators). Tests for validity of the current file index (used by iterators). Returns boolean `true`, if the current index is valid, otherwise `false`. Since 3.1 Implementation of `Iterator::valid()`

Constants summary

Constants inherited from Core\Value

Bit, Boolean, Float, Integer, LowercaseString, String, StringObject, UppercaseString

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected array`	`$_v_indices` The set of indices for the multiple files upload. The set of indices for the multiple files upload. Since 3.1	#
`protected`	`$_v_key` The `_FILES` set key this instance is derived from. The `_FILES` set key this instance is derived from. Since 3.1	#

Properties inherited from Core\Value

$_v_onSet, $_v_value

Magic properties

`public read-only integer`	`$count` Number of uploaded files.
`public read-only Core\Env_File`	`$current` Current file instance.
`public read-only array`	`$indices` Set of indices for the multiple files upload.
`public read-only mixed`	`$key` Upload input form key of file set.
`public read-only boolean`	`$multipleFiles` Status whether multiple files are represented.
`public read-only boolean`	`$valid` Status of current index validity.

Magic properties inherited from Core\Value

$bit, $bool, $float, $int, $isArray, $isBoolean, $isCallable, $isCallback, $isFloat, $isInteger, $isNull, $isNumeric, $isObject, $isOffset, $isResource, $isScalar, $isString, $onSet, $string, $stringObject, $value

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Interfaces

Exceptions

Constants

Class Env_FileList

Methods summary

Parameters

Since

Overrides

Returns

Since

Returns

Since

Implementation of

Since

Returns

Since

Implementation of

Returns

Since

Since

Implementation of

Parameters

Returns

Since

Implementation of

Parameters

Returns

Since

Implementation of

Parameters

Since

Implementation of

Parameters

Since

Implementation of

Since

Implementation of

Returns

Since

Implementation of

Methods inherited from Core\Value

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Value

Constants inherited from Core\Object

Properties summary

Since

Since

Properties inherited from Core\Value

Magic properties

Magic properties inherited from Core\Value

Magic properties inherited from Core\Object