:py:mod:`core.render.html.user`
===============================

.. py:module:: core.render.html.user


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   core.render.html.user.Render




.. py:class:: Render(parent=None, *args, **kwargs)


   Bases: :py:obj:`core.render.html.default`

   The core jinja2 render.

   This is the bridge between your ViUR modules and your templates.
   First, the default jinja2-api is exposed to your templates. See http://jinja.pocoo.org/ for
   more information. Second, we'll pass data das global variables to templates depending on the
   current action.

       - For list() a `skellist` is provided containing all requested skeletons to a limit
       - For view(): skel - a dictionary with values from the skeleton prepared for use inside html
       - For add()/edit: a dictionary as `skel` with `values`, `structure` and `errors` as keys.

   Third, a bunch of global filters (like urlencode) and functions (getEntry, ..) are available  to templates.

   See the ViUR Documentation for more information about functions and data available to jinja2 templates.

   Its possible for modules to extend the list of filters/functions available to templates by defining
   a function called `jinjaEnv`. Its called from the render when the environment is first created and
   can extend/override the functionality exposed to templates.


   .. py:attribute:: loginTemplate
      :value: 'user_login'

      

   .. py:attribute:: loginChoicesTemplate
      :value: 'user_login_choices'

      

   .. py:attribute:: logoutSuccessTemplate
      :value: 'user_logout_success'

      

   .. py:attribute:: loginSuccessTemplate
      :value: 'user_login_success'

      

   .. py:attribute:: verifySuccessTemplate
      :value: 'user_verify_success'

      

   .. py:attribute:: verifyFailedTemplate
      :value: 'user_verify_failed'

      

   .. py:attribute:: passwdRecoverInfoTemplate
      :value: 'user_passwdrecover_info'

      

   .. py:attribute:: second_factor_add_template
      :value: 'user_secondfactor_add'

      

   .. py:attribute:: second_factor_add_success_template
      :value: 'user_secondfactor_add_success'

      

   .. py:attribute:: second_factor_choice_template
      :value: 'user_second_factor_choice'

      

   .. py:method:: _choose_template(tpl, fallback_attribute)


   .. py:method:: login_disabled(authMethods, tpl = None, **kwargs)


   .. py:method:: login(skel, tpl = None, **kwargs)


   .. py:method:: loginChoices(authMethods, tpl = None, **kwargs)


   .. py:method:: loginSucceeded(tpl = None, **kwargs)


   .. py:method:: logoutSuccess(tpl = None, **kwargs)


   .. py:method:: verifySuccess(skel, tpl = None, **kwargs)


   .. py:method:: verifyFailed(tpl = None, **kwargs)


   .. py:method:: passwdRecoverInfo(msg, skel=None, tpl = None, **kwargs)


   .. py:method:: passwdRecover(*args, **kwargs)


   .. py:method:: second_factor_add(action_name, name, add_url, tpl, otp_uri=None)


   .. py:method:: second_factor_add_success(action_name, name, tpl = None)


   .. py:method:: second_factor_choice(second_factors, tpl = None)