xref: /dokuwiki/lib/plugins/authpdo/conf/default.php (revision d4f83172d9533c4d84f450fe22ef630816b21d75)
1f64dbc90SAndreas Gohr<?php
2*d4f83172SAndreas Gohr
3f64dbc90SAndreas Gohr/**
4f64dbc90SAndreas Gohr * Default settings for the authpdo plugin
5f64dbc90SAndreas Gohr *
6f64dbc90SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
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/**
23397d62a2SAndreas Gohr * statement to check the password in SQL, optional when above returned clear or hash
24397d62a2SAndreas Gohr *
25397d62a2SAndreas Gohr * input: :user, :clear, :hash, [uid], [*]
26397d62a2SAndreas Gohr * return: *
27397d62a2SAndreas Gohr */
28397d62a2SAndreas Gohr$conf['check-pass'] = '';
29397d62a2SAndreas Gohr
30397d62a2SAndreas Gohr/**
31c27579a6SAndreas Gohr * statement to select a single user identified by its login name
32c27579a6SAndreas Gohr *
33c27579a6SAndreas Gohr * input: :user, [uid]
34c27579a6SAndreas Gohr * return: group
35c27579a6SAndreas Gohr */
36c27579a6SAndreas Gohr$conf['select-user-groups'] = '';
37c27579a6SAndreas Gohr
38c27579a6SAndreas Gohr/**
395de3a6a5SAndreas Gohr * Select all the existing group names
4070a89417SAndreas Gohr *
415de3a6a5SAndreas Gohr * return: group, [gid], [*]
4270a89417SAndreas Gohr */
43c27579a6SAndreas Gohr$conf['select-groups'] = '';
445de3a6a5SAndreas Gohr
455de3a6a5SAndreas Gohr/**
465de3a6a5SAndreas Gohr * Create a new user
475de3a6a5SAndreas Gohr *
484fb8dfabSAndreas Gohr * input: :user, :name, :mail, (:clear|:hash)
495de3a6a5SAndreas Gohr */
505de3a6a5SAndreas Gohr$conf['insert-user'] = '';
515de3a6a5SAndreas Gohr
525de3a6a5SAndreas Gohr/**
53e19be516SAndreas Gohr * Remove a user
54e19be516SAndreas Gohr *
55e19be516SAndreas Gohr * input: :user, [:uid], [*]
56e19be516SAndreas Gohr */
57e19be516SAndreas Gohr$conf['delete-user'] = '';
58e19be516SAndreas Gohr
59e19be516SAndreas Gohr/**
606459f496SAndreas Gohr * list user names matching the given criteria
616459f496SAndreas Gohr *
626459f496SAndreas Gohr * Make sure the list is distinct and sorted by user name. Apply the given limit and offset
636459f496SAndreas Gohr *
646459f496SAndreas Gohr * input: :user, :name, :mail, :group, :start, :end, :limit
656459f496SAndreas Gohr * out: user
666459f496SAndreas Gohr */
676459f496SAndreas Gohr$conf['list-users'] = '';
686459f496SAndreas Gohr
696459f496SAndreas Gohr/**
706459f496SAndreas Gohr * count user names matching the given criteria
716459f496SAndreas Gohr *
726459f496SAndreas Gohr * Make sure the counted list is distinct
736459f496SAndreas Gohr *
746459f496SAndreas Gohr * input: :user, :name, :mail, :group
756459f496SAndreas Gohr * out: count
766459f496SAndreas Gohr */
77c27579a6SAndreas Gohr$conf['count-users'] = '';
786459f496SAndreas Gohr
796459f496SAndreas Gohr/**
804fb8dfabSAndreas Gohr * Update user data (except password and user name)
814fb8dfabSAndreas Gohr *
824fb8dfabSAndreas Gohr * input: :user, :name, :mail, [:uid], [*]
834fb8dfabSAndreas Gohr */
844fb8dfabSAndreas Gohr$conf['update-user-info'] = '';
854fb8dfabSAndreas Gohr
864fb8dfabSAndreas Gohr/**
874fb8dfabSAndreas Gohr * Update user name aka login
884fb8dfabSAndreas Gohr *
894fb8dfabSAndreas Gohr * input: :user, :newlogin, [:uid], [*]
904fb8dfabSAndreas Gohr */
914fb8dfabSAndreas Gohr$conf['update-user-login'] = '';
924fb8dfabSAndreas Gohr
934fb8dfabSAndreas Gohr/**
944fb8dfabSAndreas Gohr * Update user password
954fb8dfabSAndreas Gohr *
964fb8dfabSAndreas Gohr * input: :user, :clear, :hash, [:uid], [*]
974fb8dfabSAndreas Gohr */
984fb8dfabSAndreas Gohr$conf['update-user-pass'] = '';
994fb8dfabSAndreas Gohr
1004fb8dfabSAndreas Gohr/**
1015de3a6a5SAndreas Gohr * Create a new group
1025de3a6a5SAndreas Gohr *
1035de3a6a5SAndreas Gohr * input: :group
1045de3a6a5SAndreas Gohr */
1055de3a6a5SAndreas Gohr$conf['insert-group'] = '';
1065de3a6a5SAndreas Gohr
1075de3a6a5SAndreas Gohr/**
1085de3a6a5SAndreas Gohr * Make user join group
1095de3a6a5SAndreas Gohr *
1105de3a6a5SAndreas Gohr * input: :user, [:uid], group, [:gid], [*]
1115de3a6a5SAndreas Gohr */
1125de3a6a5SAndreas Gohr$conf['join-group'] = '';
1134fb8dfabSAndreas Gohr
1144fb8dfabSAndreas Gohr/**
1154fb8dfabSAndreas Gohr * Make user leave group
1164fb8dfabSAndreas Gohr *
1174fb8dfabSAndreas Gohr * input: :user, [:uid], group, [:gid], [*]
1184fb8dfabSAndreas Gohr */
1194fb8dfabSAndreas Gohr$conf['leave-group'] = '';
120