function file_save_data in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/file/file.module \file_save_data()

Saves a file to the specified destination and creates a database entry.

Parameters

string $data: A string containing the contents of the file.

string $destination: A string containing the destination URI. This must be a stream wrapper URI. If no value is provided, a randomized name will be generated and the file will be saved using Drupal's default files scheme, usually "public://".

int $replace: Replace behavior when the destination file already exists:

• FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with the destination name exists then its database entry will be updated. If no database entry is found then a new one will be created.
• FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is unique.
• FILE_EXISTS_ERROR - Do nothing and return FALSE.

Return value

\Drupal\file\FileInterface A file entity, or FALSE on error.

See also

file_unmanaged_save_data()

8 calls to file_save_data()

FileItem::generateSampleValue in core/modules/file/src/Plugin/Field/FieldType/FileItem.php

Generates placeholder field values.

SaveDataTest::testExistingError in core/modules/file/src/Tests/SaveDataTest.php

Test that file_save_data() fails overwriting an existing file.

SaveDataTest::testExistingRename in core/modules/file/src/Tests/SaveDataTest.php

Test file_save_data() when renaming around an existing file.

SaveDataTest::testExistingReplace in core/modules/file/src/Tests/SaveDataTest.php

Test file_save_data() when replacing an existing file.

SaveDataTest::testWithFilename in core/modules/file/src/Tests/SaveDataTest.php

Test the file_save_data() function when a filename is provided.

... See full list

File

core/modules/file/file.module, line 481

Defines a "managed_file" Form API field and a "file" field for Field module.

Code

function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  $user = \Drupal::currentUser();
  if (empty($destination)) {
    $destination = file_default_scheme() . '://';
  }
  if (!file_valid_uri($destination)) {
    \Drupal::logger('file')
      ->notice('The data could not be saved because the destination %destination is invalid. This may be caused by improper use of file_save_data() or a missing stream wrapper.', array(
      '%destination' => $destination,
    ));
    drupal_set_message(t('The data could not be saved because the destination is invalid. More information is available in the system log.'), 'error');
    return FALSE;
  }
  if ($uri = file_unmanaged_save_data($data, $destination, $replace)) {

    // Create a file entity.
    $file = entity_create('file', array(
      'uri' => $uri,
      'uid' => $user
        ->id(),
      'status' => FILE_STATUS_PERMANENT,
    ));

    // If we are replacing an existing file re-use its database record.
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array(
        'uri' => $uri,
      ));
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $file->fid = $existing
          ->id();
        $file
          ->setOriginalId($existing
          ->id());
        $file
          ->setFilename($existing
          ->getFilename());
      }
    }
    elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
      $file
        ->setFilename(drupal_basename($destination));
    }
    $file
      ->save();
    return $file;
  }
  return FALSE;
}