xref: /dokuwiki/lib/plugins/authpdo/conf/default.php (revision 6459f496c8689d7960a4c338677ae020055d1038)
1f64dbc90SAndreas Gohr<?php
2f64dbc90SAndreas Gohr/**
3f64dbc90SAndreas Gohr * Default settings for the authpdo plugin
4f64dbc90SAndreas Gohr *
5f64dbc90SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
6f64dbc90SAndreas Gohr */
7f64dbc90SAndreas Gohr
8f64dbc90SAndreas Gohr
9f64dbc90SAndreas Gohr$conf['debug'] = 0;
10f64dbc90SAndreas Gohr$conf['dsn'] = '';
11f64dbc90SAndreas Gohr$conf['user'] = '';
12f64dbc90SAndreas Gohr$conf['pass'] = '';
13f64dbc90SAndreas Gohr
14f64dbc90SAndreas Gohr/**
1570a89417SAndreas Gohr * statement to select a single user identified by its login name
16f64dbc90SAndreas Gohr *
1770a89417SAndreas Gohr * input: :user
1870a89417SAndreas Gohr * return: user, name, mail, (clear|hash), [uid], [*]
19f64dbc90SAndreas Gohr */
20f64dbc90SAndreas Gohr$conf['select-user'] = '';
2170a89417SAndreas Gohr
2270a89417SAndreas Gohr/**
235de3a6a5SAndreas Gohr * Select all the existing group names
2470a89417SAndreas Gohr *
255de3a6a5SAndreas Gohr * return: group, [gid], [*]
2670a89417SAndreas Gohr */
275de3a6a5SAndreas Gohr$conf['select-group'] = '';
285de3a6a5SAndreas Gohr
295de3a6a5SAndreas Gohr/**
305de3a6a5SAndreas Gohr * Create a new user
315de3a6a5SAndreas Gohr *
324fb8dfabSAndreas Gohr * input: :user, :name, :mail, (:clear|:hash)
335de3a6a5SAndreas Gohr */
345de3a6a5SAndreas Gohr$conf['insert-user'] = '';
355de3a6a5SAndreas Gohr
365de3a6a5SAndreas Gohr/**
37e19be516SAndreas Gohr * Remove a user
38e19be516SAndreas Gohr *
39e19be516SAndreas Gohr * input: :user, [:uid], [*]
40e19be516SAndreas Gohr */
41e19be516SAndreas Gohr$conf['delete-user'] = '';
42e19be516SAndreas Gohr
43e19be516SAndreas Gohr/**
44*6459f496SAndreas Gohr * list user names matching the given criteria
45*6459f496SAndreas Gohr *
46*6459f496SAndreas Gohr * Make sure the list is distinct and sorted by user name. Apply the given limit and offset
47*6459f496SAndreas Gohr *
48*6459f496SAndreas Gohr * input: :user, :name, :mail, :group, :start, :end, :limit
49*6459f496SAndreas Gohr * out: user
50*6459f496SAndreas Gohr */
51*6459f496SAndreas Gohr$conf['list-users'] = '';
52*6459f496SAndreas Gohr
53*6459f496SAndreas Gohr/**
54*6459f496SAndreas Gohr * count user names matching the given criteria
55*6459f496SAndreas Gohr *
56*6459f496SAndreas Gohr * Make sure the counted list is distinct
57*6459f496SAndreas Gohr *
58*6459f496SAndreas Gohr * input: :user, :name, :mail, :group
59*6459f496SAndreas Gohr * out: count
60*6459f496SAndreas Gohr */
61*6459f496SAndreas Gohr$conf['list-users'] = '';
62*6459f496SAndreas Gohr
63*6459f496SAndreas Gohr
64*6459f496SAndreas Gohr/**
654fb8dfabSAndreas Gohr * Update user data (except password and user name)
664fb8dfabSAndreas Gohr *
674fb8dfabSAndreas Gohr * input: :user, :name, :mail, [:uid], [*]
684fb8dfabSAndreas Gohr */
694fb8dfabSAndreas Gohr$conf['update-user-info'] = '';
704fb8dfabSAndreas Gohr
714fb8dfabSAndreas Gohr/**
724fb8dfabSAndreas Gohr * Update user name aka login
734fb8dfabSAndreas Gohr *
744fb8dfabSAndreas Gohr * input: :user, :newlogin, [:uid], [*]
754fb8dfabSAndreas Gohr */
764fb8dfabSAndreas Gohr$conf['update-user-login'] = '';
774fb8dfabSAndreas Gohr
784fb8dfabSAndreas Gohr/**
794fb8dfabSAndreas Gohr * Update user password
804fb8dfabSAndreas Gohr *
814fb8dfabSAndreas Gohr * input: :user, :clear, :hash, [:uid], [*]
824fb8dfabSAndreas Gohr */
834fb8dfabSAndreas Gohr$conf['update-user-pass'] = '';
844fb8dfabSAndreas Gohr
854fb8dfabSAndreas Gohr/**
865de3a6a5SAndreas Gohr * Create a new group
875de3a6a5SAndreas Gohr *
885de3a6a5SAndreas Gohr * input: :group
895de3a6a5SAndreas Gohr */
905de3a6a5SAndreas Gohr$conf['insert-group'] = '';
915de3a6a5SAndreas Gohr
925de3a6a5SAndreas Gohr/**
935de3a6a5SAndreas Gohr * Make user join group
945de3a6a5SAndreas Gohr *
955de3a6a5SAndreas Gohr * input: :user, [:uid], group, [:gid], [*]
965de3a6a5SAndreas Gohr */
975de3a6a5SAndreas Gohr$conf['join-group'] = '';
984fb8dfabSAndreas Gohr
994fb8dfabSAndreas Gohr/**
1004fb8dfabSAndreas Gohr * Make user leave group
1014fb8dfabSAndreas Gohr *
1024fb8dfabSAndreas Gohr * input: :user, [:uid], group, [:gid], [*]
1034fb8dfabSAndreas Gohr */
1044fb8dfabSAndreas Gohr$conf['leave-group'] = '';
105