~ubuntu-branches/debian/jessie/web2py/jessie

« back to all changes in this revision

Viewing changes to applications/examples/static/epydoc/web2py.gluon.html-module.html

  • Committer: Package Import Robot
  • Author(s): José L. Redrejo Rodríguez
  • Date: 2011-11-04 10:12:01 UTC
  • mfrom: (1.1.10)
  • Revision ID: package-import@ubuntu.com-20111104101201-ym8q3030ik8sc10u
Tags: 1.99.2.1-1
* Updated upstream sources with real 1.99.2 version
* Ensure python-gtk2 is not needed to run web2py, fixing 
  debian/patches/gtk_gui (Closes: #646931)
* Refreshed debian/patches/avoid_updating patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
404
404
        <a href="web2py.gluon.html.TFOOT-class.html" class="summary-name">TFOOT</a>
405
405
    </td>
406
406
  </tr>
407
 
<tr class="private">
 
407
<tr>
408
408
    <td width="15%" align="right" valign="top" class="summary">
409
409
      <span class="summary-type">&nbsp;</span>
410
410
    </td><td class="summary">
411
411
        <a href="web2py.gluon.html.COL-class.html" class="summary-name">COL</a>
412
412
    </td>
413
413
  </tr>
414
 
<tr class="private">
 
414
<tr>
415
415
    <td width="15%" align="right" valign="top" class="summary">
416
416
      <span class="summary-type">&nbsp;</span>
417
417
    </td><td class="summary">
623
623
    </td><td class="summary">
624
624
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
625
625
        <tr>
626
 
          <td><span class="summary-sig"><a href="web2py.gluon.html-module.html#URL" class="summary-sig-name">URL</a>(<span class="summary-sig-arg">a</span>=<span class="summary-sig-default">1</span>,
627
 
        <span class="summary-sig-arg">c</span>=<span class="summary-sig-default">1</span>,
628
 
        <span class="summary-sig-arg">f</span>=<span class="summary-sig-default">1</span>,
629
 
        <span class="summary-sig-arg">r</span>=<span class="summary-sig-default">1</span>,
630
 
        <span class="summary-sig-arg">args</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
631
 
        <span class="summary-sig-arg">vars</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
 
626
          <td><span class="summary-sig"><a href="web2py.gluon.html-module.html#URL" class="summary-sig-name">URL</a>(<span class="summary-sig-arg">a</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
627
        <span class="summary-sig-arg">c</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
628
        <span class="summary-sig-arg">f</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
629
        <span class="summary-sig-arg">r</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
630
        <span class="summary-sig-arg">args</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
631
        <span class="summary-sig-arg">vars</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
632
632
        <span class="summary-sig-arg">anchor</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
633
 
        <span class="summary-sig-arg">extension</span>=<span class="summary-sig-default">1</span>,
634
 
        <span class="summary-sig-arg">env</span>=<span class="summary-sig-default">1</span>,
635
 
        <span class="summary-sig-arg">hmac_key</span>=<span class="summary-sig-default">1</span>,
 
633
        <span class="summary-sig-arg">extension</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
634
        <span class="summary-sig-arg">env</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
635
        <span class="summary-sig-arg">hmac_key</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
636
636
        <span class="summary-sig-arg">hash_vars</span>=<span class="summary-sig-default">True</span>,
637
 
        <span class="summary-sig-arg">salt</span>=<span class="summary-sig-default">1</span>,
638
 
        <span class="summary-sig-arg">user_signature</span>=<span class="summary-sig-default">1</span>,
639
 
        <span class="summary-sig-arg">scheme</span>=<span class="summary-sig-default">1</span>,
640
 
        <span class="summary-sig-arg">host</span>=<span class="summary-sig-default">1</span>,
641
 
        <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">1</span>)</span><br />
 
637
        <span class="summary-sig-arg">salt</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
638
        <span class="summary-sig-arg">user_signature</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
639
        <span class="summary-sig-arg">scheme</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
640
        <span class="summary-sig-arg">host</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
641
        <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
642
        <span class="summary-sig-arg">encode_embedded_slash</span>=<span class="summary-sig-default">True</span>)</span><br />
642
643
      generate a URL
643
644
 
644
645
example::
661
662
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
662
663
        <tr>
663
664
          <td><span class="summary-sig"><a href="web2py.gluon.html-module.html#verifyURL" class="summary-sig-name">verifyURL</a>(<span class="summary-sig-arg">request</span>,
664
 
        <span class="summary-sig-arg">hmac_key</span>=<span class="summary-sig-default">1</span>,
 
665
        <span class="summary-sig-arg">hmac_key</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
665
666
        <span class="summary-sig-arg">hash_vars</span>=<span class="summary-sig-default">True</span>,
666
 
        <span class="summary-sig-arg">salt</span>=<span class="summary-sig-default">1</span>,
667
 
        <span class="summary-sig-arg">user_signature</span>=<span class="summary-sig-default">1</span>)</span><br />
 
667
        <span class="summary-sig-arg">salt</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
668
        <span class="summary-sig-arg">user_signature</span>=<span class="summary-sig-default">global_settings.applications_parent</span>)</span><br />
668
669
      Verifies that a request's args &amp; vars have not been tampered with by the user
669
670
 
670
671
:param request: web2py's request object
750
751
    </td><td class="summary">
751
752
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
752
753
        <tr>
753
 
          <td><span class="summary-sig"><a href="web2py.gluon.html-module.html#embed64" class="summary-sig-name">embed64</a>(<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">1</span>,
754
 
        <span class="summary-sig-arg">file</span>=<span class="summary-sig-default">1</span>,
755
 
        <span class="summary-sig-arg">data</span>=<span class="summary-sig-default">1</span>,
 
754
          <td><span class="summary-sig"><a href="web2py.gluon.html-module.html#embed64" class="summary-sig-name">embed64</a>(<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
755
        <span class="summary-sig-arg">file</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
756
        <span class="summary-sig-arg">data</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
756
757
        <span class="summary-sig-arg">extension</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">image/gif</code><code class="variable-quote">'</code></span>)</span><br />
757
758
      helper to encode the provided (binary) data into base64.</td>
758
759
          <td align="right" valign="top">
788
789
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
789
790
        <tr>
790
791
          <td><span class="summary-sig"><a name="markdown_serializer"></a><span class="summary-sig-name">markdown_serializer</span>(<span class="summary-sig-arg">text</span>,
791
 
        <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">1</span>,
792
 
        <span class="summary-sig-arg">attr</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span></td>
 
792
        <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
793
        <span class="summary-sig-arg">attr</span>=<span class="summary-sig-default">global_settings.applications_parent</span>)</span></td>
793
794
          <td align="right" valign="top">
794
795
            <span class="codelink"><a href="web2py.gluon.html-pysrc.html#markdown_serializer">source&nbsp;code</a></span>
795
796
            
806
807
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
807
808
        <tr>
808
809
          <td><span class="summary-sig"><a name="markmin_serializer"></a><span class="summary-sig-name">markmin_serializer</span>(<span class="summary-sig-arg">text</span>,
809
 
        <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">1</span>,
810
 
        <span class="summary-sig-arg">attr</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span></td>
 
810
        <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
 
811
        <span class="summary-sig-arg">attr</span>=<span class="summary-sig-default">global_settings.applications_parent</span>)</span></td>
811
812
          <td align="right" valign="top">
812
813
            <span class="codelink"><a href="web2py.gluon.html-pysrc.html#markmin_serializer">source&nbsp;code</a></span>
813
814
            
930
931
<tr><td>
931
932
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
932
933
  <tr valign="top"><td>
933
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">URL</span>(<span class="sig-arg">a</span>=<span class="sig-default">1</span>,
934
 
        <span class="sig-arg">c</span>=<span class="sig-default">1</span>,
935
 
        <span class="sig-arg">f</span>=<span class="sig-default">1</span>,
936
 
        <span class="sig-arg">r</span>=<span class="sig-default">1</span>,
937
 
        <span class="sig-arg">args</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
938
 
        <span class="sig-arg">vars</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
 
934
  <h3 class="epydoc"><span class="sig"><span class="sig-name">URL</span>(<span class="sig-arg">a</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
935
        <span class="sig-arg">c</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
936
        <span class="sig-arg">f</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
937
        <span class="sig-arg">r</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
938
        <span class="sig-arg">args</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
939
        <span class="sig-arg">vars</span>=<span class="sig-default">global_settings.applications_parent</span>,
939
940
        <span class="sig-arg">anchor</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
940
 
        <span class="sig-arg">extension</span>=<span class="sig-default">1</span>,
941
 
        <span class="sig-arg">env</span>=<span class="sig-default">1</span>,
942
 
        <span class="sig-arg">hmac_key</span>=<span class="sig-default">1</span>,
 
941
        <span class="sig-arg">extension</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
942
        <span class="sig-arg">env</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
943
        <span class="sig-arg">hmac_key</span>=<span class="sig-default">global_settings.applications_parent</span>,
943
944
        <span class="sig-arg">hash_vars</span>=<span class="sig-default">True</span>,
944
 
        <span class="sig-arg">salt</span>=<span class="sig-default">1</span>,
945
 
        <span class="sig-arg">user_signature</span>=<span class="sig-default">1</span>,
946
 
        <span class="sig-arg">scheme</span>=<span class="sig-default">1</span>,
947
 
        <span class="sig-arg">host</span>=<span class="sig-default">1</span>,
948
 
        <span class="sig-arg">port</span>=<span class="sig-default">1</span>)</span>
 
945
        <span class="sig-arg">salt</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
946
        <span class="sig-arg">user_signature</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
947
        <span class="sig-arg">scheme</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
948
        <span class="sig-arg">host</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
949
        <span class="sig-arg">port</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
950
        <span class="sig-arg">encode_embedded_slash</span>=<span class="sig-default">True</span>)</span>
949
951
  </h3>
950
952
  </td><td align="right" valign="top"
951
953
    ><span class="codelink"><a href="web2py.gluon.html-pysrc.html#URL">source&nbsp;code</a></span>&nbsp;
975
977
 
976
978
    &gt;&gt;&gt; str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'],
977
979
    ...     vars={'p':(1,3), 'q':2}, anchor='1', hmac_key='key'))
978
 
    '/a/c/f/x/y/z?p=1&amp;p=3&amp;q=2&amp;_signature=5d06bb8a4a6093dd325da2ee591c35c61afbd3c6#1'
 
980
    '/a/c/f/x/y/z?p=1&amp;p=3&amp;q=2&amp;_signature=a32530f0d0caa80964bb92aad2bedf8a4486a31f#1'
 
981
 
 
982
    &gt;&gt;&gt; str(URL(a='a', c='c', f='f', args=['w/x', 'y/z']))
 
983
    '/a/c/f/w/x/y/z'
 
984
 
 
985
    &gt;&gt;&gt; str(URL(a='a', c='c', f='f', args=['w/x', 'y/z'], encode_embedded_slash=True))
 
986
    '/a/c/f/w%2Fx/y%2Fz'
979
987
 
980
988
generates a url '/a/c/f' corresponding to application a, controller c
981
989
and function f. If r=request is passed, a, c, f are set, respectively,
1018
1026
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1019
1027
  <tr valign="top"><td>
1020
1028
  <h3 class="epydoc"><span class="sig"><span class="sig-name">verifyURL</span>(<span class="sig-arg">request</span>,
1021
 
        <span class="sig-arg">hmac_key</span>=<span class="sig-default">1</span>,
 
1029
        <span class="sig-arg">hmac_key</span>=<span class="sig-default">global_settings.applications_parent</span>,
1022
1030
        <span class="sig-arg">hash_vars</span>=<span class="sig-default">True</span>,
1023
 
        <span class="sig-arg">salt</span>=<span class="sig-default">1</span>,
1024
 
        <span class="sig-arg">user_signature</span>=<span class="sig-default">1</span>)</span>
 
1031
        <span class="sig-arg">salt</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
1032
        <span class="sig-arg">user_signature</span>=<span class="sig-default">global_settings.applications_parent</span>)</span>
1025
1033
  </h3>
1026
1034
  </td><td align="right" valign="top"
1027
1035
    ><span class="codelink"><a href="web2py.gluon.html-pysrc.html#verifyURL">source&nbsp;code</a></span>&nbsp;
1047
1055
the key has to match the one used to generate the URL.
1048
1056
 
1049
1057
    &gt;&gt;&gt; r = Storage()
1050
 
    &gt;&gt;&gt; gv = Storage(p=(1,3),q=2,_signature='5d06bb8a4a6093dd325da2ee591c35c61afbd3c6')
1051
 
    &gt;&gt;&gt; r.update(dict(application='a', controller='c', function='f'))
 
1058
    &gt;&gt;&gt; gv = Storage(p=(1,3),q=2,_signature='a32530f0d0caa80964bb92aad2bedf8a4486a31f')
 
1059
    &gt;&gt;&gt; r.update(dict(application='a', controller='c', function='f', extension='html'))
1052
1060
    &gt;&gt;&gt; r['args'] = ['x', 'y', 'z']
1053
1061
    &gt;&gt;&gt; r['get_vars'] = gv
1054
1062
    &gt;&gt;&gt; verifyURL(r, 'key')
1074
1082
<tr><td>
1075
1083
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1076
1084
  <tr valign="top"><td>
1077
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">embed64</span>(<span class="sig-arg">filename</span>=<span class="sig-default">1</span>,
1078
 
        <span class="sig-arg">file</span>=<span class="sig-default">1</span>,
1079
 
        <span class="sig-arg">data</span>=<span class="sig-default">1</span>,
 
1085
  <h3 class="epydoc"><span class="sig"><span class="sig-name">embed64</span>(<span class="sig-arg">filename</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
1086
        <span class="sig-arg">file</span>=<span class="sig-default">global_settings.applications_parent</span>,
 
1087
        <span class="sig-arg">data</span>=<span class="sig-default">global_settings.applications_parent</span>,
1080
1088
        <span class="sig-arg">extension</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">image/gif</code><code class="variable-quote">'</code></span>)</span>
1081
1089
  </h3>
1082
1090
  </td><td align="right" valign="top"
1178
1186
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1179
1187
  <tr>
1180
1188
    <td align="left" class="footer">
1181
 
    Generated by Epydoc 3.0beta1 on Thu Aug  4 00:46:59 2011
 
1189
    Generated by Epydoc 3.0beta1 on Mon Sep 26 06:55:22 2011
1182
1190
    </td>
1183
1191
    <td align="right" class="footer">
1184
1192
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>