xref: /dokuwiki/lib/plugins/authpdo/conf/default.php (revision c27579a6570174d16e356f8f3a3225a96ead8496)
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*c27579a6SAndreas Gohr * statement to select a single user identified by its login name
23*c27579a6SAndreas Gohr *
24*c27579a6SAndreas Gohr * input: :user, [uid]
25*c27579a6SAndreas Gohr * return: group
26*c27579a6SAndreas Gohr */
27*c27579a6SAndreas Gohr$conf['select-user-groups'] = '';
28*c27579a6SAndreas Gohr
29*c27579a6SAndreas Gohr/**
305de3a6a5SAndreas Gohr * Select all the existing group names
3170a89417SAndreas Gohr *
325de3a6a5SAndreas Gohr * return: group, [gid], [*]
3370a89417SAndreas Gohr */
34*c27579a6SAndreas Gohr$conf['select-groups'] = '';
355de3a6a5SAndreas Gohr
365de3a6a5SAndreas Gohr/**
375de3a6a5SAndreas Gohr * Create a new user
385de3a6a5SAndreas Gohr *
394fb8dfabSAndreas Gohr * input: :user, :name, :mail, (:clear|:hash)
405de3a6a5SAndreas Gohr */
415de3a6a5SAndreas Gohr$conf['insert-user'] = '';
425de3a6a5SAndreas Gohr
435de3a6a5SAndreas Gohr/**
44e19be516SAndreas Gohr * Remove a user
45e19be516SAndreas Gohr *
46e19be516SAndreas Gohr * input: :user, [:uid], [*]
47e19be516SAndreas Gohr */
48e19be516SAndreas Gohr$conf['delete-user'] = '';
49e19be516SAndreas Gohr
50e19be516SAndreas Gohr/**
516459f496SAndreas Gohr * list user names matching the given criteria
526459f496SAndreas Gohr *
536459f496SAndreas Gohr * Make sure the list is distinct and sorted by user name. Apply the given limit and offset
546459f496SAndreas Gohr *
556459f496SAndreas Gohr * input: :user, :name, :mail, :group, :start, :end, :limit
566459f496SAndreas Gohr * out: user
576459f496SAndreas Gohr */
586459f496SAndreas Gohr$conf['list-users'] = '';
596459f496SAndreas Gohr
606459f496SAndreas Gohr/**
616459f496SAndreas Gohr * count user names matching the given criteria
626459f496SAndreas Gohr *
636459f496SAndreas Gohr * Make sure the counted list is distinct
646459f496SAndreas Gohr *
656459f496SAndreas Gohr * input: :user, :name, :mail, :group
666459f496SAndreas Gohr * out: count
676459f496SAndreas Gohr */
68*c27579a6SAndreas Gohr$conf['count-users'] = '';
696459f496SAndreas Gohr
706459f496SAndreas Gohr/**
714fb8dfabSAndreas Gohr * Update user data (except password and user name)
724fb8dfabSAndreas Gohr *
734fb8dfabSAndreas Gohr * input: :user, :name, :mail, [:uid], [*]
744fb8dfabSAndreas Gohr */
754fb8dfabSAndreas Gohr$conf['update-user-info'] = '';
764fb8dfabSAndreas Gohr
774fb8dfabSAndreas Gohr/**
784fb8dfabSAndreas Gohr * Update user name aka login
794fb8dfabSAndreas Gohr *
804fb8dfabSAndreas Gohr * input: :user, :newlogin, [:uid], [*]
814fb8dfabSAndreas Gohr */
824fb8dfabSAndreas Gohr$conf['update-user-login'] = '';
834fb8dfabSAndreas Gohr
844fb8dfabSAndreas Gohr/**
854fb8dfabSAndreas Gohr * Update user password
864fb8dfabSAndreas Gohr *
874fb8dfabSAndreas Gohr * input: :user, :clear, :hash, [:uid], [*]
884fb8dfabSAndreas Gohr */
894fb8dfabSAndreas Gohr$conf['update-user-pass'] = '';
904fb8dfabSAndreas Gohr
914fb8dfabSAndreas Gohr/**
925de3a6a5SAndreas Gohr * Create a new group
935de3a6a5SAndreas Gohr *
945de3a6a5SAndreas Gohr * input: :group
955de3a6a5SAndreas Gohr */
965de3a6a5SAndreas Gohr$conf['insert-group'] = '';
975de3a6a5SAndreas Gohr
985de3a6a5SAndreas Gohr/**
995de3a6a5SAndreas Gohr * Make user join group
1005de3a6a5SAndreas Gohr *
1015de3a6a5SAndreas Gohr * input: :user, [:uid], group, [:gid], [*]
1025de3a6a5SAndreas Gohr */
1035de3a6a5SAndreas Gohr$conf['join-group'] = '';
1044fb8dfabSAndreas Gohr
1054fb8dfabSAndreas Gohr/**
1064fb8dfabSAndreas Gohr * Make user leave group
1074fb8dfabSAndreas Gohr *
1084fb8dfabSAndreas Gohr * input: :user, [:uid], group, [:gid], [*]
1094fb8dfabSAndreas Gohr */
1104fb8dfabSAndreas Gohr$conf['leave-group'] = '';
111