From 94a15f85a64db283a9c9402c40b2d35cb484fb37 Mon Sep 17 00:00:00 2001
From: Andreas Fischer <bantu@phpbb.com>
Date: Wed, 27 Mar 2013 18:06:48 +0100
Subject: [ticket/11469] Add example code to class documentation.

PHPBB3-11469
---
 phpBB/includes/db/sql_insert_buffer.php | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'phpBB/includes/db')

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
-- 
cgit v1.2.1