Wikimedia\ParamValidator\Util\UploadedFileStream Class Reference

Implementation of StreamInterface for a file in $_FILES. More...

Inheritance diagram for Wikimedia\ParamValidator\Util\UploadedFileStream:

Collaboration diagram for Wikimedia\ParamValidator\Util\UploadedFileStream:

Public Member Functions
	__construct ( $filename)
	__destruct ()
	__toString ()
	close ()
	detach ()
	eof ()
	getContents ()
	getMetadata ( $key=null)
	getSize ()
	isReadable ()
	isSeekable ()
	isWritable ()
	read ( $length)
	rewind ()
	seek ( $offset, $whence=SEEK_SET)
	tell ()
	write ( $string)

Private Member Functions
	checkOpen ()
	Check if the stream is open.

Static Private Member Functions
static	quietCall (callable $func, array $args, $fail, $msg)
	Call, throwing on error.

Private Attributes
resource	$fp
	File handle.
int false null	$size = false
	File size.

Detailed Description

Implementation of StreamInterface for a file in $_FILES.

This exists so ParamValidator needn't depend on any specific PSR-7 implementation for a class implementing UploadedFileInterface. It shouldn't be used directly by other code.

Definition at line 21 of file UploadedFileStream.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\ParamValidator\Util\UploadedFileStream::__construct

(

$filename

)

Parameters

string

$filename

Definition at line 54 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\quietCall().

__destruct()

Wikimedia\ParamValidator\Util\UploadedFileStream::__destruct

(

)

Definition at line 68 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\close().

Member Function Documentation

__toString()

Wikimedia\ParamValidator\Util\UploadedFileStream::__toString

(

)

Definition at line 72 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\getContents(), and Wikimedia\ParamValidator\Util\UploadedFileStream\seek().

checkOpen()

Wikimedia\ParamValidator\Util\UploadedFileStream::checkOpen ( )

private

Check if the stream is open.

Exceptions

RuntimeException

if closed

Definition at line 62 of file UploadedFileStream.php.

Referenced by Wikimedia\ParamValidator\Util\UploadedFileStream\getContents(), Wikimedia\ParamValidator\Util\UploadedFileStream\getMetadata(), Wikimedia\ParamValidator\Util\UploadedFileStream\read(), Wikimedia\ParamValidator\Util\UploadedFileStream\seek(), Wikimedia\ParamValidator\Util\UploadedFileStream\tell(), and Wikimedia\ParamValidator\Util\UploadedFileStream\write().

close()

Wikimedia\ParamValidator\Util\UploadedFileStream::close

(

)

Definition at line 85 of file UploadedFileStream.php.

Referenced by Wikimedia\ParamValidator\Util\UploadedFileStream\__destruct().

detach()

Wikimedia\ParamValidator\Util\UploadedFileStream::detach

(

)

Definition at line 93 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\$fp.

eof()

Wikimedia\ParamValidator\Util\UploadedFileStream::eof

(

)

Definition at line 118 of file UploadedFileStream.php.

getContents()

Wikimedia\ParamValidator\Util\UploadedFileStream::getContents

(

)

Definition at line 154 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\checkOpen(), and Wikimedia\ParamValidator\Util\UploadedFileStream\quietCall().

Referenced by Wikimedia\ParamValidator\Util\UploadedFileStream\__toString().

getMetadata()

Wikimedia\ParamValidator\Util\UploadedFileStream::getMetadata

(

$key = null

)

Definition at line 159 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\checkOpen(), and Wikimedia\ParamValidator\Util\UploadedFileStream\quietCall().

getSize()

Wikimedia\ParamValidator\Util\UploadedFileStream::getSize

(

)

Definition at line 99 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\$size.

isReadable()

Wikimedia\ParamValidator\Util\UploadedFileStream::isReadable

(

)

Definition at line 145 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\$fp.

isSeekable()

Wikimedia\ParamValidator\Util\UploadedFileStream::isSeekable

(

)

Definition at line 123 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\$fp.

isWritable()

Wikimedia\ParamValidator\Util\UploadedFileStream::isWritable

(

)

Definition at line 136 of file UploadedFileStream.php.

quietCall()

static Wikimedia\ParamValidator\Util\UploadedFileStream::quietCall ( callable  $func, array  $args,   $fail,   $msg  )

staticprivate

Call, throwing on error.

Parameters

callable	$func	Callable to call
array	$args	Arguments
mixed	$fail	Failure return value
string	$msg	Message prefix

Returns

mixed

Exceptions

RuntimeException

if $func returns $fail

Definition at line 38 of file UploadedFileStream.php.

References $args.

Referenced by Wikimedia\ParamValidator\Util\UploadedFileStream\__construct(), Wikimedia\ParamValidator\Util\UploadedFileStream\getContents(), Wikimedia\ParamValidator\Util\UploadedFileStream\getMetadata(), Wikimedia\ParamValidator\Util\UploadedFileStream\read(), Wikimedia\ParamValidator\Util\UploadedFileStream\seek(), and Wikimedia\ParamValidator\Util\UploadedFileStream\tell().

read()

Wikimedia\ParamValidator\Util\UploadedFileStream::read

(

$length

)

Definition at line 149 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\checkOpen(), and Wikimedia\ParamValidator\Util\UploadedFileStream\quietCall().

rewind()

Wikimedia\ParamValidator\Util\UploadedFileStream::rewind

(

)

Definition at line 132 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\seek().

seek()

Wikimedia\ParamValidator\Util\UploadedFileStream::seek	(		$offset,
			$whence = SEEK_SET
	)

Definition at line 127 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\checkOpen(), and Wikimedia\ParamValidator\Util\UploadedFileStream\quietCall().

Referenced by Wikimedia\ParamValidator\Util\UploadedFileStream\__toString(), and Wikimedia\ParamValidator\Util\UploadedFileStream\rewind().

tell()

Wikimedia\ParamValidator\Util\UploadedFileStream::tell

(

)

Definition at line 113 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\checkOpen(), and Wikimedia\ParamValidator\Util\UploadedFileStream\quietCall().

write()

Wikimedia\ParamValidator\Util\UploadedFileStream::write

(

$string

)

Definition at line 140 of file UploadedFileStream.php.

References Wikimedia\ParamValidator\Util\UploadedFileStream\checkOpen().

Member Data Documentation

$fp

resource Wikimedia\ParamValidator\Util\UploadedFileStream::$fp

private

File handle.

Definition at line 24 of file UploadedFileStream.php.

Referenced by Wikimedia\ParamValidator\Util\UploadedFileStream\detach(), Wikimedia\ParamValidator\Util\UploadedFileStream\isReadable(), and Wikimedia\ParamValidator\Util\UploadedFileStream\isSeekable().

$size

int false null Wikimedia\ParamValidator\Util\UploadedFileStream::$size = false

private

File size.

False if not set yet.

Definition at line 27 of file UploadedFileStream.php.

Referenced by Wikimedia\ParamValidator\Util\UploadedFileStream\getSize().

---

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

• includes/libs/ParamValidator/Util/UploadedFileStream.php