1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. HttpFoundation
  7. \
  8. File
  9. \
  10. File

File

class File extends SplFileInfo

A file in the file system.

Methods

__construct(string $path, bool $checkPath = true)

Constructs a new file from the given path.

string|null
guessExtension()

Returns the extension based on the mime type.

string|null
getMimeType()

Returns the mime type of the file.

File
move(string $directory, string $name = null)

Moves the file to a new location.

getTargetFile($directory, $name = null)

No description

string
getName(string $name)

Returns locale independent base name of the given path.

Details

__construct(string $path, bool $checkPath = true)

Constructs a new file from the given path.

Parameters

string $path The path to the file
bool $checkPath Whether to check the path or not

Exceptions

FileNotFoundException If the given path is not a file

string|null guessExtension()

Returns the extension based on the mime type.

If the mime type is unknown, returns null.

This method uses the mime type as guessed by getMimeType() to guess the file extension.

Return Value

string|null The guessed extension or null if it cannot be guessed

See also

string|null getMimeType()

Returns the mime type of the file.

The mime type is guessed using a MimeTypeGuesser instance, which uses finfo(), mime_content_type() and the system binary "file" (in this order), depending on which of those are available.

Return Value

string|null The guessed mime type (e.g. "application/pdf")

See also

File move(string $directory, string $name = null)

Moves the file to a new location.

Parameters

string $directory The destination folder
string $name The new file name

Return Value

File A File object representing the new file

Exceptions

FileException if the target file could not be created

protected getTargetFile($directory, $name = null)

Parameters

$directory
$name

protected string getName(string $name)

Returns locale independent base name of the given path.

Parameters

string $name The new file name

Return Value

string containing