doc/book/en/devrepo/devcore/reqbase.rst
branchstable
changeset 5394 105011657405
parent 5257 a31fbcfa8c3b
child 5400 b7ab099b128a
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/book/en/devrepo/devcore/reqbase.rst	Fri Apr 23 17:31:46 2010 +0200
@@ -0,0 +1,32 @@
+Request and ResultSet methods
+-----------------------------
+
+Those are methods you'll find on both request objects and on repository session:
+
+:URL handling:
+  * `build_url(*args, **kwargs)`, returns an absolute URL based on the
+    given arguments. The *controller* supposed to handle the response,
+    can be specified through the first positional parameter (the
+    connection is theoretically done automatically :).
+:Data formatting:
+  * `format_date(date, date_format=None, time=False)` returns a string for a
+    date time according to instance's configuration
+
+  * `format_time(time)` returns a string for a date time according to
+    instance's configuration
+
+:And more...:
+
+  * `tal_render(template, variables)`, renders a precompiled page template with
+    variables in the given dictionary as context
+
+
+Result set methods:
+
+  * `get_entity(row, col)`, returns the entity corresponding to the data position
+    in the *result set*
+
+  * `complete_entity(row, col, skip_bytes=True)`, is equivalent to `get_entity` but
+    also call the method `complete()` on the entity before returning it
+
+