1. class
  2. Illuminate
  3. \
  4. Http
  5. \
  6. Testing
  7. \
  8. File

File

class File extends UploadedFile

Traits

FileHelpers
Macroable

Properties

protected string $hashName

The cache copy of the file's hash name.

 from  FileHelpers
static protected array $macros

The registered string macros.

 from  Macroable
string $name

The name of the file.
resource $tempFile

The temporary file resource.
int $sizeToReport

The "size" to report.

Methods

string
path()

Get the fully qualified path to the file.

from  FileHelpers
string
extension()

Get the file's extension.

from  FileHelpers
string
clientExtension()

Get the file's extension supplied by the client.

from  FileHelpers
string
hashName(string $path = null)

Get a filename for the file.

from  FileHelpers
static void
macro(string $name, callable $macro)

Register a custom macro.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

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

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
static FileFactory
fake()

Begin creating a new file fake.

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

Store the uploaded file on a filesystem disk.

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

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

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

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

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

Store the uploaded file on a filesystem disk.

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

Create a new file instance from a base instance.

from  UploadedFile
array
parseOptions(array|string $options)

Parse and format the given options.

from  UploadedFile
void
__construct(string $name, resource $tempFile)

Create a new file instance.

static File
create(string $name, int $kilobytes = 0)

Create a new fake file.

static File
image(string $name, int $width = 10, int $height = 10)

Create a new fake image.

$this
size(int $kilobytes)

Set the "size" of the file in kilobytes.

int
getSize()

Get the size of the file.

string
getMimeType()

Get the MIME type for the file.

string
tempFilePath()

Get the path to the temporary file.

Details

in FileHelpers at line 21
string path()

Get the fully qualified path to the file.

Return Value

string

in FileHelpers at line 31
string extension()

Get the file's extension.

Return Value

string

in FileHelpers at line 41
string clientExtension()

Get the file's extension supplied by the client.

Return Value

string

in FileHelpers at line 52
string hashName(string $path = null)

Get a filename for the file.

Parameters

string $path

Return Value

string

in Macroable at line 24
static void macro(string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line 35
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 49
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 71
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in UploadedFile at line 20
static FileFactory fake()

Begin creating a new file fake.

Return Value

FileFactory

in UploadedFile at line 32
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

in UploadedFile at line 44
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

in UploadedFile at line 61
string|false storePubliclyAs(string $path, string $name, array|string $options = [])

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

Parameters

string $path
string $name
array|string $options

Return Value

string|false

in UploadedFile at line 78
string|false storeAs(string $path, string $name, array|string $options = [])

Store the uploaded file on a filesystem disk.

Parameters

string $path
string $name
array|string $options

Return Value

string|false

in UploadedFile at line 96
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

in UploadedFile at line 114
protected array parseOptions(array|string $options)

Parse and format the given options.

Parameters

array|string $options

Return Value

array

at line 37
void __construct(string $name, resource $tempFile)

Create a new file instance.

Parameters

string $name
resource $tempFile

Return Value

void

at line 55
static File create(string $name, int $kilobytes = 0)

Create a new fake file.

Parameters

string $name
int $kilobytes

Return Value

File

at line 68
static File image(string $name, int $width = 10, int $height = 10)

Create a new fake image.

Parameters

string $name
int $width
int $height

Return Value

File

at line 79
$this size(int $kilobytes)

Set the "size" of the file in kilobytes.

Parameters

int $kilobytes

Return Value

$this

at line 91
int getSize()

Get the size of the file.

Return Value

int

at line 101
string getMimeType()

Get the MIME type for the file.

Return Value

string

at line 111
protected string tempFilePath()

Get the path to the temporary file.

Return Value

string