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

File

class File extends UploadedFile (View source)

Traits

FileHelpers
Macroable

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
string $name

The name of the file.
resource $tempFile

The temporary file resource.
int $sizeToReport

The "size" to report.
string|null $mimeTypeToReport

The MIME type 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
hashName(string|null $path = null)

Get a filename for the file.

from  FileHelpers
array|null
dimensions()

Get the dimensions of the image (if applicable).

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

Register a custom macro.

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

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

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, array|string|null $name = null, array|string $options = [])

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

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

Store the uploaded file on a filesystem disk.

from  UploadedFile
false|string
get()

Get the contents of the uploaded file.

from  UploadedFile
string
clientExtension()

Get the file's extension supplied by the client.

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
__construct(string $name, resource $tempFile)

Create a new file instance.

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

Create a new fake file.

static File
createWithContent(string $name, string $content)

Create a new fake file with content.

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.

$this
mimeType(string $mimeType)

Set the "MIME type" for the file.

string
getMimeType()

Get the MIME type of 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 42
string hashName(string|null $path = null)

Get a filename for the file.

Parameters

string|null $path

Return Value

string

in FileHelpers at line 62
array|null dimensions()

Get the dimensions of the image (if applicable).

Return Value

array|null

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

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

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
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 112
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 22
static FileFactory fake()

Begin creating a new file fake.

Return Value

FileFactory

in UploadedFile at line 34
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 46
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 63
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

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

in UploadedFile at line 106
false|string get()

Get the contents of the uploaded file.

Return Value

false|string

Exceptions

FileNotFoundException

in UploadedFile at line 120
string clientExtension()

Get the file's extension supplied by the client.

Return Value

string

in UploadedFile at line 132
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 149
protected array parseOptions(array|string $options)

Parse and format the given options.

Parameters

array|string $options

Return Value

array

at line 43
__construct(string $name, resource $tempFile)

Create a new file instance.

Parameters

string $name
resource $tempFile

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

Create a new fake file.

Parameters

string $name
string|int $kilobytes

Return Value

File

at line 73
static File createWithContent(string $name, string $content)

Create a new fake file with content.

Parameters

string $name
string $content

Return Value

File

at line 86
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 97
$this size(int $kilobytes)

Set the "size" of the file in kilobytes.

Parameters

int $kilobytes

Return Value

$this

at line 109
int getSize()

Get the size of the file.

Return Value

int

at line 120
$this mimeType(string $mimeType)

Set the "MIME type" for the file.

Parameters

string $mimeType

Return Value

$this

at line 132
string getMimeType()

Get the MIME type of the file.

Return Value

string

at line 142
protected string tempFilePath()

Get the path to the temporary file.

Return Value

string