#7741 [Opn->WFx]: [phpdoc] Document about every predefined variable

ID: 7741 Updated by: rasmus@php.net Reported By: tictactux at surfeu dot ch -Status: Open +Status: Wont fix Bug Type: Feature/Change Request Operating System: Any PHP Version: 4.4.0 New Comment: I think it is safe to say by now that this won't happen. It's an infinite problem as any module can add new things to the server. Previous Comments: ------------------------------------------------------------------------ [2002-12-03 01:52:57] shane@php.net google 'cgi variables' brings up tons of documentation, why waste time doing it yet again. 'document all possible predefined variables' will be a big job since there are a lot of those (outsided cgi spec), should just point to reference urls. Anyway, the primary ones should now conform to cgi spec. ------------------------------------------------------------------------ [2002-12-03 01:19:03] philip@php.net IMHO this is now a feature request to document all possible predefined variables, and should not be closed. Each predefined variable should be documented in terms of when they'll be available. For example, mod_rewrite makes a few available: http://httpd.apache.org/docs/mod/mod_rewrite.html#EnvVar I thought this request was marked elsewhere but couldn't find it... Am reopening for now, and changing summary. ------------------------------------------------------------------------ [2002-12-03 01:08:37] shane@php.net This bug has been fixed in CVS. In case this was a PHP problem, snapshots of the sources are packaged every three hours; this change will be in the next snapshot. You can grab the snapshot at http://snaps.php.net/. In case this was a documentation problem, the fix will show up soon at http://www.php.net/manual/. In case this was a PHP.net website problem, the change will show up on the PHP.net site and on the mirror sites in short time. Thank you for the report, and for helping us make PHP better. variables should now conform to CGI spec. ------------------------------------------------------------------------ [2002-06-17 13:27:12] hholzgra@php.net IMHO available variables should not be limited, but documented for each SAPI (with special non-standard additions for CGI sapi) re-classified as doc problem ------------------------------------------------------------------------ [2000-11-10 04:32:48] tictactux at surfeu dot ch This is not a bug but a change request: Several people seem to struggle with .cgi and non-apache servers, especially as server-supplied environment variables are used that are *not* defined in the current cgi/1.1 specifications (see http://web.golux.com/coar/cgi/). Only the following variables are defined there; everything else should be treated as 'vendor extensions': Quote from http://web.golux.com/coar/cgi/draft-coar-cgi-v11-03-clean.html#6.1: -------------------- The canonical metavariables defined by this specification are: AUTH_TYPE CONTENT_LENGTH CONTENT_TYPE GATEWAY_INTERFACE PATH_INFO PATH_TRANSLATED QUERY_STRING REMOTE_ADDR REMOTE_HOST REMOTE_IDENT REMOTE_USER REQUEST_METHOD SCRIPT_NAME SERVER_NAME SERVER_PORT SERVER_PROTOCOL SERVER_SOFTWARE --------------------- Therefore we should not rely on the presence of other variables; they might be used as a shortcut if present, however: My_script_filename = getenv("SCRIPT_FILENAME"); if (!My_script_filename) { My_script_filename = mangle("PATH_INFO", "SCRIPT_NAME") } The mangle function does not really exist yet, right? ;-) If we don't stick to a minimum, widely accept set of 'server properties', we get a lot of long, frustrated and finally red faces. Always keep in mind that the Apache is not the only tribesman out there... Regards, Ben ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/?id=7741&edit=1