xref: /dokuwiki/lib/plugins/authpdo/conf/default.php (revision 397d62a278d0a2daaaaff6ea0e065fa968c706db)
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$conf['debug'] = 0;
9f64dbc90SAndreas Gohr$conf['dsn'] = '';
10f64dbc90SAndreas Gohr$conf['user'] = '';
11f64dbc90SAndreas Gohr$conf['pass'] = '';
12f64dbc90SAndreas Gohr
13f64dbc90SAndreas Gohr/**
1470a89417SAndreas Gohr * statement to select a single user identified by its login name
15f64dbc90SAndreas Gohr *
1670a89417SAndreas Gohr * input: :user
1770a89417SAndreas Gohr * return: user, name, mail, (clear|hash), [uid], [*]
18f64dbc90SAndreas Gohr */
19f64dbc90SAndreas Gohr$conf['select-user'] = '';
2070a89417SAndreas Gohr
2170a89417SAndreas Gohr/**
22*397d62a2SAndreas Gohr * statement to check the password in SQL, optional when above returned clear or hash
23*397d62a2SAndreas Gohr *
24*397d62a2SAndreas Gohr * input: :user, :clear, :hash, [uid], [*]
25*397d62a2SAndreas Gohr * return: *
26*397d62a2SAndreas Gohr */
27*397d62a2SAndreas Gohr$conf['check-pass'] = '';
28*397d62a2SAndreas Gohr
29*397d62a2SAndreas Gohr/**
30c27579a6SAndreas Gohr * statement to select a single user identified by its login name
31c27579a6SAndreas Gohr *
32c27579a6SAndreas Gohr * input: :user, [uid]
33c27579a6SAndreas Gohr * return: group
34c27579a6SAndreas Gohr */
35c27579a6SAndreas Gohr$conf['select-user-groups'] = '';
36c27579a6SAndreas Gohr
37c27579a6SAndreas Gohr/**
385de3a6a5SAndreas Gohr * Select all the existing group names
3970a89417SAndreas Gohr *
405de3a6a5SAndreas Gohr * return: group, [gid], [*]
4170a89417SAndreas Gohr */
42c27579a6SAndreas Gohr$conf['select-groups'] = '';
435de3a6a5SAndreas Gohr
445de3a6a5SAndreas Gohr/**
455de3a6a5SAndreas Gohr * Create a new user
465de3a6a5SAndreas Gohr *
474fb8dfabSAndreas Gohr * input: :user, :name, :mail, (:clear|:hash)
485de3a6a5SAndreas Gohr */
495de3a6a5SAndreas Gohr$conf['insert-user'] = '';
505de3a6a5SAndreas Gohr
515de3a6a5SAndreas Gohr/**
52e19be516SAndreas Gohr * Remove a user
53e19be516SAndreas Gohr *
54e19be516SAndreas Gohr * input: :user, [:uid], [*]
55e19be516SAndreas Gohr */
56e19be516SAndreas Gohr$conf['delete-user'] = '';
57e19be516SAndreas Gohr
58e19be516SAndreas Gohr/**
596459f496SAndreas Gohr * list user names matching the given criteria
606459f496SAndreas Gohr *
616459f496SAndreas Gohr * Make sure the list is distinct and sorted by user name. Apply the given limit and offset
626459f496SAndreas Gohr *
636459f496SAndreas Gohr * input: :user, :name, :mail, :group, :start, :end, :limit
646459f496SAndreas Gohr * out: user
656459f496SAndreas Gohr */
666459f496SAndreas Gohr$conf['list-users'] = '';
676459f496SAndreas Gohr
686459f496SAndreas Gohr/**
696459f496SAndreas Gohr * count user names matching the given criteria
706459f496SAndreas Gohr *
716459f496SAndreas Gohr * Make sure the counted list is distinct
726459f496SAndreas Gohr *
736459f496SAndreas Gohr * input: :user, :name, :mail, :group
746459f496SAndreas Gohr * out: count
756459f496SAndreas Gohr */
76c27579a6SAndreas Gohr$conf['count-users'] = '';
776459f496SAndreas Gohr
786459f496SAndreas Gohr/**
794fb8dfabSAndreas Gohr * Update user data (except password and user name)
804fb8dfabSAndreas Gohr *
814fb8dfabSAndreas Gohr * input: :user, :name, :mail, [:uid], [*]
824fb8dfabSAndreas Gohr */
834fb8dfabSAndreas Gohr$conf['update-user-info'] = '';
844fb8dfabSAndreas Gohr
854fb8dfabSAndreas Gohr/**
864fb8dfabSAndreas Gohr * Update user name aka login
874fb8dfabSAndreas Gohr *
884fb8dfabSAndreas Gohr * input: :user, :newlogin, [:uid], [*]
894fb8dfabSAndreas Gohr */
904fb8dfabSAndreas Gohr$conf['update-user-login'] = '';
914fb8dfabSAndreas Gohr
924fb8dfabSAndreas Gohr/**
934fb8dfabSAndreas Gohr * Update user password
944fb8dfabSAndreas Gohr *
954fb8dfabSAndreas Gohr * input: :user, :clear, :hash, [:uid], [*]
964fb8dfabSAndreas Gohr */
974fb8dfabSAndreas Gohr$conf['update-user-pass'] = '';
984fb8dfabSAndreas Gohr
994fb8dfabSAndreas Gohr/**
1005de3a6a5SAndreas Gohr * Create a new group
1015de3a6a5SAndreas Gohr *
1025de3a6a5SAndreas Gohr * input: :group
1035de3a6a5SAndreas Gohr */
1045de3a6a5SAndreas Gohr$conf['insert-group'] = '';
1055de3a6a5SAndreas Gohr
1065de3a6a5SAndreas Gohr/**
1075de3a6a5SAndreas Gohr * Make user join group
1085de3a6a5SAndreas Gohr *
1095de3a6a5SAndreas Gohr * input: :user, [:uid], group, [:gid], [*]
1105de3a6a5SAndreas Gohr */
1115de3a6a5SAndreas Gohr$conf['join-group'] = '';
1124fb8dfabSAndreas Gohr
1134fb8dfabSAndreas Gohr/**
1144fb8dfabSAndreas Gohr * Make user leave group
1154fb8dfabSAndreas Gohr *
1164fb8dfabSAndreas Gohr * input: :user, [:uid], group, [:gid], [*]
1174fb8dfabSAndreas Gohr */
1184fb8dfabSAndreas Gohr$conf['leave-group'] = '';
119