userdb

### Index Up << >>

## userdb

CALL INFORMATION
  Parameters: function

  Positional parameters in same order.

  The attribute hash reference is passed to the subroutine after the parameters as the last argument. This may mean that there are parameters not shown here.

  Must pass named parameter interpolate=1 to cause interpolation.

  Invalidates cache: YES

  Called Routine:

  ASP/perl tag calls:

          $Tag->userdb(
              {
               function => VALUE,
              }
          )

       OR

          $Tag->userdb($function, $ATTRHASH);

  Attribute aliases

                  name ==> nickname
                  table ==> db

DESCRIPTION
  MiniVend provides a `[userdb ...]` tag to access the UserDB functions.

       [userdb
              function=function_name
              username="username"*
              password="password"*
              verify="password"*
              oldpass="old password"*
              shipping="fields for shipping save"
              billing="fields for billing save"
              preferences="fields for preferences save"
              force_lower=1
              param1=value*
              param2=value*
              ...
              ]

  * Optional

  It is normally called in an `mv_click` or `mv_check` setting, as in:

          [set Login]
          mv_todo=return
          mv_nextpage=welcome
          [userdb function=login]
          [/set]

          <FORM ACTION="[process-target]" METHOD=POST>
          <INPUT TYPE=hidden NAME=mv_click VALUE=Login>
          Username <INPUT NAME=mv_username SIZE=10>
          Password <INPUT NAME=mv_password SIZE=10>
          </FORM>

  There are several global parameters that apply to any use of the `userdb` functions. Most importantly, by default the database table is set to be userdb. If you must use another table name, then you should include a `database=table` parameter with any call to `userdb`. The global parameters (default in parens):

          database     Sets user database table (userdb)
          show         Show the return value of certain functions
                       or the error message, if any (0)
          force_lower  Force possibly upper-case database fields
                       to lower case session variable names (0)
          billing      Set the billing fields (see Accounts)
          shipping     Set the shipping fields (see Address Book)
          preferences  Set the preferences fields (see Preferences)
          bill_field   Set field name for accounts (accounts)
          addr_field   Set field name for address book (address_book)
          pref_field   Set field name for preferences (preferences)
          cart_field   Set field name for cart storage (carts)
          pass_field   Set field name for password (password)
          time_field   Set field for storing last login time (time)
          expire_field Set field for expiration date (expire_date)
          acl          Set field for simple access control storage (acl)
          file_acl     Set field for file access control storage (file_acl)
          db_acl       Set field for database access control storage (db_acl)

### Index Up << >>