class UploadedFile extends UploadedFile (View source)

Traits

Properties

protected string|null $hashName

The cache copy of the file's hash name.

from  FileHelpers
static protected array $macros

The registered string macros.

from  Macroable

Methods

string
path()

Get the fully qualified path to the file.

string
extension()

Get the file's extension.

string
hashName(string|null $path = null)

Get a filename for the file.

array|null
dimensions()

Get the dimensions of the image (if applicable).

static void
macro(string $name, object|callable $macro)

Register a custom macro.

static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

static void
flushMacros()

Flush the existing macros.

static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

static FileFactory
fake()

Begin creating a new file fake.

string|false
store(string $path = '', array|string $options = [])

Store the uploaded file on a filesystem disk.

string|false
storePublicly(string $path = '', array|string $options = [])

Store the uploaded file on a filesystem disk with public visibility.

string|false
storePubliclyAs(string $path, array|string|null $name = null, array|string $options = [])

Store the uploaded file on a filesystem disk with public visibility.

string|false
storeAs(string $path, string|array $name = null, array|string $options = [])

Store the uploaded file on a filesystem disk.

false|string
get()

Get the contents of the uploaded file.

string
clientExtension()

Get the file's extension supplied by the client.

static UploadedFile
createFromBase(UploadedFile $file, bool $test = false)

Create a new file instance from a base instance.

array
parseOptions(array|string $options)

Parse and format the given options.

Details

string path()

Get the fully qualified path to the file.

Return Value

string

string extension()

Get the file's extension.

Return Value

string

string hashName(string|null $path = null)

Get a filename for the file.

Parameters

string|null $path

Return Value

string

array|null dimensions()

Get the dimensions of the image (if applicable).

Return Value

array|null

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static FileFactory fake()

Begin creating a new file fake.

Return Value

FileFactory

string|false store(string $path = '', array|string $options = [])

Store the uploaded file on a filesystem disk.

Parameters

string $path
array|string $options

Return Value

string|false

string|false storePublicly(string $path = '', array|string $options = [])

Store the uploaded file on a filesystem disk with public visibility.

Parameters

string $path
array|string $options

Return Value

string|false

string|false storePubliclyAs(string $path, array|string|null $name = null, array|string $options = [])

Store the uploaded file on a filesystem disk with public visibility.

Parameters

string $path
array|string|null $name
array|string $options

Return Value

string|false

string|false storeAs(string $path, string|array $name = null, array|string $options = [])

Store the uploaded file on a filesystem disk.

Parameters

string $path
string|array $name
array|string $options

Return Value

string|false

false|string get()

Get the contents of the uploaded file.

Return Value

false|string

Exceptions

FileNotFoundException

string clientExtension()

Get the file's extension supplied by the client.

Return Value

string

static UploadedFile createFromBase(UploadedFile $file, bool $test = false)

Create a new file instance from a base instance.

Parameters

UploadedFile $file
bool $test

Return Value

UploadedFile

protected array parseOptions(array|string $options)

Parse and format the given options.

Parameters

array|string $options

Return Value

array