# Auth API

This is an explanation of how to use the phpBB auth/acl API

Skip

This is an explanation of how to use the phpBB auth/acl API.

# Auth API

## 1. Introduction

#### What is it?

The `auth` class contains methods related to authorisation users to access various board functions, e.g. posting, viewing, replying, logging in (and out), etc. If you need to check whether a user can carry out a task or handle user login/logouts this class is required.

#### Initialisation

To use any methods contained with the `auth` class it first needs to be instantiated. This is best achieved early in the execution of the script in the following manner:

    $auth = new phpbb\auth\auth();

Once an instance of the class has been created you are free to call the various methods it contains. Please note that should you wish to use the `auth_admin` methods you will need to instantiate this separately but in the same way.

Back to Top

## 2. Methods

Following are the methods you are able to use.

### 2.i. acl

The `acl` method is the initialisation routine for all the acl functions. If you intend calling any acl method you must first call this. The method takes as its one and only required parameter an associative array containing user information as stored in the database. This array must contain at least the following information; user_id, user_permissions and user_type. It is called in the following way:

    $auth->acl(userdata);

Where userdata is the array containing the aforementioned data.

### 2.ii. acl_get

This method is the primary way of determining what a user can and cannot do for a given option globally or in a given forum. The method should be called in the following way:

    $result = $auth->acl_get(option[, forum]);

Where option is a string representing the required option, e.g. 'f_list', 'm_edit', 'a_adduser', etc. By adding a ! in front of the option, e.g. '!f_list' the result of this method will be negated. The optional forum term is the integer forum_id.

The method returns a positive integer when the user is allowed to carry out the option and a zero if denied or the other way around if the option is prefixed with an exclamation mark.

If you specify a forum and there is also a global setting for the specified option then this method will return a positive integer if one of them evaluates to a positive integer. An example would be the m_approve option which can be set per forum but also globally. If a user has the global option he will automatically have m_approve in every forum.

There are some special options or flags which are used as prefixes for other options, e.g. 'f_' or 'm_'. These flags will automatically be set to a positive integer if the user has one or more permissions with the given prefix. A local setting will result in the flag being set only locally (so it will require a forum id to retrieve). If a user has one or more global permissions with the prefix acl_get will return a positive integer regardless of the forum id.

### 2.iii. acl_gets

This method is funtionally similar to `acl_get` in that it returns information on whether a user can or cannot carry out a given task. The difference here is the ability to test several different options in one go. This may be useful for testing whether a user is a moderator or an admin in one call. Rather than having to call and check `acl_get` twice.

The method should be called thus:

    $result = $auth->acl_gets(option1[, option2, ..., optionN, forum]);

As with the `acl_get` method the options are strings representing the required permissions to check. The forum again is an integer representing a given forum_id.

The method will return a positive integer if `acl_get` for one of the options evaluates to a positive integer (combines permissions with OR).

### 2.iv. acl_getf

This method is used to find out in which forums a user is allowed to carry out an operation or to find out in which forums he is not allowed to carry out an operation. The method should be called in the following way:

    $result = $auth->acl_getf(option[, clean]);

Just like in the `acl_get` method the option is a string specifying the permission which has to be checked (negation using ! is allowed). The second parameter is a boolean. If it is set to false this method returns all forums with either zero or a positive integer. If it is set to true only those forums with a positive integer as the result will be returned.

The method returns an associative array of the form:

    array(forum_id1 => array(option => integer), forum_id2 => ...)

Where option is the option passed to the method and integer is either zero or a positive integer and the same `acl_get(option, forum_id)` would return.

### 2.v. acl_getf_global

This method is used to find out whether a user has a permission in at least one forum or globally. This method is similar to checking whether `acl_getf(option, true)` returned one or more forums but it's faster. It should be called in the following way:

    $result = $auth->acl_getf_global(option)

As with the previous methods option is a string specifying the permission which has to be checked.

This method returns either zero or a positive integer.

### 2.vi. acl_cache

This should be considered a private method and not be called externally. It handles the generation of the user_permissions data from the basic user and group authorisation data. When necessary this method is called automatically by `acl`.

### 2.vii. acl_clear_prefetch

This method clears the user_permissions column in the users table for the given user. If the user ID passed is zero, the permissions cache is cleared for all users. This method should be called whenever permissions are set.

    // clear stored permissions for user 2
    $user_id = 2;
    $auth->acl_clear_prefetch($user_id);

This method returns null.

### 2.viii. acl_get_list

This method returns an an array describing which users have permissions in given fora. The resultant array contains an entry for permission that every user has in every forum when no arguments are passed.

    $user_id = array(2, 53);
    $permissions = array('f_list', 'f_read');
    $forum_id = array(1, 2, 3);
    $result = $auth->acl_get_list($user_id, $permissions, $forum_id);

The parameters may be of the following legal types:

- $user_id: `false`, int, array(int, int, int, ...)
- $permissions: `false`, string, array(string, string, ...)
- $forum_id: `false`, int, array(int, int, int, ...)

### 2.ix. Miscellaneous

There are other methods defined in the auth class which serve mostly as private methods, but are available for use if needed. Each of them is used to pull data directly from the database tables. They are:

-     function acl_group_raw_data($group_id = false, $opts = false, $forum_id = false)

-     function acl_user_raw_data($user_id = false, $opts = false, $forum_id = false)

-     function acl_raw_data_single_user($user_id)

-     function acl_raw_data($user_id = false, $opts = false, $forum_id = false)

-     function acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false)

Of these, `acl_raw_data` is the most general, but the others will be faster if you need a smaller amount of data.

Back to Top

## 3. Admin related functions

A number of additional methods are available related to `auth`. These handle more basic functions such as adding user and group permissions, new options and clearing the user cache. These methods are contained within a separate class, `auth_admin`. This can be found in `includes/acp/auth.php`.

To use any methods this class contains it first needs to be instantiated separately from `auth`. This is achieved in the same way as `auth`:

    $auth_admin = new auth_admin();

This instance gives you access to both the methods of this specific class and that of `auth`.

Back to Top

## 4. Copyright and disclaimer

phpBB is free software, released under the terms of the GNU General Public License, version 2 (GPL-2.0). Copyright © phpBB Limited. For full copyright and license information, please see the docs/CREDITS.txt file.

Back to Top