class File

A file in the file system.

@author Bernhard Schussek <bschussek@gmail.com>

@api

Hierarchy

  • class \Symfony\Component\HttpFoundation\File\File extends \Symfony\Component\HttpFoundation\File\SplFileInfo

Expanded class hierarchy of File

5 files declare their use of File
BinaryFileResponse.php in drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/BinaryFileResponse.php
FileTest.php in drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Tests/File/FileTest.php
FileValidator.php in drupal/core/vendor/symfony/validator/Symfony/Component/Validator/Constraints/FileValidator.php
FileValidatorObjectTest.php in drupal/core/vendor/symfony/validator/Symfony/Component/Validator/Tests/Constraints/FileValidatorObjectTest.php
MimeTypeTest.php in drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Tests/File/MimeType/MimeTypeTest.php
33 string references to 'File'
DirectoryTest::testFileCheckDirectoryHandling in drupal/core/modules/system/lib/Drupal/system/Tests/File/DirectoryTest.php
Test directory handling functions.
DirectoryTest::testFileCheckLocalDirectoryHandling in drupal/core/modules/system/lib/Drupal/system/Tests/File/DirectoryTest.php
Test local directory handling functions.
DirectoryTest::testFileCreateNewFilepath in drupal/core/modules/system/lib/Drupal/system/Tests/File/DirectoryTest.php
This will take a directory and path, and find a valid filepath that is not taken by another file.
DirectoryTest::testFileDestination in drupal/core/modules/system/lib/Drupal/system/Tests/File/DirectoryTest.php
This will test the filepath for a destination based on passed flags and whether or not the file exists.
field.field.field_image.yml in drupal/core/profiles/standard/config/field.field.field_image.yml
drupal/core/profiles/standard/config/field.field.field_image.yml

... See full list

File

drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/File/File.php, line 26

Namespace

Symfony\Component\HttpFoundation\File
View source
class File extends \SplFileInfo {

  /**
   * Constructs a new file from the given path.
   *
   * @param string  $path      The path to the file
   * @param Boolean $checkPath Whether to check the path or not
   *
   * @throws FileNotFoundException If the given path is not a file
   *
   * @api
   */
  public function __construct($path, $checkPath = true) {
    if ($checkPath && !is_file($path)) {
      throw new FileNotFoundException($path);
    }
    parent::__construct($path);
  }

  /**
   * 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 string|null The guessed extension or null if it cannot be guessed
   *
   * @api
   *
   * @see ExtensionGuesser
   * @see getMimeType()
   */
  public function guessExtension() {
    $type = $this
      ->getMimeType();
    $guesser = ExtensionGuesser::getInstance();
    return $guesser
      ->guess($type);
  }

  /**
   * 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 string|null The guessed mime type (i.e. "application/pdf")
   *
   * @see MimeTypeGuesser
   *
   * @api
   */
  public function getMimeType() {
    $guesser = MimeTypeGuesser::getInstance();
    return $guesser
      ->guess($this
      ->getPathname());
  }

  /**
   * Returns the extension of the file.
   *
   * \SplFileInfo::getExtension() is not available before PHP 5.3.6
   *
   * @return string The extension
   *
   * @api
   */
  public function getExtension() {
    return pathinfo($this
      ->getBasename(), PATHINFO_EXTENSION);
  }

  /**
   * Moves the file to a new location.
   *
   * @param string $directory The destination folder
   * @param string $name      The new file name
   *
   * @return File A File object representing the new file
   *
   * @throws FileException if the target file could not be created
   *
   * @api
   */
  public function move($directory, $name = null) {
    $target = $this
      ->getTargetFile($directory, $name);
    if (!@rename($this
      ->getPathname(), $target)) {
      $error = error_get_last();
      throw new FileException(sprintf('Could not move the file "%s" to "%s" (%s)', $this
        ->getPathname(), $target, strip_tags($error['message'])));
    }
    @chmod($target, 0666 & ~umask());
    return $target;
  }
  protected function getTargetFile($directory, $name = null) {
    if (!is_dir($directory)) {
      if (false === @mkdir($directory, 0777, true)) {
        throw new FileException(sprintf('Unable to create the "%s" directory', $directory));
      }
    }
    elseif (!is_writable($directory)) {
      throw new FileException(sprintf('Unable to write in the "%s" directory', $directory));
    }
    $target = $directory . DIRECTORY_SEPARATOR . (null === $name ? $this
      ->getBasename() : $this
      ->getName($name));
    return new File($target, false);
  }

  /**
   * Returns locale independent base name of the given path.
   *
   * @param string $name The new file name
   *
   * @return string containing
   */
  protected function getName($name) {
    $originalName = str_replace('\\', '/', $name);
    $pos = strrpos($originalName, '/');
    $originalName = false === $pos ? $originalName : substr($originalName, $pos + 1);
    return $originalName;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
File::getExtension public function Returns the extension of the file.
File::getMimeType public function Returns the mime type of the file.
File::getName protected function Returns locale independent base name of the given path.
File::getTargetFile protected function
File::guessExtension public function Returns the extension based on the mime type.
File::move public function Moves the file to a new location. 1
File::__construct public function Constructs a new file from the given path. 1