PHP Function Reference

PHP streamWrapper stream_stat() Method



The PHP streamWrapper::stream_stat() method retrieves information about a file resource. This method is called in response to fstat() function.

Syntax

public streamWrapper::stream_stat()

Parameters

No parameter is required.

Return Value

In case of error, returns false, otherwise returns an array with the following elements:

NumericAssociativeDescription
0devdevice number
1inoinode number
2modeinode protection mode
3nlinknumber of links
4uiduserid of owner
5gidgroupid of owner
6rdevdevice type, if inode device
7sizesize in bytes
8atimetime of last access (Unix timestamp)
9mtimetime of last modification (Unix timestamp)
10ctimetime of last inode change (Unix timestamp)
11blksizeblocksize of filesystem IO
12blocksnumber of 512-byte blocks allocated

The value of mode contains information read by several functions. When written in octal, starting from the right, the first three digits are returned by chmod(). The next digit is ignored by PHP. The next two digits indicate the file type. For example a regular file could be 0100644 and a directory could be 0040755.

mode file types

mode in octalDescription
0140000socket
0120000link
0100000regular file
0060000block device
0040000directory
0020000character device
0010000fifo

Note: As PHP's integer type is signed and many platforms use 32bit integers, some filesystem functions may return unexpected results for files which are larger than 2GB.

Exceptions

Emits E_WARNING if call to this method fails (i.e. not implemented).


❮ PHP Streams Reference