From c9cbb1a2891543bff1c459af18c2c62f47a17d28 Mon Sep 17 00:00:00 2001
From: xue <>
Date: Fri, 18 Nov 2005 00:46:02 +0000
Subject:

---
 framework/Web/THttpResponse.php | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'framework/Web/THttpResponse.php')

diff --git a/framework/Web/THttpResponse.php b/framework/Web/THttpResponse.php
index 6146b4f0..7f70de63 100644
--- a/framework/Web/THttpResponse.php
+++ b/framework/Web/THttpResponse.php
@@ -13,9 +13,19 @@
 /**
  * THttpResponse class
  *
- * THttpResponse implements a scheme to output response to user requests.
+ * THttpResponse implements the mechanism for sending output to client users.
  *
- * THttpResponse is the default "response" module for prado application.
+ * To output a string to client, use {@link write()}. By default, the output is
+ * buffered until {@link flush()} is called or the application ends. The output in
+ * the buffer can also be cleaned by {@link clear()}. To disable output buffering,
+ * set BufferOutput property to false.
+ *
+ * To send cookies to client, use {@link getCookies()}.
+ * To redirect client browser to a new URL, use {@link redirect()}.
+ * To send a file to client, use {@link writeFile()}.
+ *
+ * By default, THttpResponse is registered with {@link TApplication} as the
+ * response module. It can be accessed via {@link TApplication::getResponse()}.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @version $Revision: $  $Date: $
@@ -41,7 +51,7 @@ class THttpResponse extends TComponent implements IModule, ITextWriter
 	 */
 	private $_cookies=null;
 	/**
-	 * @var integer status code
+	 * @var integer response status code
 	 */
 	private $_status=200;
 
-- 
cgit v1.2.3