From 7b4aac161d9a1b66f0bdc39ca049df7437dcc75c Mon Sep 17 00:00:00 2001 From: Wez Furlong Date: Thu, 26 Sep 2002 11:38:23 +0000 Subject: [PATCH] file_get_wrapper_data renamed to file_get_meta_data and expanded. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@96988 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../functions/file-get-meta-data.xml | 120 ++++++++++++++++++ .../functions/file-get-wrapper-data.xml | 52 -------- 2 files changed, 120 insertions(+), 52 deletions(-) create mode 100644 reference/filesystem/functions/file-get-meta-data.xml delete mode 100644 reference/filesystem/functions/file-get-wrapper-data.xml diff --git a/reference/filesystem/functions/file-get-meta-data.xml b/reference/filesystem/functions/file-get-meta-data.xml new file mode 100644 index 0000000000..973fbb0844 --- /dev/null +++ b/reference/filesystem/functions/file-get-meta-data.xml @@ -0,0 +1,120 @@ + + + + + file_get_meta_data + Retrieves header/meta data from streams/file pointers + + + Description + + arrayfile_get_meta_data + resourcestream + + + Returns information about an existing stream. + The stream can be any stream created by fopen, + fsockopen and pfsockopen. + The result array contains the following items: + + + + + timed_out (bool) - &true; if the stream + timed out while waiting for data on the last call to + fread or fgets. + + + + + blocked (bool) - &true; if the stream is + in blocking IO mode. See socket_set_blocking. + + + + + eof (bool) - &true; if the stream has reached + end-of-file. Note that for socket streams this member can be &true; + even when unread_bytes is non-zero. To + determine if there is more data to be read, use + feof instead of reading this item. + + + + + unread_bytes (int) - the number of bytes + currently contained in the read buffer. + + + + + The following items were added in PHP 4.3: + + + + + stream_type (string) - a label describing + the underlying implementation of the stream. + + + + + wrapper_type (string) - a label describing + the protocol wrapper implementation layered over the stream. + See for more information about wrappers. + + + + + wrapper_data (mixed) - wrapper specific + data attached to this stream. See for + more information about wrappers and their wrapper data. + + + + + filters (array) - and array containing + the names of any filters that have been stacked onto this stream. + Filters are currently undocumented. + + + + + + This function was introduced in PHP 4.3, but prior to this version, + socket_get_status could be used to retrieve + the first four items, for socket based streams only. + + + In PHP 4.3 and later, + socket_get_status is an alias for this function. + + + + This function does NOT work on sockets created by the Socket extension. + + + + + + diff --git a/reference/filesystem/functions/file-get-wrapper-data.xml b/reference/filesystem/functions/file-get-wrapper-data.xml deleted file mode 100644 index e669ce38ec..0000000000 --- a/reference/filesystem/functions/file-get-wrapper-data.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - file_get_wrapper_data - Retrieves header/meta data from "wrapped" file pointers - - - Description - - mixedfile_get_wrapper_data - intfp - - - This function returns header or meta data from files opened with - fopen. This is useful to return the response - headers for HTTP connections, or some other statistics for other - resources. - - - The format of the returned data is deliberately undocumented at this - time, and depends on which wrapper(s) were used to open the file. - - - - This function was introduced in PHP 4.3.0. - - - - - -