diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html index c83aaadc2d..50d73d4485 100644 --- a/phpBB/docs/auth_api.html +++ b/phpBB/docs/auth_api.html @@ -61,6 +61,9 @@
  • acl_getf
  • acl_getf_global
  • acl_cache
  • +
  • acl_clear_prefetch
  • +
  • acl_get_list
  • +
  • Miscellaneous
  • Admin related functions
  • @@ -176,7 +179,7 @@ array(forum_id1 => array(option => integer), 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 = acl_getf_global(option)
    +$result = $auth->acl_getf_global(option)
     	

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

    @@ -187,6 +190,49 @@ $result = acl_getf_global(option)

    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 void.

    + +

    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:

    + + +

    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:

    + + +

    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