filesize

fileowner

Last updated: Fri, 24 Sep 2010

fileperms

(PHP 4, PHP 5)

fileperms — Gets file permissions

Description

int fileperms ( string $filename )

Gets permissions for the given file.

Parameters

filename: Path to the file.

Return Values

Returns the permissions on the file, or FALSE on failure.

Examples

Example #1 Display permissions as an octal value


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

The above example will output:

1777
0644

Example #2 Display full permissions


<?php
$perms = fileperms('/etc/passwd');

if (($perms & 0xC000) == 0xC000) {
    // Socket
    $info = 's';
} elseif (($perms & 0xA000) == 0xA000) {
    // Symbolic Link
    $info = 'l';
} elseif (($perms & 0x8000) == 0x8000) {
    // Regular
    $info = '-';
} elseif (($perms & 0x6000) == 0x6000) {
    // Block special
    $info = 'b';
} elseif (($perms & 0x4000) == 0x4000) {
    // Directory
    $info = 'd';
} elseif (($perms & 0x2000) == 0x2000) {
    // Character special
    $info = 'c';
} elseif (($perms & 0x1000) == 0x1000) {
    // FIFO pipe
    $info = 'p';
} else {
    // Unknown
    $info = 'u';
}

// Owner
$info .= (($perms & 0x0100) ? 'r' : '-');
$info .= (($perms & 0x0080) ? 'w' : '-');
$info .= (($perms & 0x0040) ?
            (($perms & 0x0800) ? 's' : 'x' ) :
            (($perms & 0x0800) ? 'S' : '-'));

// Group
$info .= (($perms & 0x0020) ? 'r' : '-');
$info .= (($perms & 0x0010) ? 'w' : '-');
$info .= (($perms & 0x0008) ?
            (($perms & 0x0400) ? 's' : 'x' ) :
            (($perms & 0x0400) ? 'S' : '-'));

// World
$info .= (($perms & 0x0004) ? 'r' : '-');
$info .= (($perms & 0x0002) ? 'w' : '-');
$info .= (($perms & 0x0001) ?
            (($perms & 0x0200) ? 't' : 'x' ) :
            (($perms & 0x0200) ? 'T' : '-'));

echo $info;
?>

The above example will output:

-rw-r--r--

Notes

Note: The results of this function are cached. See clearstatcache() for more details.

Tip

As of PHP 5.0.0, this function can also be used with some URL wrappers. Refer to List of Supported Protocols/Wrappers for a listing of which wrappers support stat() family of functionality.


Here is a small function I made : http://pastebin.com/iKky8Vtu

I was bored and I thought it could be useful.



mixed mkperms( string $perms [, bool return_as_string = false [, string $filename ] ] )

Returns permissions given a string in literal format and a filename.

If the file name is omitted, the permissions that the function will return are based on 000-permissions.

If return_as_string is set to true, the result will be output as a 644 format string. Otherwise it will return a string converted to base-10 for chmod.



Examples: 



<?php

echo mkperms('u+r', true), "\n"; // 400

echo mkperms('u+rwx,g+rw,o+x', true), "\n"; // 761



touch('myfile.txt'); // Create a file with any permissions

chmod('myfile.txt', mkperms('u=rwx,g=x,o=rw')); // myfile.txt is now at -rwx--xrw-



// Make a file and give it full permissions

touch('somefile.txt');

chmod('somefile.txt', 0777);

echo mkperms('g-w,o-rw', true, 'somefile.txt'); // 751

echo mkperms('u=rwx,g-r,o=-', true, 'somefile.txt'); // 730

// This way you can apply permissions to files

chmod('somefile.txt', mkperms('u=rwx,g-r,o=-', false, 'somefile.txt')); // somefile.txt is now at -rwx-wx---

?>



PS : sorry I had to put it on pastebin, or else it just made the note way too long.

jchris dot fillionr at kitware dot com
02-Apr-2009 12:11


Since the output of decoct( fileperms('.') ) is of the form: 40644



It seems the previous example is wrong, instead you should understand:



To get permissions formatted as "644":

<?php

echo substr(decoct( fileperms('.') ), 2);

?>



To get permissions formatted  as "0644":

<?php

echo substr(decoct( fileperms('.') ), 1);

?>

MartinAngermeier at gmx dot net
29-Oct-2008 09:37


An easy way to calculate fileperms to chmod is this:



substr(decoct(fileperms("test.html")),3);



Displays 666 or 777 (depends on chmod set).



substr(decoct(fileperms("test.html")),2);



Displays 0666 or 0777 and refers immediately to the number set with chmod();

eelco
10-Jul-2007 11:21


If you only want the permissions (lowest three octal numbers) you can use a bitwise AND to mask the bits:



<?php

fileperms($file) & 511; 

?>

paul2712 at gmail dot com
02-Jun-2007 06:08


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);

chinello at gmail dot com
25-Apr-2007 06:43


On Linux (not tested on Windows), if you want a chmod-like permissions, you can use this function:



<?php

function file_perms($file, $octal = false)

{

    if(!file_exists($file)) return false;



    $perms = fileperms($file);



    $cut = $octal ? 2 : 3;



    return substr(decoct($perms), $cut);

}

?>



Using it:



$ touch foo.bar

$ chmod 0754 foo.bar

<?php

echo file_perms('foo.bar'); // prints: 754

echo file_perms('foo.bar', true); // prints 0754

?>

add a note