[PHP-DOC] cvs: phpdoc /en/functions session.xml
yohgaki Thu Jan 10 02:37:38 2002 EDT
Modified files:
/phpdoc/en/functionssession.xml
Log:
Clarify user session save handlers return values
Index: phpdoc/en/functions/session.xml
diff -u phpdoc/en/functions/session.xml:1.71 phpdoc/en/functions/session.xml:1.72
--- phpdoc/en/functions/session.xml:1.71Mon Jan 7 06:23:25 2002
+++ phpdoc/en/functions/session.xml Thu Jan 10 02:37:38 2002
@@ -1,5 +1,5 @@
-
+
Session handling functions
Sessions
@@ -1011,6 +1011,12 @@
supported database engine.
+ Read function must return string value always to make save
+ handler work as expected. Return empty string if there is no data
+ to read. Return values from other handlers are converted to
+ boolean expression. TRUE for success, FALSE for failure.
+
+
session_set_save_handler example
@@ -1038,7 +1044,7 @@
$sess_data = fread($fp, filesize($sess_file));
return($sess_data);
} else {
-return(""); // Must return ("") here.
+return(""); // Must return "" here.
}
}
[PHP-DOC] cvs: phpdoc /en/appendices predefined.xml
irc-htmlWed Jan 9 22:09:49 2002 EDT Added files: /phpdoc/en/appendices predefined.xml Log: Incremental update for list of predefined variables and constants. Please don't link or translate, just copied over the information from the chapter sections. Index: phpdoc/en/appendices/predefined.xml +++ phpdoc/en/appendices/predefined.xml <-- Note: Please do not link or translate this file yet. This is only an initial update, quite a few more commits will follow for this appendix. --> List of Predefined Variables and Constants The following is a listing of predefined variables and and constants. These lists are neither exhaustive or complete. Listing of Predefined Variables Apache variables These variables are created by the Apache webserver. If you are running another webserver, there is no guarantee that it will provide the same variables; it may omit some, or provide others not listed here. That said, a large number of these variables are accounted for in the CGI 1.1 specification, so you should be able to expect those. Note that few, if any, of these will be available (or indeed have any meaning) if running PHP on the command line. $GATEWAY_INTERFACE What revision of the CGI specification the server is using; i.e. 'CGI/1.1'. $SERVER_NAME The name of the server host under which the current script is executing. If the script is running on a virtual host, this will be the value defined for that virtual host. $SERVER_SOFTWARE Server identification string, given in the headers when responding to requests. $SERVER_PROTOCOL Name and revision of the information protocol via which the page was requested; i.e. 'HTTP/1.0'; $REQUEST_METHOD Which request method was used to access the page; i.e. 'GET', 'HEAD', 'POST', 'PUT'. $QUERY_STRING The query string, if any, via which the page was accessed. $DOCUMENT_ROOT The document root directory under which the current script is executing, as defined in the server's configuration file. $HTTP_ACCEPT Contents of the Accept: header from the current request, if there is one. $HTTP_ACCEPT_CHARSET Contents of the Accept-Charset: header from the current request, if there is one. Example: 'iso-8859-1,*,utf-8'. $HTTP_ACCEPT_ENCODING Contents of the Accept-Encoding: header from the current request, if there is one. Example: 'gzip'. $HTTP_ACCEPT_LANGUAGE Contents of the Accept-Language: header from the current request, if there is one. Example: 'en'. $HTTP_CONNECTION Contents of the Connection: header from the current request, if there is one. Example: 'Keep-Alive'. $HTTP_HOST Contents of the Host: header from the current request, if there is one. $HTTP_REFERER The address of the page (if any) which referred the browser to the current page. This is set by the user's browser; not all browsers will set this. $HTTP_USER_AGENT Contents of the User_Agent: header from the current request, if there is one. This is a string denoting the browser software being used to view the current page; i.e. Mozilla/4.5 [en] (X11; U; Linux 2.2.9 i586). Among other things, you can use this value with get_browser to tailor your page's functionality to the capabilities of the user's browser. $REMOTE_ADDR The IP address from which the user is viewing the current page. $REMOTE_PORT The port being used on the user's machine to communicate with the web server. $SCRIPT_FILENAME The absolute pathname of the currently executing script. $SERVER_ADMIN
[PHP-DOC] cvs: phpdoc /en/functions strings.xml
irc-htmlWed Jan 9 21:11:29 2002 EDT Modified files: /phpdoc/en/functionsstrings.xml Log: addcslashes: doc bug #14935 Index: phpdoc/en/functions/strings.xml diff -u phpdoc/en/functions/strings.xml:1.151 phpdoc/en/functions/strings.xml:1.152 --- phpdoc/en/functions/strings.xml:1.151 Fri Jan 4 20:03:24 2002 +++ phpdoc/en/functions/strings.xml Wed Jan 9 21:11:28 2002 @@ -1,5 +1,5 @@ - + String functions Strings @@ -69,7 +69,7 @@
[PHP-DOC] cvs: phpdoc /en/features persistent-connections.xml
irc-htmlWed Jan 9 20:56:08 2002 EDT Modified files: /phpdoc/en/features persistent-connections.xml Log: fixed reference to mssql_pconnect, spelling errors Index: phpdoc/en/features/persistent-connections.xml diff -u phpdoc/en/features/persistent-connections.xml:1.17 phpdoc/en/features/persistent-connections.xml:1.18 --- phpdoc/en/features/persistent-connections.xml:1.17 Tue Dec 18 15:49:03 2001 +++ phpdoc/en/features/persistent-connections.xml Wed Jan 9 20:56:08 2002 @@ -1,5 +1,5 @@ - + Persistent Database Connections @@ -24,7 +24,7 @@ they're not. In particular, they do not give you an ability to open 'user sessions' on the same SQL link, they do not give you an ability to build up a - transaction efficently, and they don't do a whole lot of other + transaction efficiently, and they don't do a whole lot of other things. In fact, to be extremely clear about the subject, persistent connections don't give you any functionality that wasn't possible with their non-persistent @@ -135,7 +135,7 @@ See also fbsql_pconnect, ibase_pconnect, ifx_pconnect, imap_popen, ingres_pconnect, - msql_pconnect, mssql_pconnection, + msql_pconnect, mssql_pconnect, mysql_pconnect, OCIPLogon, odbc_pconnect, Ora_pLogon, pfsockopen, pg_pconnect, and
[PHP-DOC] cvs: phpdoc /en/functions shmop.xml
yohgaki Wed Jan 9 20:03:06 2002 EDT Modified files: /phpdoc/en/functionsshmop.xml Log: Added EXPERIMENTAL note. # this should be in there... Index: phpdoc/en/functions/shmop.xml diff -u phpdoc/en/functions/shmop.xml:1.12 phpdoc/en/functions/shmop.xml:1.13 --- phpdoc/en/functions/shmop.xml:1.12 Wed Jan 9 19:59:17 2002 +++ phpdoc/en/functions/shmop.xml Wed Jan 9 20:03:06 2002 @@ -1,5 +1,5 @@ - + Shared Memory Functions shmop @@ -13,6 +13,10 @@ in your configure line. + + This module is experimental. API and others are subject to be + changed without notice. + In PHP 4.0.3, there functions were prefixed by shm rather than shmop.
[PHP-DOC] cvs: phpdoc /en/functions shmop.xml
yohgaki Wed Jan 9 19:59:17 2002 EDT Modified files: /phpdoc/en/functionsshmop.xml Log: Additional features are added. Patch by [EMAIL PROTECTED] Index: phpdoc/en/functions/shmop.xml diff -u phpdoc/en/functions/shmop.xml:1.11 phpdoc/en/functions/shmop.xml:1.12 --- phpdoc/en/functions/shmop.xml:1.11 Wed Dec 12 15:47:25 2001 +++ phpdoc/en/functions/shmop.xml Wed Jan 9 19:59:17 2002 @@ -1,9 +1,9 @@ - + Shared Memory Functions shmop - + Shmop is an easy to use set of functions that allows php to read, @@ -89,14 +89,30 @@ -"a" for access (sets IPC_EXCL) -use this flag when you need to open an existing shared memory segment +"a" for access (sets SHM_RDONLY for shmat) +use this flag when you need to open an existing shared memory segment for +read only "c" for create (sets IPC_CREATE) -use this flag when you need to create a new shared memory segment. +use this flag when you need to create a new shared memory segment or if a + segment with the same key exists, try to open it for read and write + + + + +"w" for read & write access + use this flag when you need to read and write to a shared memory segment, use +this flag + in most cases. + + + + +"n" create a new memory segment (sets IPC_CREATE|IPC_EXCL) + use this flag when you want to create a new shared memory segment but if one + already exists with the same flag, fail. This is useful for security purposes, +using this you + can prevent race condition exploits. @@ -108,10 +124,10 @@ Note: the 3rd and 4th should be entered as 0 if you are opening an existing memory segment. On success shmop_open will - return an id that you can use to access the shared memory segment + return an id that you can use to access the shared memory segment you've created. - + Create a new shared memory block @@ -128,8 +144,8 @@ This example opened a shared memory block with a system id of 0x0fff. - - + + shmop_read @@ -152,7 +168,7 @@ shmop_read takes 3 parameters: shmid, which is the shared memory block identifier created by shmop_open, offset from which to start reading and count on the number of bytes to read. - + Reading shared memory block @@ -171,7 +187,7 @@ - + shmop_write @@ -195,7 +211,7 @@ shared memory block identifier created by shmop_open, data, a string that you want to write into shared memory block and offset, which specifies where to start writing data inside the shared memory segment. - + Writing to shared memory block
[PHP-DOC] cvs: phpdoc /en/functions cybermut.xml datetime.xml
irc-htmlWed Jan 9 19:51:21 2002 EDT Modified files: /phpdoc/en/functionscybermut.xml datetime.xml Log: spelling, parameter corrections Index: phpdoc/en/functions/cybermut.xml diff -u phpdoc/en/functions/cybermut.xml:1.13 phpdoc/en/functions/cybermut.xml:1.14 --- phpdoc/en/functions/cybermut.xml:1.13 Wed Jan 9 19:43:33 2002 +++ phpdoc/en/functions/cybermut.xmlWed Jan 9 19:51:21 2002 @@ -1,5 +1,5 @@ - + Crédit Mutuel CyberMUT functions CyberMUT @@ -134,8 +134,9 @@ cybermut_testmac is used to make sure that there was not data diddling contained in the received message of confirmation. - Pay attention to parameters code-retour and texte-libre, which cannot be - evaluated as is, because auf the dash. You must retrieve them by using: + Pay attention to parameters code-retour and + texte-libre, which cannot be evaluated as is, + because of the dash. You must retrieve them by using:
[PHP-DOC] cvs: phpdoc /en/chapters install.caudium.xml
mk Wed Jan 9 19:46:48 2002 EDT Modified files: /phpdoc/en/chapters install.caudium.xml Log: Arghs! Index: phpdoc/en/chapters/install.caudium.xml diff -u phpdoc/en/chapters/install.caudium.xml:1.2 phpdoc/en/chapters/install.caudium.xml:1.3 --- phpdoc/en/chapters/install.caudium.xml:1.2 Wed Jan 9 19:41:43 2002 +++ phpdoc/en/chapters/install.caudium.xml Wed Jan 9 19:46:48 2002 @@ -1,5 +1,5 @@ - + Servers-Caudium @@ -45,8 +45,7 @@ the normal MySQL client code is used. Otherwise there might be conflicts if your Pike already has MySQL support. You do this by specifying a MySQL install directory the --with-mysql - option. + linkend="install.configure.with-mysql"> --with-mysql option.
[PHP-DOC] cvs: phpdoc /en/functions curl.xml
irc-htmlWed Jan 9 19:46:06 2002 EDT Modified files: /phpdoc/en/functionscurl.xml Log: more spelling errors Index: phpdoc/en/functions/curl.xml diff -u phpdoc/en/functions/curl.xml:1.24 phpdoc/en/functions/curl.xml:1.25 --- phpdoc/en/functions/curl.xml:1.24 Wed Jan 9 19:43:33 2002 +++ phpdoc/en/functions/curl.xmlWed Jan 9 19:46:06 2002 @@ -1,5 +1,5 @@ - + CURL, Client URL Library Functions CURL @@ -566,7 +566,7 @@ - This functions closes a CURL session and frees all res sources. + This function closes a CURL session and frees all resources. The CURL handle, ch, is also deleted.
[PHP-DOC] cvs: phpdoc /en/functions curl.xml cybermut.xml datetime.xml dbm.xml
irc-htmlWed Jan 9 19:43:33 2002 EDT Modified files: /phpdoc/en/functionscurl.xml cybermut.xml datetime.xml dbm.xml Log: corrected spelling errors Index: phpdoc/en/functions/curl.xml diff -u phpdoc/en/functions/curl.xml:1.23 phpdoc/en/functions/curl.xml:1.24 --- phpdoc/en/functions/curl.xml:1.23 Sun Jan 6 13:38:48 2002 +++ phpdoc/en/functions/curl.xmlWed Jan 9 19:43:33 2002 @@ -1,5 +1,5 @@ - + CURL, Client URL Library Functions CURL @@ -200,7 +200,7 @@ CURLOPT_FAILONERROR: Set this option to a non-zero value if you want PHP to fail silently if the HTTP -code returned is greater than 300. The default behaviour is +code returned is greater than 300. The default behavior is to return the page normally, ignoring the code. @@ -368,7 +368,7 @@ CURLOPT_RANGE: Pass the specified range you want. It should be in the "X-Y" format, where X or Y may be left out. The HTTP transfers also support several -intervals, seperated with commas as in X-Y,N-M. +intervals, separated with commas as in X-Y,N-M. @@ -424,7 +424,7 @@ CURLOPT_COOKIEFILE: Pass a string -containing the name of the file containing the cookiee data. +containing the name of the file containing the cookie data. The cookie file can be in Netscape format, or just plain HTTP-style headers dumped into a file. @@ -566,7 +566,7 @@ - This functions closes a CURL session and frees all ressources. + This functions closes a CURL session and frees all res sources. The CURL handle, ch, is also deleted. Index: phpdoc/en/functions/cybermut.xml diff -u phpdoc/en/functions/cybermut.xml:1.12 phpdoc/en/functions/cybermut.xml:1.13 --- phpdoc/en/functions/cybermut.xml:1.12 Wed Dec 12 15:46:41 2001 +++ phpdoc/en/functions/cybermut.xmlWed Jan 9 19:43:33 2002 @@ -1,5 +1,5 @@ - + Crédit Mutuel CyberMUT functions CyberMUT @@ -204,11 +204,11 @@ cybermut_creerreponsecm returns a string containing - delivery aknowledgement message. + delivery acknowledgement message. The parameter is "OK" if the message of confirmation of the payment - were correctly auhentified by cybermut_testmac. + were correctly identified by cybermut_testmac. Any other chain is regarded as an error message. Index: phpdoc/en/functions/datetime.xml diff -u phpdoc/en/functions/datetime.xml:1.62 phpdoc/en/functions/datetime.xml:1.63 --- phpdoc/en/functions/datetime.xml:1.62 Fri Jan 4 00:58:18 2002 +++ phpdoc/en/functions/datetime.xmlWed Jan 9 19:43:33 2002 @@ -1,5 +1,5 @@ - + Date and Time functions Date/time @@ -303,7 +303,7 @@ - This can be more reliable than simply adding or substracting the number + This can be more reliable than simply adding or subtracting the number of seconds in a day or month to a timestamp because of daylight savings time. @@ -314,7 +314,7 @@ you should escape any other characters, as any which currently have a special meaning will produce undesirable results, and other characters may be assigned meaning in future PHP versions. - When escaping, bu sure to use single quotes to prevent characters + When escaping, be sure to use single quotes to prevent characters like \n from become newlines. @@ -647,7 +647,7 @@ -"tm_mon" - month of the year, starting with 0 for january +"tm_mon" - month of the year, starting with 0 for January @@ -819,7 +819,7 @@ Date with year, month and day equal to zero is considered illegal (otherwise it what be regarded as 30.11.1999, which would be strange - behaviour). + behavior). See also date and time. Index: phpdoc/en/functions/dbm.xml diff -u phpdoc/en/functions/dbm.xml:1.15 phpdoc/en/functions/dbm.xml:1.16 --- phpdoc/en/functions/dbm.xml:1.15Wed Dec 12 15:46:43 2001 +++ phpdoc/en/functions/dbm.xml Wed Jan 9 19:43:33 2002 @@ -1,5 +1,5 @@ - + DBM Functions DBM @@ -56,7 +56,7 @@ respectively. - Returns an identifer to be passed to the other DBM functions on + Returns an identifier to be passed to the other DBM functions on success, or &false; on failure.
[PHP-DOC] cvs: phpdoc /en/chapters install.caudium.xml
mk Wed Jan 9 19:41:43 2002 EDT Modified files: /phpdoc/en/chapters install.caudium.xml Log: Fix this Index: phpdoc/en/chapters/install.caudium.xml diff -u phpdoc/en/chapters/install.caudium.xml:1.1 phpdoc/en/chapters/install.caudium.xml:1.2 --- phpdoc/en/chapters/install.caudium.xml:1.1 Wed Jan 9 18:52:08 2002 +++ phpdoc/en/chapters/install.caudium.xml Wed Jan 9 19:41:43 2002 @@ -1,5 +1,5 @@ - + Servers-Caudium @@ -44,8 +44,8 @@ When compiling PHP 4 with MySQL support you must make sure that the normal MySQL client code is used. Otherwise there might be conflicts if your Pike already has MySQL support. You do this by - specifying a MySQL install directory the --with-mysql + specifying a MySQL install directory the --with-mysql option.
[PHP-DOC] cvs: phpdoc /en/functions cyrus.xml
irc-htmlWed Jan 9 19:38:23 2002 EDT Modified files: /phpdoc/en/functionscyrus.xml Log: whitespace correction Index: phpdoc/en/functions/cyrus.xml diff -u phpdoc/en/functions/cyrus.xml:1.5 phpdoc/en/functions/cyrus.xml:1.6 --- phpdoc/en/functions/cyrus.xml:1.5 Wed Dec 19 12:45:35 2001 +++ phpdoc/en/functions/cyrus.xml Wed Jan 9 19:38:23 2002 @@ -1,12 +1,12 @@ - + Cyrus IMAP administration functions Cyradm functions - undocumented +&warn.undocumented.func; @@ -82,8 +82,8 @@ bool cyrus_bind - resource connection - array callbacks + resource connection + array callbacks @@ -102,8 +102,8 @@ bool cyrus_unbind - resource connection - string trigger_name + resource connection + string trigger_name @@ -122,8 +122,8 @@ bool cyrus_query - resource connection - string query + resource connection + string query @@ -142,7 +142,7 @@ bool cyrus_close - resource connection + resource connection
[PHP-DOC] cvs: phpdoc /en/functions bc.xml classobj.xml com.xml cpdf.xml
irc-htmlWed Jan 9 19:26:29 2002 EDT Modified files: /phpdoc/en/functionsbc.xml classobj.xml com.xml cpdf.xml Log: corrected spelling errors Index: phpdoc/en/functions/bc.xml diff -u phpdoc/en/functions/bc.xml:1.18 phpdoc/en/functions/bc.xml:1.19 --- phpdoc/en/functions/bc.xml:1.18 Wed Dec 12 15:46:37 2001 +++ phpdoc/en/functions/bc.xml Wed Jan 9 19:26:29 2002 @@ -1,5 +1,5 @@ - + BCMath Arbitrary Precision Mathematics Functions BC math @@ -75,7 +75,7 @@ right operand and returns the result as an integer. The optional scale parameter is used to set the number of digits after the decimal place which - will be used in the comparion. The return value is 0 if the two + will be used in the comparison. The return value is 0 if the two operands are equal. If the left operand is larger than the right operand the return value is +1 and if the left operand @@ -227,7 +227,7 @@ bcsqrt - Get the square root of an arbitray precision number + Get the square root of an arbitrary precision number Index: phpdoc/en/functions/classobj.xml diff -u phpdoc/en/functions/classobj.xml:1.31 phpdoc/en/functions/classobj.xml:1.32 --- phpdoc/en/functions/classobj.xml:1.31 Wed Jan 2 07:08:05 2002 +++ phpdoc/en/functions/classobj.xmlWed Jan 9 19:26:29 2002 @@ -1,5 +1,5 @@ - + Class/Object Functions Classes/Objects @@ -197,7 +197,7 @@ Calls a the method referred by method_name from - the user defined obj object, using the paramaters + the user defined obj object, using the parameters in paramarr. Index: phpdoc/en/functions/com.xml diff -u phpdoc/en/functions/com.xml:1.28 phpdoc/en/functions/com.xml:1.29 --- phpdoc/en/functions/com.xml:1.28Wed Jan 9 19:17:41 2002 +++ phpdoc/en/functions/com.xml Wed Jan 9 19:26:29 2002 @@ -1,5 +1,5 @@ - + COM support functions for Windows COM @@ -23,7 +23,7 @@ For further information on COM read the COM specification or perhaps take a look at Don Box's - Yet Another COM Libracy (YACL) + Yet Another COM Library (YACL) @@ -205,7 +205,7 @@ VT_BOOL, VT_ERROR, VT_CY, VT_DATE, VT_BSTR, VT_DECIMAL, VT_UNKNOWN, VT_DISPATCH and VT_VARIANT. These values are - mutual exclusive, but they can be combined with VT_BYREF to specify beeing a value. If omitted, + mutual exclusive, but they can be combined with VT_BYREF +to specify being a value. If omitted, the type of value is used. Consult the msdn library for additional information. @@ -255,7 +255,7 @@ com_load creates a new COM component and returns a reference to it. Returns &false; on -failiure.Possible values for codepage are +failure.Possible values for codepage are CP_ACP, CP_MACCP, CP_OEMCP, CP_SYMBOL, CP_THREAD_ACP, CP_UTF7 Index: phpdoc/en/functions/cpdf.xml diff -u phpdoc/en/functions/cpdf.xml:1.35 phpdoc/en/functions/cpdf.xml:1.36 --- phpdoc/en/functions/cpdf.xml:1.35 Sat Dec 15 09:33:08 2001 +++ phpdoc/en/functions/cpdf.xmlWed Jan 9 19:26:29 2002 @@ -1,5 +1,5 @@ - + ClibPDF functions ClibPDF @@ -767,7 +767,7 @@ name. The format of the image has to be jpeg. The image is placed on the current page at position (x-coor, y-coor). - The image is rotated by angle degres. + The image is rotated by angle degrees. The optional parameter mode determines the @@ -1008,7 +1008,7 @@ The cpdf_place_inline_image function places an image created with the php image functions on the page at - postion (x-coor, + position (x-coor, y-coor). The image can be scaled at the same time. @@ -1046,7 +1046,7 @@ The cpdf_rect function draws a rectangle with its lower left corner at point (x-coor, y-coor). - This width is set to widgth. + This width is set to width. This height is set to height. @@ -1061,7 +1061,7 @@ cpdf_restore -Restores formerly saved enviroment +Restores formerly saved environment Description @@ -1073,7 +1073,7 @@ The cpdf_restore function restores the - enviroment saved with cpdf_save. It works + environment saved with cpdf_save. It works like the postscript command grestore. Very useful if you want to translate or rotate an object without effecting other objects. @@ -1179,7 +1179,7 @@ The cpdf_rotate function set the rotation in - degress to angle. + degrees to angle. @@ -1209,7 +1209,7 @@ cpdf_save -Saves current enviroment +Saves current environment Description @@ -1221,7 +1221,7 @@ The cpdf_save function saves the current - enviroment. It works like the postscri
[PHP-DOC] cvs: phpdoc /en/functions com.xml
irc-htmlWed Jan 9 19:17:41 2002 EDT Modified files: /phpdoc/en/functionscom.xml Log: whitespace correction Index: phpdoc/en/functions/com.xml diff -u phpdoc/en/functions/com.xml:1.27 phpdoc/en/functions/com.xml:1.28 --- phpdoc/en/functions/com.xml:1.27Sat Dec 15 09:31:27 2001 +++ phpdoc/en/functions/com.xml Wed Jan 9 19:17:41 2002 @@ -1,25 +1,30 @@ - + COM support functions for Windows COM -COM is a technology which allows the reuse of code written in any - language (by any language) using a standard calling convention and hiding - behind APIs the implementation details such as what machine the Component is - stored on and the executable which houses it. It can be thought of as a super - Remote Procedure Call (RPC) mechanism with some basic object roots. It - separates implementation from interface. -COM encourages versioning, separation of implementation from - interface and hiding the implementation details such as executable location and - the language it was written in. -COM functions are only available on the Windows version of - PHP. -For further information on COM read the - COM - specification or perhaps take a look at Don Box's -Yet Another COM - Libracy (YACL) + +COM is a technology which allows the reuse of code written in any +language (by any language) using a standard calling convention and hiding +behind APIs the implementation details such as what machine the Component is +stored on and the executable which houses it. It can be thought of as a super +Remote Procedure Call (RPC) mechanism with some basic object roots. It +separates implementation from interface. + + +COM encourages versioning, separation of implementation from +interface and hiding the implementation details such as executable location and +the language it was written in. + + +COM functions are only available on the Windows version of PHP. + + +For further information on COM read the COM +specification or perhaps take a look at Don Box's + Yet Another COM Libracy (YACL) +
Re: [PHP-DOC] cvs: phpdoc /en/chapters install.apache.xml install.caudium.xml install.commandline.xml install.configure.xml install.fhttpd.xml install.hpux.xml install.iis.xml install.linux.xml install.macosx.xml install.netscape-enterprise.xml install.om
James Cox wrote: > > Nice work on this! Thanx alot! The resulting HTML file is way too big IMHO. Mark -- German Gabber Network @ http://www.gabber.de Infos und Tips zu PHP http://www.php-homepage.de
RE: [PHP-DOC] cvs: phpdoc /en/chapters install.apache.xml install.caudium.xml install.commandline.xml install.configure.xml install.fhttpd.xml install.hpux.xml install.iis.xml install.linux.xml install.macosx.xml install.netscape-enterprise.xml install.om
Nice work on this! James > -Original Message- > From: Mark Kronsbein [mailto:[EMAIL PROTECTED]] > Sent: Wednesday, January 09, 2002 11:52 PM > To: [EMAIL PROTECTED] > Subject: [PHP-DOC] cvs: phpdoc /en/chapters install.apache.xml > install.caudium.xml install.commandline.xml install.configure.xml > install.fhttpd.xml install.hpux.xml install.iis.xml install.linux.xml > install.macosx.xml install.netscape-enterprise.xml install.omniht > > > mkWed Jan 9 18:52:09 2002 EDT > > Added files: > /phpdoc/en/chapters install.apache.xml install.caudium.xml > install.commandline.xml > install.configure.xml > install.fhttpd.xml install.hpux.xml > install.iis.xml install.linux.xml > install.macosx.xml > install.netscape-enterprise.xml > install.omnihttpd.xml install.openbsd.xml > install.oreilly.xml install.otherhttpd.xml > install.problems.xml install.solaris.xml > install.unix.xml install.windows.xml > install.xitami.xml > > Modified files: > /phpdoc/en/chapters install.xml > Log: > Split of config.xml. "make test" works fine, so lets see, if > this will help people to get more information on the installation. >
[PHP-DOC] cvs: phpdoc /en/functions array.xml
irc-htmlWed Jan 9 19:07:21 2002 EDT
Modified files:
/phpdoc/en/functionsarray.xml
Log:
corrected spelling errors
Index: phpdoc/en/functions/array.xml
diff -u phpdoc/en/functions/array.xml:1.150 phpdoc/en/functions/array.xml:1.151
--- phpdoc/en/functions/array.xml:1.150 Fri Jan 4 19:06:15 2002
+++ phpdoc/en/functions/array.xml Wed Jan 9 19:07:21 2002
@@ -1,5 +1,5 @@
-
+
Array Functions
Arrays
@@ -221,7 +221,7 @@
By setting the optional preserve_keys
parameter to &true;, you can force PHP to preserve the original
keys from the input array. If you specify &false; new number
- indicies will be used in each resulting array with
+ indices will be used in each resulting array with
indices starting from zero. The default is &false;.
@@ -366,7 +366,7 @@
This makes $result have
- array ("blue");. Multiple occurences in
+ array ("blue");. Multiple occurrences in
$array1 are all treated the same way.
@@ -494,7 +494,7 @@
flipped.
- If a value has several occurences, the latest key will be
+ If a value has several occurrences, the latest key will be
used as its values, and all others will be lost.
@@ -1208,7 +1208,7 @@
No two sorting flags of the same type can be specified after each
- array. The sortings flags specified after an array argument apply
+ array. The sorting flags specified after an array argument apply
only to that array - they are reset to default SORT_ASC and
SORT_REGULAR after before each new array argument.
@@ -1583,8 +1583,8 @@
array_reduce applies iteratively the
callback function to the elements of the
array input, so as to reduce the array to
- a single value. If the optional intial is
- avaliable, it will be used at the beginning of the process, or as
+ a single value. If the optional initial is
+ available, it will be used at the beginning of the process, or as
a final result in case the array is empty.
@@ -3280,7 +3280,7 @@
regular computer string sorting algorithms.
- For more infomation see: Martin Pool's Natural Order String Comparison
page.
[PHP-DOC] cvs: phpdoc /en/functions math.xml
irc-htmlWed Jan 9 18:59:53 2002 EDT Modified files: /phpdoc/en/functionsmath.xml Log: added example to abs(), corrected spelling errors Index: phpdoc/en/functions/math.xml diff -u phpdoc/en/functions/math.xml:1.65 phpdoc/en/functions/math.xml:1.66 --- phpdoc/en/functions/math.xml:1.65 Wed Jan 9 18:43:26 2002 +++ phpdoc/en/functions/math.xmlWed Jan 9 18:59:53 2002 @@ -1,5 +1,5 @@ - + Mathematical Functions Math @@ -145,6 +145,16 @@ otherwise it is integer (as float usually has a bigger value range than integer). + + abs example + + + + @@ -632,7 +642,7 @@ Returns the next lowest integer value by rounding down - value if neccessary. + value if necessary. The return value of floor is still of type float because the value range of float is usually bigger than that of int.
[PHP-DOC] cvs: phpdoc / configure.in
hholzgraWed Jan 9 18:51:54 2002 EDT Modified files: /phpdoc configure.in Log: compatibility fixx Index: phpdoc/configure.in diff -u phpdoc/configure.in:1.110 phpdoc/configure.in:1.111 --- phpdoc/configure.in:1.110 Tue Jan 8 15:32:15 2002 +++ phpdoc/configure.in Wed Jan 9 18:51:53 2002 @@ -1,4 +1,4 @@ -dnl $Id: configure.in,v 1.110 2002/01/08 20:32:15 hholzgra Exp $ +dnl $Id: configure.in,v 1.111 2002/01/09 23:51:53 hholzgra Exp $ dnl autoconf initialisation AC_INIT() @@ -589,16 +589,16 @@ ( for file in `find . -name "*.in"`; do case "$file" in -configure.in) +./configure.in) echo configure: configure.in - echo "\t"autoconf + printf '\t autoconf' echo ;; -manual.xml.in) +./manual.xml.in) ;; *) echo `dirname $file`/`basename $file .in`: '$(srcdir)'/$file ./config.status - echo "\t"CONFIG_FILES='$@' CONFIG_HEADERS= ./config.status + printf '\t CONFIG_FILES=$@ CONFIG_HEADERS= ./config.status' echo esac done
[PHP-DOC] cvs: phpdoc /en/functions math.xml
irc-htmlWed Jan 9 18:43:27 2002 EDT Modified files: /phpdoc/en/functionsmath.xml Log: added example for ceil() Index: phpdoc/en/functions/math.xml diff -u phpdoc/en/functions/math.xml:1.64 phpdoc/en/functions/math.xml:1.65 --- phpdoc/en/functions/math.xml:1.64 Tue Jan 1 19:44:14 2002 +++ phpdoc/en/functions/math.xmlWed Jan 9 18:43:26 2002 @@ -1,5 +1,5 @@ - + Mathematical Functions Math @@ -413,6 +413,15 @@ float as the value range of float is usually bigger than that of int. + + ceil examples + + + + See also floor and round.
[PHP-DOC] Windows HTML help (chm) not updated
Gazing at http://www.php.net/download-docs.php for downloadable documentation, I have found that all english formats were updated on 5th January 2002 - except for the Windows version which was updated on 20th December 2001. Is it possible to automagically keep the Windows version as updated as the rest? IMHO this particular format is best suited for offline browsing, as it is compact, fully indexed and *searchable*. :-) Thanks, Bjarte
Re: [PHP-DOC] Missing docs on new global variables
> Will they appear in the official docs soon? Yep. The page is being completely redone. For now, the 4.1.0 release announcement has the info. Regards, Philip Olson
[PHP-DOC] Missing docs on new global variables
I cannot find any info on the new $_GET, $_POST, $_COOKIE, $_SERVER and $_ENV variables in the current documentation. Are these variables documented somewhere else? Will they appear in the official docs soon? Thanks, -Bjarte-
Re: [PHP-DOC] coding standards - draft
"Gabor Hojtsy" <[EMAIL PROTECTED]> wrote in message
005101c1990c$bac51520$281ca3d5@Mia">news:005101c1990c$bac51520$281ca3d5@Mia...
| > +1 for trigger_error(); -1 for user_error: alias for trigger_error
+1 for trigger_error(); -1 for user_error, so do I.
IMHO, the main point is that using trigger_error() makes example codes
much simpler and understandable, beside being a very big hammer in
customizing your error reporting and handling.
(displaying a static.html page with "BIG ERROR" messages or whatsoever,
logging it wherever you want, stops execution when you want.)
I'm for using trigger_error().
|
| > $conn = mysql_connect(...) or user_error("Cannot connect", E_USER_ERROR);
| > lacks flexibility, not in error_handling but the in the or construct.
| Philip
| > Olson dropped a note about this in a recent mail.
I'll check it, but you can write still:
$connect = mysql_connect(...);
if ($connect === FALSE) {
trigger_error(...);
}
--
Gyozo Papp
- [EMAIL PROTECTED]
[PHP-DOC] cvs: phpdoc /howto howto.ent
philip Wed Jan 9 15:29:28 2002 EDT Modified files: /phpdoc/howto howto.ent Log: oops, got carried away :) typo. Index: phpdoc/howto/howto.ent diff -u phpdoc/howto/howto.ent:1.11 phpdoc/howto/howto.ent:1.12 --- phpdoc/howto/howto.ent:1.11 Wed Jan 9 14:43:05 2002 +++ phpdoc/howto/howto.ent Wed Jan 9 15:29:22 2002 @@ -27,7 +27,7 @@ http://www.php.net/manual/html/";> http://www.php.net/distributions/php_manual_en.pdf";> http://www.php.net/distributions/manual.rtf";> -http://cvs.php.net/co.php/php4/NEWS";> +http://cvs.php.net/co.php/php4/NEWS";> http://cvs.php.net/co.php/phpdoc/howto/howto.html.tar.gz";>
Re: [PHP-DOC] cvs: phpdoc /howto howto.ent
> > +http://cvs.php.net/co.php/php4/NEWS";> > why does this have to be uppercase? just curious. It doesn't have to be, just kinda is :) Goes along with the url I suppose *shrugs* On a second thought, maybe it should be lowercase, will change it now :) Regards, Philip Olson
Re: [PHP-DOC] cvs: phpdoc /howto howto.ent
Hi, On Wed, 09 Jan 2002 19:43:05 - "Philip Olson" <[EMAIL PROTECTED]> wrote: > +http://cvs.php.net/co.php/php4/NEWS";> why does this have to be uppercase? just curious. Jan -- Q: Thank Jan? A: http://geschenke.an.dasmoped.net/
[PHP-DOC] cvs: phpdoc /howto howto.ent
philip Wed Jan 9 14:43:05 2002 EDT Modified files: /phpdoc/howto howto.ent Log: Added some useful links that'll be integrated into HOWTO Index: phpdoc/howto/howto.ent diff -u phpdoc/howto/howto.ent:1.10 phpdoc/howto/howto.ent:1.11 --- phpdoc/howto/howto.ent:1.10 Sun Nov 18 08:05:34 2001 +++ phpdoc/howto/howto.ent Wed Jan 9 14:43:05 2002 @@ -14,6 +14,9 @@ http://www.php.net/";> +http://bonsai.php.net/";> +http://bugs.php.net/";> +http://lxr.php.net/";> http://rsync.php.net/";> http://cvs.php.net/";> http://www.php.net/cvs-php.php";> @@ -24,6 +27,7 @@ http://www.php.net/manual/html/";> http://www.php.net/distributions/php_manual_en.pdf";> http://www.php.net/distributions/manual.rtf";> +http://cvs.php.net/co.php/php4/NEWS";> http://cvs.php.net/co.php/phpdoc/howto/howto.html.tar.gz";> @@ -50,6 +54,7 @@ http://ftp.cvshome.org/win32/";> http://www.arc.unm.edu/~rsahu/cvs.html";> http://cellworks.washington.edu/pub/docs/cvs/tutorial/cvs_tutorial_1.html";> +http://www.loria.fr/~molli/cvs/cvs-FAQ/cvsfaq0.html";> http://www.jclark.com/xml/xt.html";> @@ -75,5 +80,5 @@ http://www.php.net/manual/it/revcheck.html";> -http://www.zend.com/phpfunc/";> - +http://www.fooassociates.com/rtfs/";> +http://www.zend.com/phpfunc/";>
Re: [PHP-DOC] coding standards - draft
> > > (Sample output: > > > not as familiar to docbook as you are. > > > Therefore i just copied this from array.xml; first example with > screen.. > > > Btw. there are many differrent ways used with this thing.) > > > > Check if it is still there, from where you copied. If it is, > > then it is docbook compatible. I faced with some problems > > with s in examples lately in the HU branch, so I think > > this is not valid. I have not checked the DTD or the docs though... > > >From DocBook TDG: > > Example ::= [...] > So example can contain screens and paras. So the COMPLETE > EXAMPLE SKELETON in your draft is right. Thanks for your check. As said, I am not very familiar with Docbook :-). Therfore I didn`t ment that this is the only one and right way to write examples :-) With certainty someone else with more docbook-knowledge should provide an better example. Maybe the one I copied is not appropriate? And maybe this point is not so important, as long as the XML-Code is correct. Friedhelm -- GMX - Die Kommunikationsplattform im Internet. http://www.gmx.net
[PHP-DOC] array_unique tribulation continues
You are right. The examples works as expected with PHP 4.1.1 - Apache 1.3.9 (DSO) on Debian. array_unique() does preserve the *first* key of every related value. However, it doesn't seem to work under Win9x, see the following example: Array // original ( [2] => 4 [4] => 4 [8] => 3 [9] => 4 [5] => 3 [7] => 3 ) Array // array_unique()'d ( [9] => 4 [5] => 3 ) I suggest to you reverting the array_unique section what you find in rev 1.148 and put a warning about this incompatibilty. I'll update my bug report (#14805), too. Gyozo Papp - [EMAIL PROTECTED]
[PHP-DOC] cvs: phpdoc /en/functions sockets.xml
mfischerWed Jan 9 11:51:46 2002 EDT Modified files: /phpdoc/en/functionssockets.xml Log: - Some proto corrections Index: phpdoc/en/functions/sockets.xml diff -u phpdoc/en/functions/sockets.xml:1.29 phpdoc/en/functions/sockets.xml:1.30 --- phpdoc/en/functions/sockets.xml:1.29Tue Jan 8 00:55:08 2002 +++ phpdoc/en/functions/sockets.xml Wed Jan 9 11:51:46 2002 @@ -1,5 +1,5 @@ - + Socket functions Sockets @@ -416,7 +416,7 @@ Description - mixed socket_read + string socket_read resource socket_des int length int type @@ -469,7 +469,7 @@ Description - int socket_create + resource socket_create int domain int type int protocol @@ -1034,7 +1034,7 @@ Description - mixed socket_recv + string socket_recv resource socket int len int flags
Re: [PHP-DOC] array_unique example
At 11.40 09/01/02 +0100, Marco Cucinato wrote:
>but both my PHP 4.0.6 and 4.1.1 say instead
>array(2) {
> [0]=>
> int(4)
> [2]=>
> string(1) "3"
>}
>
>can somebody try and confirm it?
On my PHP Version 4.0.6 on System Windows 95/98 4.10 (as it reads
with phpinfo), I get:
array(2) {
[3]=>
int(4)
[4]=>
int(3)
}
On the same machine, but using Cygwin and PHP/4.0.8-dev I get:
array(2) {
[1]=>
string(1) "4"
[5]=>
string(1) "3"
}
[PHP-DOC] cvs: phpdoc /scripts genfuncindex.php genfunclist.sh genfuncsummary.sh process.php revcheck.php sort_aliases.php
jan Wed Jan 9 09:50:45 2002 EDT Modified files: /phpdoc/scripts genfuncindex.php genfunclist.sh genfuncsummary.sh process.php revcheck.php sort_aliases.php Log: added or renewed license header Index: phpdoc/scripts/genfuncindex.php diff -u phpdoc/scripts/genfuncindex.php:1.2 phpdoc/scripts/genfuncindex.php:1.3 --- phpdoc/scripts/genfuncindex.php:1.2 Sun Jan 6 17:28:59 2002 +++ phpdoc/scripts/genfuncindex.php Wed Jan 9 09:50:45 2002 @@ -1,34 +1,22 @@ http://www.php.net/license/2_02.txt. | +# | If uou did not receive a copy of the PHP license and are unable to | +# | obtain it through the world wide web, please send a note to | +# | [EMAIL PROTECTED] so we can mail you a copy immediately| # +--+ # | Authors:Hartmut Holzgraefe <[EMAIL PROTECTED]> | # +--+ # -# $Id: genfuncindex.php,v 1.2 2002/01/06 22:28:59 hholzgra Exp $ +# $Id: genfuncindex.php,v 1.3 2002/01/09 14:50:45 jan Exp $ */ ?> Index: phpdoc/scripts/genfunclist.sh diff -u phpdoc/scripts/genfunclist.sh:1.1 phpdoc/scripts/genfunclist.sh:1.2 --- phpdoc/scripts/genfunclist.sh:1.1 Sun Jan 6 10:42:31 2002 +++ phpdoc/scripts/genfunclist.sh Wed Jan 9 09:50:45 2002 @@ -1,34 +1,23 @@ #!/bin/sh # # +--+ -# | PHP HTML Embedded Scripting Language Version 3.0 | +# | PHP Version 4| # +--+ -# | Copyright (c) 1997,1998 PHP Development Team (See Credits file) | +# | Copyright (c) 1997-2002 The PHP Group| # +--+ -# | This program is free software; you can redistribute it and/or modify | -# | it under the terms of one of the following licenses: | -# | | -# | A) the GNU General Public License as published by the Free Software | -# | Foundation; either version 2 of the License, or (at your option) | -# | any later version. | -# | | -# | B) the PHP License as published by the PHP Development Team and | -# | included in the distribution in the file: LICENSE| -# | | -# | This program is distributed in the hope that it will be useful, | -# | but WITHOUT ANY WARRANTY; without even the implied warranty of | -# | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the| -# | GNU General Public License for more details. | -# | | -# | You should have received a copy of both licenses referred to here. | -# | If you did not, or have any questions about PHP licensing, please| -# | contact [EMAIL PROTECTED]| +# | This source file is subject to version 2.02 of the PHP licience, | +# | that is bundled with this package in the file LICENCE and is | +# | avalible through the world wide web at | +# | http://www.php.net/license/2_02.txt. | +# | If uou did not receive a copy of the PHP license and are unable to | +# | obtain it through the world wide web, please send a note to | +# | [EMAIL PROTECTED] so we can mail you a copy immediately| # +--+ # | Authors:Ariel Shkedi <[EMAIL PROTECTED]> or <[EMAIL PROTECTED]> | # | Rasmus Lerdorf <[EMAIL PROTECTED]>| # +--+ # -# $Id: genfunclist.sh,v 1.1 2002/01/06 15:42:31 hholzgra Exp $ +# $Id: genfunclist.sh,v 1.2 2002/01/09 14:50:45 jan Exp $ for i in `find $1 -name "*.[c]" -print -o -name "*.ec" -print | xargs egrep -li function_entry` ; do echo $i | sed -e 's/\.\.\//# /' Index: phpdoc/scripts/genfuncsummary.sh diff -u phpdoc/scripts/genfuncsummary.sh:1.2 phpdoc/scripts/genfuncsummary.sh:1.3 --- phpdoc/scripts/genfuncsummary.sh:1.2Mon Jan 7 05:25:09 2002 +++ phpdoc/scripts/genfuncsummary.shWed Jan 9 09:50:45 2002 @@ -1,5 +1,22 @@ -#!/bin/sh -# $Id: genfuncsummary.sh,v 1.2 2002/01/07 10:25:09 goba Exp $ +#!/bin/sh# +# +# +--+ +# | PHP Version 4
Re: [PHP-DOC] Re: array_unique example
> What box do you use? > I get this results PHP4.0.6 under Win PWS and 4.1.1, too. PHP 4.0.6 under Mandrake 8.0 i386, PHP 4.1.1 under RedHat 7.1 i386. > Note that I report it as a bug: http://bugs.php.net/?id=14805 Oh yes, it seems to be so. However, it behaves like the original manual lines under Linux, it's Win32 version which fails. -- Marco Cucinato
[PHP-DOC] cvs: phpdoc /it language-snippets.ent
peruginiWed Jan 9 09:05:30 2002 EDT Modified files: /phpdoc/it language-snippets.ent Log: Changed FALSE with &false; Index: phpdoc/it/language-snippets.ent diff -u phpdoc/it/language-snippets.ent:1.13 phpdoc/it/language-snippets.ent:1.14 --- phpdoc/it/language-snippets.ent:1.13Mon Dec 17 06:56:26 2001 +++ phpdoc/it/language-snippets.ent Wed Jan 9 09:05:29 2002 @@ -27,7 +27,7 @@ nome di file con questa funzione se è stata abilitata l'opzione "fopen wrappers". Per maggiori informazioni vedere fopen.'> -FALSE in caso di fallimento.'> + Questa funzione può restituire &false;, ma può anche restituire un valore valutato
[PHP-DOC] CHM discussions > new list ?
Hi! As the New CHM is going to get to a stage, where most of the time graphics design, javascript and CSS questions need to be discussed, I would like to ask a question about whether this discussion should be moved to a separate list (eg. [EMAIL PROTECTED] or something like that), or may it stay here. Most of the questions from now on in the New CHM section would be: - How to optimize HTML pages to use fewer tags? - What CSS styles to use to get better customizability? - How to optimize JS codes, how to make them *FAST*? These are completely unrelated to PHP, and phpdoc so IMHO it would be better to open a separate list for this discussion and invite anybody who is interested and would like to help in optimizations. Goba
Re: [PHP-DOC] See also
> > Well, that can also be fine, and better then para, > > because it is actually a list, and not a para, as > > it can be seen :)) The second one is better in > > "keys need to be typed" sense :) But, we have > > see also parts, where we have some functions and > > some parts refereced, and to express this, only > > the first one is appropriate. We also have see also > > parts without any functions, just part links... > > If I understand it correctly, see-also block is very simillar to > admonitions (note, warning, ...). So what about putting see-also inside > note > > > ... > > > Stylesheet can render it differently than note w/o role="seealso". I can both be happy with a list type or a block type see also element. The question, is whether we would like to automate it the way, as we need not put commas and "and" words between elements (list type), or simply write out the contents much like a note (block). To be abstract, far away from actual implementation: seeone seetwo seeother types seeone, seetwo, seeother, and types With both rendered with "See also:" prepended to the text and commas, and "and" words added between elements. The first one is clearer, with the second one, you have less to type. Using means using the second one. I can live with both. The second one is the easier to implement. As we choose one or the other, it will much likely will stay the same for a long time, as it is a big change in the docs... What the other people think here? Goba
[PHP-DOC] cvs: phpdoc /scripts process.php
gobaWed Jan 9 08:09:56 2002 EDT
Modified files:
/phpdoc/scripts process.php
Log:
Do not write to file if return value is FALSE
Tabs -> spaces
Apply PEAR style delimiter placing for control structures
Index: phpdoc/scripts/process.php
diff -u phpdoc/scripts/process.php:1.2 phpdoc/scripts/process.php:1.3
--- phpdoc/scripts/process.php:1.2 Mon Jan 7 05:47:48 2002
+++ phpdoc/scripts/process.php Wed Jan 9 08:09:56 2002
@@ -1,8 +1,5 @@
#!/usr/bin/php -q
- 3)
-{ ?>
+ 3) { ?>
Process the manual to do some replacements.
Usage:
@@ -19,80 +16,79 @@
Written by [EMAIL PROTECTED]
-
-
+if (!function_exists('apply')) {
+?>
### FATAL ERROR ###
In you should define a function:
string apply(string $string)
-
Re: [PHP-DOC] See also
Gabor Hojtsy wrote: > Well, that can also be fine, and better then para, > because it is actually a list, and not a para, as > it can be seen :)) The second one is better in > "keys need to be typed" sense :) But, we have > see also parts, where we have some functions and > some parts refereced, and to express this, only > the first one is appropriate. We also have see also > parts without any functions, just part links... If I understand it correctly, see-also block is very simillar to admonitions (note, warning, ...). So what about putting see-also inside note ... Stylesheet can render it differently than note w/o role="seealso". Jirka -- - Jirka Kosek e-mail: [EMAIL PROTECTED] http://www.kosek.cz
[PHP-DOC] cvs: phpdoc / TODO
gobaWed Jan 9 08:06:00 2002 EDT Modified files: /phpdoc TODO Log: I would like to see install.xml splitted up :) Index: phpdoc/TODO diff -u phpdoc/TODO:1.12 phpdoc/TODO:1.13 --- phpdoc/TODO:1.12Wed Jan 9 07:38:47 2002 +++ phpdoc/TODO Wed Jan 9 08:06:00 2002 @@ -30,6 +30,7 @@ - hard way -> keep files as they are and merge translated stuff into intermeditate xml before processing - write proposal for discussion (hartmut) + - split install.xml and maybe other huge files to manageable pieces GENERAL:
Re: [PHP-DOC] coding standards - draft
> > (Sample output: > > not as familiar to docbook as you are. > > Therefore i just copied this from array.xml; first example with screen.. > > Btw. there are many differrent ways used with this thing.) > > Check if it is still there, from where you copied. If it is, > then it is docbook compatible. I faced with some problems > with s in examples lately in the HU branch, so I think > this is not valid. I have not checked the DTD or the docs though... >From DocBook TDG: Example ::= ((Title,TitleAbbrev?), (CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList| SimpleList|VariableList|LiteralLayout|ProgramListing| ProgramListingCO|Screen|ScreenCO|ScreenShot|Synopsis| CmdSynopsis|FuncSynopsis|FormalPara|Para|SimPara|Address| BlockQuote|Graphic|GraphicCO|MediaObject|MediaObjectCO| InformalEquation|InformalExample|InformalFigure|InformalTable| IndexTerm)+) So example can contain screens and paras. So the COMPLETE EXAMPLE SKELETON in your draft is right. Goba
Re: [PHP-DOC] coding standards - draft
> +1 for trigger_error(); -1 for user_error: alias for trigger_error
OK, use trigger_error(). Is user_error() a deprecated alias?
> syslog seems always a bit suspicious to me. Depending on the webserver
> configuration, that user may have insufficient rights to write into??
> On win detailed tuning of user-rights maybe neceessary (ok, you talked
> about production sites, but there maybe also some sites running on w2k
> or winnt :-) )
What trigger_error() actually do depens on the PHP setup. I would not
like to make this a base recommendation for everybody to use syslog.
I use this option on a winnt server, and it works fine, without
outputting any error messages to the user.
> $conn = mysql_connect(...) or user_error("Cannot connect", E_USER_ERROR);
> lacks flexibility, not in error_handling but the in the or construct.
Philip
> Olson dropped a note about this in a recent mail.
> Therefore my suggestion:
> $conn = mysql_connect(...);
> if !("whatever");
> doSomething();
> echo 'output stuff';
> trigger_error("Cannot connect", E_USER_ERROR);
Echo is the thing I think we need to get rid of here... If you use
this scruipt on a production site, it is not likely, that you would
like to user see the echoed output (debug info in most cases).
Now the only thing left is the doSomething() method, which is only
needed if you would like to do something on error before
invoking trigger_error(). Trigger_error() is nice to handle
general errors, like no connection, in which case it can
redirect to a general error page for example. If something special
needed in the example, a doSomething() kind of call can be inserted.
In most of the cases IMHO, there is no special thing to do, but
to present a general error and log it somewhere...
> (Sample output:
> not as familiar to docbook as you are.
> Therefore i just copied this from array.xml; first example with screen..
> Btw. there are many differrent ways used with this thing.)
Check if it is still there, from where you copied. If it is,
then it is docbook compatible. I faced with some problems
with s in examples lately in the HU branch, so I think
this is not valid. I have not checked the DTD or the docs though...
> 0ne comment to strings and variables and output with echo:
> echo $string, "blabla", .; maybe an alternative?
This works, but . is used most of the time IMHO.
Goba
Re: [PHP-DOC] See also
> what about > > >echo >print >printf > > > or > > >echo >print >printf > > > ? Well, that can also be fine, and better then para, because it is actually a list, and not a para, as it can be seen :)) The second one is better in "keys need to be typed" sense :) But, we have see also parts, where we have some functions and some parts refereced, and to express this, only the first one is appropriate. We also have see also parts without any functions, just part links... > > And let the DSSSL code to the rendering work, put > > > in comas and "and" words :) > > haven't played with role-dependant rendering yet, > > but i'm afraid this is an area where XSLT/XPath > have an advantage over DSSSL ... We already have special rendering for introduced by Jirka Kosek. This customization is in html-common.dsl. Goba
[PHP-DOC] cvs: phpdoc / TODO
hholzgraWed Jan 9 07:38:47 2002 EDT Modified files: /phpdoc TODO Log: whitespace Index: phpdoc/TODO diff -u phpdoc/TODO:1.11 phpdoc/TODO:1.12 --- phpdoc/TODO:1.11Wed Jan 9 07:33:38 2002 +++ phpdoc/TODO Wed Jan 9 07:38:47 2002 @@ -15,9 +15,9 @@ BUILD SYSTEM: - - improve php detection in configure for win (hartmut) - - finish makefile cleanup (hartmut) - - support both dsssl and xsl processors with configure/make (hartmut) + - improve php detection in configure for win (hartmut) + - finish makefile cleanup (hartmut) + - support both dsssl and xsl processors with configure/make (hartmut) - improve XSL stylesheet customisation - switch to docbook4 (hartmut) - add DTD
[PHP-DOC] cvs: phpdoc / TODO
hholzgraWed Jan 9 07:33:38 2002 EDT Modified files: /phpdoc TODO Log: mroe todos Index: phpdoc/TODO diff -u phpdoc/TODO:1.10 phpdoc/TODO:1.11 --- phpdoc/TODO:1.10Fri Dec 28 22:13:36 2001 +++ phpdoc/TODO Wed Jan 9 07:33:38 2002 @@ -14,6 +14,24 @@ - sockets: 'available ;)' +BUILD SYSTEM: + - improve php detection in configure for win (hartmut) + - finish makefile cleanup (hartmut) + - support both dsssl and xsl processors with configure/make (hartmut) + - improve XSL stylesheet customisation + - switch to docbook4 (hartmut) +- add DTD +- convert funcsynopsis to methodsynopsis (using scripts/process.php) +- change configure/make + - put translations in seperate cvs modules? (to be discussed) + - translation detection on function level (hartmut) +- easy way -> split reference files down to function level + and keep current file-based detection mechanism +- hard way -> keep files as they are and merge translated + stuff into intermeditate xml before processing +- write proposal for discussion (hartmut) + + GENERAL: - Document that "return" returns from any file, not only included files. @@ -24,6 +42,7 @@ - Add ¬e.no-safemode; to the bottom of each function that is disabled in safe-mode.' - Note which functions don't work with win32. + - Note which functions only work with win32. - Mark binary (un)safe functions - Add example to the &tip.ob-capture; tip (preferable a link to a example)
[PHP-DOC] Re: array_unique example
It was me who changed it.
What box do you use?
I get this results PHP4.0.6 under Win PWS and 4.1.1, too.
Note that I report it as a bug: http://bugs.php.net/?id=14805
"Marco Cucinato" <[EMAIL PROTECTED]> wrote in message
3C3C2C26.6139.78EB06@localhost">news:3C3C2C26.6139.78EB06@localhost...
| at line 1989, the example for PHP 4.0.6 reads
| array(2) {
| [3]=>
| int(4)
| [4]=>
| int(3)
| }
|
| but both my PHP 4.0.6 and 4.1.1 say instead
| array(2) {
| [0]=>
| int(4)
| [2]=>
| string(1) "3"
| }
|
In this case one should change the note paragraph to a warning,
maybe.
Re: [PHP-DOC] See also
Gabor Hojtsy wrote: >>>I would like to have a special rendering >>> >>+1 to something like this, will be cool to have 'See also' a bit more >>structured. >> > > I would like to see something like: > > > echo, print, > and printf > > > Or even: > > > echo > print > printf > what about echo print printf or echo print printf ? > And let the DSSSL code to the rendering work, put > in comas and "and" words :) haven't played with role-dependant rendering yet, but i'm afraid this is an area where XSLT/XPath have an advantage over DSSSL ... -- Hartmut Holzgraefe [EMAIL PROTECTED] http://www.six.de +49-711-99091-77
[PHP-DOC] Re: array.xml examples or
i changed in the Hungarian translation because I couldn't see the difference. "Marco Cucinato" <[EMAIL PROTECTED]> wrote in message 3C3C2C25.30690.78E94E@localhost">news:3C3C2C25.30690.78E94E@localhost... | hello, | | i noted that in array.xml: | 368 This makes $result have | 626 This makes $result have | 1519 This makes both $result and | | but | | 1049 The $result will be: | 1114 The $result will be: | | should we use both of them or only tag? | -- | Marco Cucinato |
Re: [PHP-DOC] coding standards - draft
>> Thanks for your additions. Looking forward for more.:-)
>> I tried to incorporate them, also the contributions from the other people.
>> Have a look online http://www.holliwell.de/draft/draft1
>> or download at http://www.holliwell.de/draft/draft1.tar.gz (about 4kb)
>> Keep in mind it`s a draft and just an attempt to gather the ideas and
>> contributions :-). Feel free to comment, change and so on
> I think it is just time to heat up the discussion about this.
> Some additions I can think of:
> ---
> Error handling: die is not right for production, but a complex if
> is not needed, either one can use a user defined error function,
> or more easily can use trigger_error(), or user_error(), which
> adds much more options and possibilities than using die, and
> is completely appropriate to use in production:
> $conn = mysql_connect(...) or user_error("Cannot connect", E_USER_ERROR);
> This will cause the script to stop running, and to print out a
> PHP style error message by default. But php.ini can be set up
> to redirect this to syslog, or use a special error handling function.
> IMHO use this way of error handling in examples. Why we use it,
> should be explained in the "error handling" and/or "about the manual"
> parts.
> ---
> Sample outputs: in exmaple is not allowed, so the screen example
> in your draft wont work with docbook. Need to invent some other
> type of output.
> ---
> It would be nice to hear what others think about this draft, as we can
> only make things standards after proper discussion, but it would be nice
> to have a standard in a short term.
+1 for trigger_error(); -1 for user_error: alias for trigger_error
syslog seems always a bit suspicious to me. Depending on the webserver
configuration, that user may have insufficient rights to write into??
On win detailed tuning of user-rights maybe neceessary (ok, you talked
about production sites, but there maybe also some sites running on w2k
or winnt :-) )
$conn = mysql_connect(...) or user_error("Cannot connect", E_USER_ERROR);
lacks flexibility, not in error_handling but the in the or construct. Philip
Olson dropped a note about this in a recent mail.
Therefore my suggestion:
$conn = mysql_connect(...);
if !("whatever");
doSomething();
echo 'output stuff';
trigger_error("Cannot connect", E_USER_ERROR);
(Sample output:
not as familiar to docbook as you are.
Therefore i just copied this from array.xml; first example with screen..
Btw. there are many differrent ways used with this thing.)
0ne comment to strings and variables and output with echo:
echo $string, "blabla", .; maybe an alternative?
Friedhelm
[PHP-DOC] array.xml examples or
hello, i noted that in array.xml: 368 This makes $result have 626 This makes $result have 1519 This makes both $result and but 1049 The $result will be: 1114 The $result will be: should we use both of them or only tag? -- Marco Cucinato
[PHP-DOC] array_unique example
at line 1989, the example for PHP 4.0.6 reads
array(2) {
[3]=>
int(4)
[4]=>
int(3)
}
but both my PHP 4.0.6 and 4.1.1 say instead
array(2) {
[0]=>
int(4)
[2]=>
string(1) "3"
}
can somebody try and confirm it?
--
Marco Cucinato
[PHP-DOC] cvs: phpdoc /howto howto.xml
mk Wed Jan 9 05:27:15 2002 EDT Modified files: /phpdoc/howto howto.xml Log: Added a point for me to TODO Index: phpdoc/howto/howto.xml diff -u phpdoc/howto/howto.xml:1.23 phpdoc/howto/howto.xml:1.24 --- phpdoc/howto/howto.xml:1.23 Wed Jan 9 05:02:42 2002 +++ phpdoc/howto/howto.xml Wed Jan 9 05:27:15 2002 @@ -45,7 +45,11 @@ - description for SGML_CATALOG_FILES environment variable (http://docbook.sourceforge.net/projects/dsssl/doc/install.html) - link to http://docbook.sourceforge.net/ - + + [From Mark Kronsbein:] + - Add list of cygwin-packages needed for building if someone does +not want to install the whole cygwin stuff. + -->
Re: [PHP-DOC] cvs: phpdoc / Makefile.in
> hholzgra Tue Jan 8 17:26:34 2002 EDT > > Modified files: > /phpdoc Makefile.in > Log: > PLEASE TEST THIS OUT! > > i have tried to clean up the makefile by using as much > implicit suffix rules as possible ... make test, make howto and make howtotgz worked for under cygwin. Please, please add a PHP test for Windows users, as I asked in one of my last emails. A test for ../phpdoc-tools/php.bat would be nice :) Goba
Re: [PHP-DOC] coding standards - draft
> Thanks for your additions. Looking forward for more.:-)
> I tried to incorporate them, also the contributions from the other people.
> Have a look online http://www.holliwell.de/draft/draft1
> or download at http://www.holliwell.de/draft/draft1.tar.gz (about 4kb)
> Keep in mind it`s a draft and just an attempt to gather the ideas and
> contributions :-). Feel free to comment, change and so on
I think it is just time to heat up the discussion about this.
Some additions I can think of:
---
Error handling: die is not right for production, but a complex if
is not needed, either one can use a user defined error function,
or more easily can use trigger_error(), or user_error(), which
adds much more options and possibilities than using die, and
is completely appropriate to use in production:
$conn = mysql_connect(...) or user_error("Cannot connect", E_USER_ERROR);
This will cause the script to stop running, and to print out a
PHP style error message by default. But php.ini can be set up
to redirect this to syslog, or use a special error handling function.
IMHO use this way of error handling in examples. Why we use it,
should be explained in the "error handling" and/or "about the manual"
parts.
---
Sample outputs: in exmaple is not allowed, so the screen example
in your draft wont work with docbook. Need to invent some other
type of output.
---
It would be nice to hear what others think about this draft, as we can
only make things standards after proper discussion, but it would be nice
to have a standard in a short term.
Goba
[PHP-DOC] cvs: phpdoc /howto howto.html.tar.gz
gobaWed Jan 9 05:05:43 2002 EDT Modified files: /phpdoc/howto howto.html.tar.gz Log: New Howto HTML files Index: phpdoc/howto/howto.html.tar.gz
[PHP-DOC] cvs: phpdoc /howto howto.xml
gobaWed Jan 9 05:02:43 2002 EDT Modified files: /phpdoc/howto howto.xml Log: Add some TODO lines, to be sure I won't forget about them Index: phpdoc/howto/howto.xml diff -u phpdoc/howto/howto.xml:1.22 phpdoc/howto/howto.xml:1.23 --- phpdoc/howto/howto.xml:1.22 Mon Jan 7 06:35:14 2002 +++ phpdoc/howto/howto.xml Wed Jan 9 05:02:42 2002 @@ -24,6 +24,15 @@ Work on Emacs and vi sections Partical advice for manual writers Using translation.xml and CREDITS comments +Separate conventions to parts, eg. + - larger sections (eg. function explanations) + - type, function and other tags, + - PHP code writing guidelines +A short section about the most important docbook tags + + More info +About configure command line options +On file names, and phpdoc logical directory stucture Notes need to be added: Look inside the TODO file, and use it
Re: [PHP-DOC] strings.xml
> I wanted to add references to preg_match and preg_replace functions > beside ereg and ereg_replace in the english strings.xml, but I've > "insufficient karma". > > Please someone, commit it - I attached the zip file > (beware the revision number, obviously i cannot tell it) As you modified array.xml in the English tree already, you have sufficient karma (except if someone revoked the karma from you, which I cannot think of). Please log in using your cvs id, and use a tree checked out with your id, and all commits will go though to the en tree. There are no karma rules for subtrees in phpdoc as I know. Goba
Re: [PHP-DOC] cvs: phpdoc /en/functions sockets.xml
> > Can we please agree that a function whose primary return > > type is LONG/STRING/ARRAY/RESOURE/OBJECT and which may return > > FALSE/NULL _only_ in error condition has _not_ a mixed return > > value but has listed only its primary return value. > > > > Its less intuitive for users "mixed? was it now int or > > string.. or even array ?" but it rather makes sense that > > almost all functions return NULL/FALSE when encountering > > error conditions without setting the return type to mixed > > explicitely. > > +1 +1 Added to conventions in the howto. Also added a note about using &return.success; in TRUE/FALSE only cases. Goba
[PHP-DOC] cvs: phpdoc /howto working.xml
gobaWed Jan 9 04:44:42 2002 EDT Modified files: /phpdoc/howto working.xml Log: Add new convention, as noone complained about it till this time :) Index: phpdoc/howto/working.xml diff -u phpdoc/howto/working.xml:1.12 phpdoc/howto/working.xml:1.13 --- phpdoc/howto/working.xml:1.12 Sat Dec 15 05:34:33 2001 +++ phpdoc/howto/working.xmlWed Jan 9 04:44:42 2002 @@ -192,6 +192,17 @@ --Jeroen, since it can be either array or string. + + + Do not use mixed, if the return + value is of a certain (not boolen) type, and FALSE + only on error. Provide the primary return type as + the return type of the function, and write down in + the explanation, that it returns FALSE on error. + Use &return.success; if the + function returns TRUE on success, and FALSE on + failure. + If a function requires no arguments, use
[PHP-DOC] cvs: phpdoc /it translation.xml
cucinatoWed Jan 9 04:02:18 2002 EDT Modified files: /phpdoc/it translation.xml Log: typo fixed Index: phpdoc/it/translation.xml diff -u phpdoc/it/translation.xml:1.8 phpdoc/it/translation.xml:1.9 --- phpdoc/it/translation.xml:1.8 Tue Jan 8 12:00:44 2002 +++ phpdoc/it/translation.xml Wed Jan 9 04:02:15 2002 @@ -49,7 +49,7 @@ - +
