From b4fabcdafb9d8c2dbdbfb612e3c8d900dbcba891 Mon Sep 17 00:00:00 2001 From: Hannes Magnusson Date: Sun, 16 Dec 2007 11:57:07 +0000 Subject: [PATCH] MFB: Upgrade to the new-reference-structure - Moved the intro from reference.xml to book.xml - Change the intro ID to intro. - Moved the setup sections to setup.xml - Changed the constants section to be git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248351 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/dbplus/book.xml | 57 ++++++++++++++++++ reference/dbplus/constants.xml | 6 +- reference/dbplus/reference.xml | 74 ++--------------------- reference/dbplus/setup.xml | 73 +++++++++++++++++++++++ reference/dbx/book.xml | 54 +++++++++++++++++ reference/dbx/constants.xml | 6 +- reference/dbx/reference.xml | 104 ++------------------------------ reference/dbx/setup.xml | 106 +++++++++++++++++++++++++++++++++ reference/dio/book.xml | 57 ++++++++++++++++++ reference/dio/constants.xml | 6 +- reference/dio/reference.xml | 59 ++---------------- reference/dio/setup.xml | 57 ++++++++++++++++++ reference/dir/book.xml | 43 +++++++++++++ reference/dir/constants.xml | 6 +- reference/dir/reference.xml | 64 +++++--------------- reference/dir/setup.xml | 57 ++++++++++++++++++ reference/domxml/book.xml | 75 +++++++++++++++++++++++ reference/domxml/constants.xml | 6 +- reference/domxml/reference.xml | 68 +++------------------ reference/domxml/setup.xml | 63 ++++++++++++++++++++ 20 files changed, 694 insertions(+), 347 deletions(-) create mode 100644 reference/dbplus/book.xml create mode 100644 reference/dbplus/setup.xml create mode 100644 reference/dbx/book.xml create mode 100644 reference/dbx/setup.xml create mode 100644 reference/dio/book.xml create mode 100644 reference/dio/setup.xml create mode 100644 reference/dir/book.xml create mode 100644 reference/dir/setup.xml create mode 100644 reference/domxml/book.xml create mode 100644 reference/domxml/setup.xml diff --git a/reference/dbplus/book.xml b/reference/dbplus/book.xml new file mode 100644 index 0000000000..1612b7658f --- /dev/null +++ b/reference/dbplus/book.xml @@ -0,0 +1,57 @@ + + + + + + + + DB++ + + + + &reftitle.intro; + + db++, made by the German company Concept asa, is a relational + database system with high performance and low memory and disk + usage in mind. While providing SQL as an additional language + interface, it is not really a SQL database in the first place but + provides its own AQL query language which is much more influenced + by the relational algebra than SQL is. + + + Concept asa always had an interest in supporting open source + languages, db++ has had Perl and Tcl call interfaces for years + now and uses Tcl as its internal stored procedure language. + + &warn.experimental; + + + + &reference.dbplus.setup; + &reference.dbplus.constants; + &reference.dbplus.reference; + + + + + diff --git a/reference/dbplus/constants.xml b/reference/dbplus/constants.xml index 6eb1a976cc..079e52ce65 100644 --- a/reference/dbplus/constants.xml +++ b/reference/dbplus/constants.xml @@ -1,6 +1,6 @@ - -
+ + &reftitle.constants; &extension.constants;
@@ -343,7 +343,7 @@
-
+ - - - + - - DB++ Functions - DB++ + + DB++ &Functions; - - &warn.experimental; - -
- &reftitle.intro; - - db++, made by the German company Concept asa, is a relational - database system with high performance and low memory and disk - usage in mind. While providing SQL as an additional language - interface, it is not really a SQL database in the first place but - provides its own AQL query language which is much more influenced - by the relational algebra than SQL is. - - - Concept asa always had an interest in supporting open source - languages, db++ has had Perl and Tcl call interfaces for years - now and uses Tcl as its internal stored procedure language. - -
+ &reference.dbplus.entities.functions; -
- &reftitle.required; - - This extension relies on external client libraries so you have - to have a db++ client installed on the system you want to use - this extension on. - - - Concept asa provides - db++ Demo versions - and documentation - for Linux, some other Unix versions. There is also a Windows - version of db++, but this extension doesn't support it (yet). - -
- - &reference.dbplus.configure; - -
- &reftitle.runtime; - &no.config; -
- -
- &reftitle.resources; -
- dbplus_relation - - Most db++ functions operate on or return - dbplus_relation resources. A - dbplus_relation is a handle to a stored - relation or a relation generated as the result of a query. - -
-
+ - &reference.dbplus.constants; - - - -&reference.dbplus.entities.functions; - - + + + &reftitle.setup; + + +
+ &reftitle.required; + + This extension relies on external client libraries so you have + to have a db++ client installed on the system you want to use + this extension on. + + + Concept asa provides + db++ Demo versions + and documentation + for Linux, some other Unix versions. There is also a Windows + version of db++, but this extension doesn't support it (yet). + +
+ + + + &reference.dbplus.configure; + + + +
+ &reftitle.runtime; + &no.config; +
+ + + +
+ &reftitle.resources; +
+ dbplus_relation + + Most db++ functions operate on or return + dbplus_relation resources. A + dbplus_relation is a handle to a stored + relation or a relation generated as the result of a query. + +
+
+ + + + + + diff --git a/reference/dbx/book.xml b/reference/dbx/book.xml new file mode 100644 index 0000000000..fa6a9238e8 --- /dev/null +++ b/reference/dbx/book.xml @@ -0,0 +1,54 @@ + + + + + + + dbx + + + + &reftitle.intro; + + The dbx module is a database abstraction layer (db 'X', where 'X' + is a supported database). The dbx functions allow you to access + all supported databases using a single calling convention. + The dbx-functions themselves do not interface directly to the + databases, but interface to the modules that are used to support + these databases. + + + + &pecl.moved-ver;5.1.0. + + + + + + &reference.dbx.setup; + &reference.dbx.constants; + &reference.dbx.reference; + + + + + diff --git a/reference/dbx/constants.xml b/reference/dbx/constants.xml index d2f3c9e594..3b405407c6 100644 --- a/reference/dbx/constants.xml +++ b/reference/dbx/constants.xml @@ -1,6 +1,6 @@ - -
+ + &reftitle.constants; &extension.constants; @@ -236,7 +236,7 @@ -
+ - - + - - dbx Functions - dbx + + dbx &Functions; - -
- &reftitle.intro; - - The dbx module is a database abstraction layer (db 'X', where 'X' - is a supported database). The dbx functions allow you to access - all supported databases using a single calling convention. - The dbx-functions themselves do not interface directly to the - databases, but interface to the modules that are used to support - these databases. - - - - &pecl.moved-ver;5.1.0. - - -
- -
- &reftitle.required; - - To be able to use a database with the dbx-module, the module must be either - linked or loaded into PHP, and the database module must be supported by the - dbx-module. Currently, the following databases are supported, but others - will follow: - - - - FrontBase (available from PHP 4.1.0). - - - - - Microsoft SQL Server - - - - - MySQL - - - - - ODBC - - - - - PostgreSQL - - - - - Sybase-CT (available from PHP 4.2.0). - - - - - Oracle (oci8) (available from PHP 4.3.0). - - - - - SQLite (PHP 5). - - - - - - Documentation for adding additional database support to dbx can be - found at &url.dbx.docs;. - -
+ &reference.dbx.entities.functions; - &reference.dbx.configure; - - &reference.dbx.ini; - -
- &reftitle.resources; - - There are two resource types used in the dbx module. The first one is the - link-object for a database connection, the second a - result-object which holds the result of a query. - -
- - &reference.dbx.constants; - - - -&reference.dbx.entities.functions; - - + + + + &reftitle.setup; + + +
+ &reftitle.required; + + To be able to use a database with the dbx-module, the module must be either + linked or loaded into PHP, and the database module must be supported by the + dbx-module. Currently, the following databases are supported, but others + will follow: + + + + FrontBase (available from PHP 4.1.0). + + + + + Microsoft SQL Server + + + + + MySQL + + + + + ODBC + + + + + PostgreSQL + + + + + Sybase-CT (available from PHP 4.2.0). + + + + + Oracle (oci8) (available from PHP 4.3.0). + + + + + SQLite (PHP 5). + + + + + + Documentation for adding additional database support to dbx can be + found at &url.dbx.docs;. + +
+ + + + &reference.dbx.configure; + + + + &reference.dbx.ini; + + + +
+ &reftitle.resources; + + There are two resource types used in the dbx module. The first one is the + link-object for a database connection, the second a + result-object which holds the result of a query. + +
+ + + + + + diff --git a/reference/dio/book.xml b/reference/dio/book.xml new file mode 100644 index 0000000000..30a7c0041e --- /dev/null +++ b/reference/dio/book.xml @@ -0,0 +1,57 @@ + + + + + Direct IO &Functions; + + + + &reftitle.intro; + + PHP supports the direct io functions as described in the Posix + Standard (Section 6) for performing I/O functions at a lower + level than the C-Language stream I/O functions + (fopen, fread,..). The use + of the DIO functions should be considered only when direct + control of a device is needed. In all other cases, the standard + filesystem functions are more + than adequate. + + + + &pecl.moved-ver;5.1.0. + + + + This extension is only available on Windows Platforms as of PHP 5.0.0 + + + + + &reference.dio.setup; + &reference.dio.constants; + &reference.dio.reference; + + + + + diff --git a/reference/dio/constants.xml b/reference/dio/constants.xml index 7e3abc7259..27f4fb4974 100644 --- a/reference/dio/constants.xml +++ b/reference/dio/constants.xml @@ -1,6 +1,6 @@ - -
+ + &reftitle.constants; &extension.constants; @@ -338,7 +338,7 @@ -
+ - - + - - Direct IO Functions - Direct IO + + Direct IO &Functions; - -
- &reftitle.intro; - - PHP supports the direct io functions as described in the Posix - Standard (Section 6) for performing I/O functions at a lower - level than the C-Language stream I/O functions - (fopen, fread,..). The use - of the DIO functions should be considered only when direct - control of a device is needed. In all other cases, the standard - filesystem functions are more - than adequate. - - - - &pecl.moved-ver;5.1.0. - - - - This extension is only available on Windows Platforms as of PHP 5.0.0 - -
+ &reference.dio.entities.functions; -
- &reftitle.required; - &no.requirement; -
- - &reference.dio.configure; - &reference.dio.constants; - -
- &reftitle.runtime; - &no.config; -
- -
- &reftitle.resources; - - One resource type is defined by this extension: - a file descriptor returned by dio_open. - -
- - - -&reference.dio.entities.functions; - - + + + + &reftitle.setup; + + +
+ &reftitle.required; + &no.requirement; +
+ + + + &reference.dio.configure; + + + +
+ &reftitle.runtime; + &no.config; +
+ + + +
+ &reftitle.resources; + + One resource type is defined by this extension: + a file descriptor returned by dio_open. + +
+ + + + + + diff --git a/reference/dir/book.xml b/reference/dir/book.xml new file mode 100644 index 0000000000..7d5adecd24 --- /dev/null +++ b/reference/dir/book.xml @@ -0,0 +1,43 @@ + + + + + Directory &Functions; + Directories + + + + &reference.dir.setup; + &reference.dir.constants; + &reference.dir.reference; + + + + + diff --git a/reference/dir/constants.xml b/reference/dir/constants.xml index c28d263ff7..577b2d1a8d 100644 --- a/reference/dir/constants.xml +++ b/reference/dir/constants.xml @@ -1,6 +1,6 @@ - -
+ + &reftitle.constants; &extension.constants; @@ -32,7 +32,7 @@ The PATH_SEPARATOR was introduced with PHP 4.3.0-RC2. -
+ - - + - - Directory Functions - Directories + + Directory &Functions; + Directories - + + &reftitle.seealso; + + For related functions such as dirname, + is_dir, mkdir, and + rmdir, see the + Filesystem section. + + -
- &reftitle.intro; - - -
- -
- &reftitle.required; - &no.requirement; -
- -
- &reftitle.install; - &no.install; -
+ &reference.dir.entities.functions; -
- &reftitle.runtime; - &no.config; -
+ -
- &reftitle.resources; - - -
- - &reference.dir.constants; - -
- &reftitle.seealso; - - For related functions such as dirname, - is_dir, mkdir, and - rmdir, see the - Filesystem section. - -
- - - -&reference.dir.entities.functions; - - + + + &reftitle.setup; + + +
+ &reftitle.required; + &no.requirement; +
+ + + +
+ &reftitle.install; + &no.install; +
+ + + +
+ &reftitle.runtime; + &no.config; +
+ + + +
+ &reftitle.resources; + &no.resource; +
+ + + + + + diff --git a/reference/domxml/book.xml b/reference/domxml/book.xml new file mode 100644 index 0000000000..968dd67dbc --- /dev/null +++ b/reference/domxml/book.xml @@ -0,0 +1,75 @@ + + + + + + + DOM XML + + + + &reftitle.intro; + + The DOM XML extension has been overhauled in PHP 4.3.0 to better comply with + the DOM standard. The extension still contains + many old functions, but they should no longer be used. In particular, functions + that are not object-oriented should be avoided. + + + The extension allows you to operate on an XML document with the DOM API. + It also provides a function domxml_xmltree to turn the + complete XML document into a tree of PHP objects. Currently, this + tree should be considered read-only - you can modify it, but this + would not make any sense since DomDocument_dump_mem + cannot be + applied to it. Therefore, if you want to read an XML file and write + a modified version, use DomDocument_create_element, + DomDocument_create_text_node, + set_attribute, etc. and finally the + DomDocument_dump_mem function. + + + + &pecl.moved-ver;5.0.0. + + + + + This extension is no longer marked experimental. It will, however, never + be released with PHP 5, and will only be distributed with PHP 4. + If you need DOM XML support with PHP 5 you can use the + DOM extension. This + domxml extension is not compatible with the + DOM extension. + + + + + + &reference.domxml.setup; + &reference.domxml.constants; + &reference.domxml.reference; + + + + + diff --git a/reference/domxml/constants.xml b/reference/domxml/constants.xml index dca467bca5..e7a0582bbd 100644 --- a/reference/domxml/constants.xml +++ b/reference/domxml/constants.xml @@ -1,6 +1,6 @@ - -
+ + &reftitle.constants; &extension.constants; @@ -334,7 +334,7 @@ no someone familiar with this extension should do further work.
-
+ - - + - DOM XML Functions - DOM XML + DOM XML &Functions; -
- &reftitle.intro; - - The DOM XML extension has been overhauled in PHP 4.3.0 to better comply with - the DOM standard. The extension still contains - many old functions, but they should no longer be used. In particular, functions - that are not object-oriented should be avoided. - - - The extension allows you to operate on an XML document with the DOM API. - It also provides a function domxml_xmltree to turn the - complete XML document into a tree of PHP objects. Currently, this - tree should be considered read-only - you can modify it, but this - would not make any sense since DomDocument_dump_mem - cannot be - applied to it. Therefore, if you want to read an XML file and write - a modified version, use DomDocument_create_element, - DomDocument_create_text_node, - set_attribute, etc. and finally the - DomDocument_dump_mem function. - - - - &pecl.moved-ver;5.0.0. - - - - - This extension is no longer marked experimental. It will, however, never - be released with PHP 5, and will only be distributed with PHP 4. - If you need DOM XML support with PHP 5 you can use the - DOM extension. This - domxml extension is not compatible with the - DOM extension. - - -
- -
- &reftitle.required; - - This extension makes use of the - GNOME XML library. Download - and install this library. You will need at least libxml-2.4.14. - To use DOM XSLT features you can use the - libxslt library and EXSLT - enhancements from &url.exslt;. - Download and install these libraries if you plan to use (enhanced) XSLT - features. You will need at least libxslt-1.0.18. - -
- - &reference.domxml.configure; -
Deprecated functions @@ -175,8 +118,11 @@
- &reference.domxml.constants; - +
Classes diff --git a/reference/domxml/setup.xml b/reference/domxml/setup.xml new file mode 100644 index 0000000000..c2376466fe --- /dev/null +++ b/reference/domxml/setup.xml @@ -0,0 +1,63 @@ + + + + + &reftitle.setup; + + +
+ &reftitle.required; + + This extension makes use of the + GNOME XML library. Download + and install this library. You will need at least libxml-2.4.14. + To use DOM XSLT features you can use the + libxslt library and EXSLT + enhancements from &url.exslt;. + Download and install these libraries if you plan to use (enhanced) XSLT + features. You will need at least libxslt-1.0.18. + +
+ + + + &reference.domxml.configure; + + + +
+ &reftitle.runtime; + &no.config; +
+ + + +
+ &reftitle.resources; + &no.resource; +
+ + + + + +