| Home | Trees | Indices | Help |
|
|---|
|
|
This file is part of the web2py Web Framework Copyrighted by Massimo Di Pierro <mdipierro@cs.depaul.edu> License: LGPLv3 (http://www.gnu.org/licenses/lgpl.html)
|
|||
| |||
|
|||
| A | |||
| B | |||
|
BEAUTIFY example:: |
|||
| BODY | |||
| BR | |||
| CAT | |||
| CENTER | |||
|
CLEANUP example: |
|||
|
CODE displays code in HTML with syntax highlighting. |
|||
|
CRYPT example:: |
|||
|
DAL an instance of this class represents a database connection |
|||
|
DIV HTML helper, for easy generating and manipulating a DOM structure. |
|||
| EM | |||
| EMBED | |||
| FIELDSET | |||
|
FORM example: |
|||
| Field | |||
| H1 | |||
| H2 | |||
| H3 | |||
| H4 | |||
| H5 | |||
| H6 | |||
| HEAD | |||
| HR | |||
|
HTML There are four predefined document type definitions. |
|||
| HTTP | |||
| I | |||
| IFRAME | |||
| IMG | |||
|
INPUT INPUT Component |
|||
|
IS_ALPHANUMERIC example: |
|||
|
IS_DATE example: |
|||
|
IS_DATETIME example: |
|||
|
IS_DATETIME_IN_RANGE example: |
|||
|
IS_DATE_IN_RANGE example: |
|||
|
IS_DECIMAL_IN_RANGE Determine that the argument is (or can be represented as) a Python Decimal, and that it falls within the specified inclusive range. |
|||
|
IS_EMAIL Checks if field's value is a valid email address. |
|||
|
IS_EMPTY_OR dummy class for testing IS_EMPTY_OR |
|||
|
IS_EQUAL_TO example: |
|||
|
IS_EXPR example: |
|||
|
IS_FLOAT_IN_RANGE Determine that the argument is (or can be represented as) a float, and that it falls within the specified inclusive range. |
|||
|
IS_IMAGE Checks if file uploaded through file input was saved in one of selected image formats and has dimensions (width and height) within given boundaries. |
|||
|
IS_INT_IN_RANGE Determine that the argument is (or can be represented as) an int, and that it falls within the specified range. |
|||
|
IS_IN_DB example: |
|||
|
IS_IN_SET example: |
|||
|
IS_IPV4 Checks if field's value is an IP version 4 address in decimal form. |
|||
|
IS_JSON example: |
|||
|
IS_LENGTH Checks if length of field's value fits between given boundaries. |
|||
| IS_LIST_OF | |||
|
IS_LIST_OF_EMAILS use as follows:... |
|||
|
IS_LOWER convert to lower case |
|||
|
IS_MATCH example: |
|||
|
IS_NOT_EMPTY example: |
|||
|
IS_NOT_IN_DB example: |
|||
|
IS_NULL_OR dummy class for testing IS_EMPTY_OR |
|||
|
IS_SLUG convert arbitrary text string to a slug |
|||
|
IS_STRONG example: |
|||
|
IS_TIME example: |
|||
|
IS_UPLOAD_FILENAME Checks if name and extension of file uploaded through file input matches given criteria. |
|||
|
IS_UPPER convert to upper case |
|||
|
IS_URL Rejects a URL string if any of the following is true: * The string is empty or None * The string uses characters that are not allowed in a URL * The string breaks any of the HTTP syntactic rules * The URL scheme specified (if one is specified) is not 'http' or 'https' * The top-level domain (if a host name is specified) does not exist |
|||
| LABEL | |||
| LEGEND | |||
| LI | |||
| LINK | |||
|
MARKMIN For documentation: http://web2py.com/examples/static/markmin.html |
|||
|
MENU Used to build menus |
|||
| META | |||
| OBJECT | |||
| OL | |||
| OPTGROUP | |||
| OPTION | |||
|
P Will replace ``\n`` by ``<br />`` if the `cr2br` attribute is provided. |
|||
| PRE | |||
| SCRIPT | |||
|
SELECT example: |
|||
| SPAN | |||
|
SQLFORM SQLFORM is used to map a table (and a current record) into an HTML form |
|||
|
SQLTABLE given a Rows object, as returned by a db().select(), generates an html table with the rows. |
|||
| STRONG | |||
| STYLE | |||
|
TABLE TABLE Component. |
|||
| TBODY | |||
| TD | |||
|
TEXTAREA example: |
|||
| TFOOT | |||
| TH | |||
| THEAD | |||
| TITLE | |||
|
TR TR Component. |
|||
| TT | |||
|
UL UL Component. |
|||
|
XHTML This is XHTML version of the HTML helper. |
|||
|
XML use it to wrap a string that contains XML/HTML so that it will not be escaped by the template |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
LOAD a component into the action's document Timing options: -times: An integer or string ("infinity"/"continuous") specifies how many times the component is requested -timeout (milliseconds): specifies the time to wait before starting the request or the frequency if times is greater than 1 or "infinity". Timing options default to the normal behavior. The component is added on page loading without delay. |
generate a URL
example::
>>> str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'],
... vars={'p':1, 'q':2}, anchor='1'))
'/a/c/f/x/y/z?p=1&q=2#1'
>>> str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'],
... vars={'p':(1,3), 'q':2}, anchor='1'))
'/a/c/f/x/y/z?p=1&p=3&q=2#1'
>>> str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'],
... vars={'p':(3,1), 'q':2}, anchor='1'))
'/a/c/f/x/y/z?p=3&p=1&q=2#1'
>>> str(URL(a='a', c='c', f='f', anchor='1+2'))
'/a/c/f#1%2B2'
>>> str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'],
... vars={'p':(1,3), 'q':2}, anchor='1', hmac_key='key'))
'/a/c/f/x/y/z?p=1&p=3&q=2&_signature=a32530f0d0caa80964bb92aad2bedf8a4486a31f#1'
>>> str(URL(a='a', c='c', f='f', args=['w/x', 'y/z']))
'/a/c/f/w/x/y/z'
>>> str(URL(a='a', c='c', f='f', args=['w/x', 'y/z'], encode_embedded_slash=True))
'/a/c/f/w%2Fx/y%2Fz'
>>> str(URL(a='a', c='c', f='f', args=['%(id)d'], url_encode=False))
'/a/c/f/%(id)d'
>>> str(URL(a='a', c='c', f='f', args=['%(id)d'], url_encode=True))
'/a/c/f/%25%28id%29d'
>>> str(URL(a='a', c='c', f='f', vars={'id' : '%(id)d' }, url_encode=False))
'/a/c/f?id=%(id)d'
>>> str(URL(a='a', c='c', f='f', vars={'id' : '%(id)d' }, url_encode=True))
'/a/c/f?id=%25%28id%29d'
>>> str(URL(a='a', c='c', f='f', anchor='%(id)d', url_encode=False))
'/a/c/f#%(id)d'
>>> str(URL(a='a', c='c', f='f', anchor='%(id)d', url_encode=True))
'/a/c/f#%25%28id%29d'
generates a url '/a/c/f' corresponding to application a, controller c
and function f. If r=request is passed, a, c, f are set, respectively,
to r.application, r.controller, r.function.
The more typical usage is:
URL(r=request, f='index') that generates a url for the index function
within the present application and controller.
:param a: application (default to current if r is given)
:param c: controller (default to current if r is given)
:param f: function (default to current if r is given)
:param r: request (optional)
:param args: any arguments (optional)
:param vars: any variables (optional)
:param anchor: anchorname, without # (optional)
:param hmac_key: key to use when generating hmac signature (optional)
:param hash_vars: which of the vars to include in our hmac signature
True (default) - hash all vars, False - hash none of the vars,
iterable - hash only the included vars ['key1','key2']
:param scheme: URI scheme (True, 'http' or 'https', etc); forces absolute URL (optional)
:param host: string to force absolute URL with host (True means http_host)
:param port: optional port number (forces absolute URL)
:raises SyntaxError: when no application, controller or function is
available
:raises SyntaxError: when a CRLF is found in the generated url
|
helper to encode the provided (binary) data into base64. :param filename: if provided, opens and reads this file in 'rb' mode :param file: if provided, reads this file :param data: if provided, uses the provided data |
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Mon Oct 14 15:16:59 2013 | http://epydoc.sourceforge.net |