aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes
diff options
context:
space:
mode:
authorAndreas Fischer <bantu@phpbb.com>2013-03-27 18:06:48 +0100
committerAndreas Fischer <bantu@phpbb.com>2013-03-27 18:11:31 +0100
commit94a15f85a64db283a9c9402c40b2d35cb484fb37 (patch)
tree842f44e8cb435a4d6225bc31e310fa7e13c85922 /phpBB/includes
parentfc8bf3f3c767067a03d240403598d62fb22ce889 (diff)
downloadforums-94a15f85a64db283a9c9402c40b2d35cb484fb37.tar
forums-94a15f85a64db283a9c9402c40b2d35cb484fb37.tar.gz
forums-94a15f85a64db283a9c9402c40b2d35cb484fb37.tar.bz2
forums-94a15f85a64db283a9c9402c40b2d35cb484fb37.tar.xz
forums-94a15f85a64db283a9c9402c40b2d35cb484fb37.zip
[ticket/11469] Add example code to class documentation.
PHPBB3-11469
Diffstat (limited to 'phpBB/includes')
-rw-r--r--phpBB/includes/db/sql_insert_buffer.php15
1 files changed, 15 insertions, 0 deletions
diff --git a/phpBB/includes/db/sql_insert_buffer.php b/phpBB/includes/db/sql_insert_buffer.php
index fe45206893..772f368987 100644
--- a/phpBB/includes/db/sql_insert_buffer.php
+++ b/phpBB/includes/db/sql_insert_buffer.php
@@ -19,6 +19,21 @@ if (!defined('IN_PHPBB'))
* Collects rows for insert into a database until the buffer size is reached.
* Then flushes the buffer to the database and starts over again.
*
+* Usage:
+* <code>
+* $buffer = new phpbb_db_sql_insert_buffer($db, 'test_table', 1234);
+*
+* while (do_stuff())
+* {
+* $buffer->insert(array(
+* 'column1' => 'value1',
+* 'column2' => 'value2',
+* ));
+* }
+*
+* $buffer->flush();
+* </code>
+*
* @package dbal
*/
class phpbb_db_sql_insert_buffer