PHP | disk_free_space 函数

Lasted 2020-12-30 19:28:16

disk_free_space 返回给定目录的可用空间。

disk_free_space() 函数将根据相应的文件系统或磁盘分区返回可用的字节数。如果函数处理错误返回 false。

如果传入的不是文件目录，会因操作系统不同返回值不一样。

函数定义

disk_free_space(string $directory):float

// 源文件位于：ext/standard/filestat.c
# 函数定义

static int php_disk_free_space(char *path, double *space) /* {{{ */
#if defined(WINDOWS) /* {{{ */
{
  ...
  if (GetDiskFreeSpaceExW(pathw, &FreeBytesAvailableToCaller, &TotalNumberOfBytes, &TotalNumberOfFreeBytes) == 0) {
    char *err = php_win_err();
    php_error_docref(NULL, E_WARNING, "%s", err);
    php_win_err_free(err);
    PHP_WIN32_IOUTIL_CLEANUP_W()
    return FAILURE;
  }

  *space = FreeBytesAvailableToCaller.HighPart * (double) (1ULL << 32)  + FreeBytesAvailableToCaller.LowPart;

  PHP_WIN32_IOUTIL_CLEANUP_W()

  return SUCCESS;
}
/* }}} */
#elif defined(OS2) /* {{{ */
{
  ...
  if (DosQueryFSInfo( drive ? drive - 64 : 0, FSIL_ALLOC, &fsinfo, sizeof( fsinfo ) ) == 0) {
    bytesfree = (double)fsinfo.cbSector * fsinfo.cSectorUnit * fsinfo.cUnitAvail;
    *space = bytesfree;
    return SUCCESS;
  }
  return FAILURE;
}
/* }}} */
#else /* {{{ if !defined(OS2) && !defined(WINDOWS) */
{
... 
#if defined(HAVE_SYS_STATVFS_H) && defined(HAVE_STATVFS)
  if (statvfs(path, &buf)) {
    php_error_docref(NULL, E_WARNING, "%s", strerror(errno));
    return FAILURE;
  }
  if (buf.f_frsize) {
    bytesfree = (((double)buf.f_bavail) * ((double)buf.f_frsize));
  } else {
    bytesfree = (((double)buf.f_bavail) * ((double)buf.f_bsize));
  }
#elif (defined(HAVE_SYS_STATFS_H) || defined(HAVE_SYS_MOUNT_H)) && defined(HAVE_STATFS)
  if (statfs(path, &buf)) {
    php_error_docref(NULL, E_WARNING, "%s", strerror(errno));
    return FAILURE;
  }
  bytesfree = (((double)buf.f_bsize) * ((double)buf.f_bavail));
#endif

  *space = bytesfree;
  return SUCCESS;
}
#endif

参数

directory - 文件系统目录或者磁盘分区。不能作用于远程文件，被检查的文件必须是可通过服务器的文件系统访问的。

返回值

float - 返回目录可用的字节数。失败时返回 false。

示例1: - 使用 disk_free_space() 函数获取给定目录的可用空间。

<?php
/**
 * PHP 使用 disk_free_space() 函数获取给定目录的可用空间。
 *
 * @since Version 1.0.0
 * @filesource
 */

// 获取目录的字节数
$bytes = disk_free_space("/data");

echo 'Available:: '.$bytes.PHP_EOL;
echo 'Available:: '.humanReadable($bytes).PHP_EOL;

// 友好显示字节数
function humanReadable($bytes) {
  $prefix = array('B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB');
  $base = 1024;
  $class = min((int)log($bytes , $base) , count($prefix) - 1);

  return sprintf('%1.2f' , $bytes / pow($base, $class)) . $prefix[$class];
}

Available:: 3378401280
Available:: 3.15GB