fileperms

(PHP 4, PHP 5, PHP 7, PHP 8)

fileperms — Возвращает информацию о правах на файл

Описание

function fileperms(string $filename): int|false

Функция возвращает информацию о правах доступа на файл.

Список параметров

filename: Путь к файлу.

Возвращаемые значения

Функция возвращает права доступа на файл в числовом виде. Младшие биты значения возврата аналогичны битам прав доступа, которые ожидает функция chmod(), однако, на большей части платформ значение также включит информацию о типе файла, путь к которому передали в параметр filename. Примеры показывают способ проверки конкретных прав и типов файлов в значении возврата на POSIX-системах, включая Linux и macOS.

Для локальных файлов возвращаемое значение — часть структуры st_mode, которую возвращает C-библиотечная функция stat(). Установка конкретных битов зависит от платформы. Об обработке в значении возврата битов, которые не относятся к правам доступа, рассказывает документация к конкретной платформе.

Функция возвращает false, если возникла ошибка.

Ошибки

При сбое функция генерирует ошибку уровня E_WARNING.

Примеры

Пример #1 Пример вывода прав доступа в восьмеричном представлении

<?php

echo substr(sprintf('%o', fileperms('/tmp')), -4);
echo substr(sprintf('%o', fileperms('/etc/passwd')), -4);

Результат выполнения приведённого примера:

1777
0644

Пример #2 Пример вывода полных прав доступа

<?php

$perms = fileperms('/etc/passwd');

switch ($perms & 0xF000) {
    case 0x1000: $info = 'p'; break; // FIFO-канал
    case 0x2000: $info = 'c'; break; // символьное устройство
    case 0x4000: $info = 'd'; break; // каталог
    case 0x6000: $info = 'b'; break; // блочное устройство
    case 0x8000: $info = '-'; break; // стандартный файл
    case 0xA000: $info = 'l'; break; // символическая ссылка (доступна при вызове функции lstat)
    case 0xC000: $info = 's'; break; // сокет

    // Неизвестный
    default: $info = 'u';
}

// Владелец
$setuid = $perms & 0x0800;
$info .= (($perms & 0x0100) ? 'r' : '-');
$info .= (($perms & 0x0080) ? 'w' : '-');
$info .= (($perms & 0x0040) ? ($setuid ? 's' : 'x') : ($setuid ? 'S' : '-'));

// Группа
$setgid = $perms & 0x0400;
$info .= (($perms & 0x0020) ? 'r' : '-');
$info .= (($perms & 0x0010) ? 'w' : '-');
$info .= (($perms & 0x0008) ? ($setgid ? 's' : 'x') : ($setgid ? 'S' : '-'));

// Остальные
$sticky = $perms & 0x0200;
$info .= (($perms & 0x0004) ? 'r' : '-');
$info .= (($perms & 0x0002) ? 'w' : '-');
$info .= (($perms & 0x0001) ? ($sticky ? 't' : 'x') : ($sticky ? 'T' : '-'));

echo $info;

Результат выполнения приведённого примера:

-rw-r--r--

Примечания

Замечание:
Результаты функции кешируются. Подробнее о кешировании рассказывает описание функции clearstatcache().

Подсказка

Начиная с PHP 5.0.0 функция научилась работать с отдельными URL-обёртками. Список обёрток, которые поддерживаются семейством функций stat(), приводит раздел «Протоколы и обёртки».

Смотрите также

chmod() - Изменяет режим доступа к файлу
is_readable() - Определяет существование файла и доступен ли он для чтения
stat() - Возвращает информацию о файле

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 4 notes

down

coolmic at example dot com ¶

13 years ago

Don't use substr, use bit operator
<?php
decoct(fileperms($file) & 0777); // return "755" for example
?>

If you want to compare permission
<?php
0755 === (fileperms($file) & 0777);
?>

down

admin at torntech dot com ¶

14 years ago

This may not be immediately apparent to some, but you can use octdec( $octal_value ) to match the permissions retrieved by file perms

<?php

//assumes file has 2770 permissions
$perm= fileperms( __FILE__ ); 
$bit = "102770";

printf( "%s\n", octdec( $bit ) );
printf( "%s\n", $perm);

?>

down

chris at ocproducts dot com ¶

6 years ago

Windows has a very different file permission model to Unix and integrates them only minimally.

Here's how Windows calculates the bitmask...

u+w/g+w/o+w is set based on whether the file has the read only flag.

u+r/g+w/o+w is always set.

u+x/g+x/o+x is set based on whether $filename is an inherently executable file (e.g. bat) or a directory.

Windows isn't integrating its ACLs at all.

Here's the source of all this: https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/stat-functions?view=vs-2019 (but it doesn't provide many details)

down

paul2712 at gmail dot com ¶

19 years ago

Do not forget: clearstatcache();
==============================
 
When ever you make a:

mkdir($dstdir, 0770 ))

or a:

chmod($dstdir, 0774 ); 

You have to call:

clearstatcache();

before you can call:

fileperms($dstdir);

＋Добавить