From e29e0e5018ee0f783ad8d5b8a6a93fec1d5800b3 Mon Sep 17 00:00:00 2001 From: Cesar G Date: Tue, 27 May 2014 08:10:32 -0700 Subject: [ticket/12599] Remove corner images from documentation style. PHPBB3-12599 --- phpBB/docs/auth_api.html | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'phpBB/docs/auth_api.html') diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html index 703e7a18c1..0ff2fca554 100644 --- a/phpBB/docs/auth_api.html +++ b/phpBB/docs/auth_api.html @@ -16,7 +16,7 @@
-
+
@@ -25,7 +25,7 @@

Skip

-
+
@@ -40,7 +40,7 @@

Auth API

-
+
@@ -65,7 +65,7 @@
-
+
@@ -73,7 +73,7 @@

1. Introduction

-
+
@@ -95,7 +95,7 @@ $auth = new phpbb\auth\auth();
Back to Top
-
+
@@ -103,7 +103,7 @@ $auth = new phpbb\auth\auth();

2. Methods

-
+
@@ -230,7 +230,7 @@ $result = $auth->acl_get_list($user_id, $permissions, $forum_id);
Back to Top
-
+
@@ -238,7 +238,7 @@ $result = $auth->acl_get_list($user_id, $permissions, $forum_id);

3. Admin related functions

-
+
@@ -256,7 +256,7 @@ $auth_admin = new auth_admin();
Back to Top
-
+
@@ -264,7 +264,7 @@ $auth_admin = new auth_admin();

4. Copyright and disclaimer

-
+
@@ -274,7 +274,7 @@ $auth_admin = new auth_admin();
Back to Top
-
+
-- cgit v1.2.1 From 4565cac049be02e452de5707fdc692d624bdac8b Mon Sep 17 00:00:00 2001 From: Cesar G Date: Tue, 27 May 2014 08:12:06 -0700 Subject: [ticket/12599] Move documentation stylesheet to assets directory. PHPBB3-12599 --- phpBB/docs/auth_api.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'phpBB/docs/auth_api.html') diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html index 0ff2fca554..1049c2e56d 100644 --- a/phpBB/docs/auth_api.html +++ b/phpBB/docs/auth_api.html @@ -6,7 +6,7 @@ phpBB3 • Auth API - + -- cgit v1.2.1 From 14fecb2f028a618fc9856124a24ba3878406a658 Mon Sep 17 00:00:00 2001 From: Cesar G Date: Tue, 27 May 2014 08:37:17 -0700 Subject: [ticket/12599] Move images to assets/ and update the phpBB logo. PHPBB3-12599 --- phpBB/docs/auth_api.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'phpBB/docs/auth_api.html') diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html index 1049c2e56d..6de7a7d12e 100644 --- a/phpBB/docs/auth_api.html +++ b/phpBB/docs/auth_api.html @@ -19,7 +19,7 @@
- +

Auth API

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

Skip

-- cgit v1.2.1 From a07b29c1df8519e31401ec3d5f472c8a8f04431c Mon Sep 17 00:00:00 2001 From: Cesar G Date: Tue, 27 May 2014 09:26:49 -0700 Subject: [ticket/12599] Place standalone text in a box. PHPBB3-12599 --- phpBB/docs/auth_api.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'phpBB/docs/auth_api.html') diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html index 6de7a7d12e..6dd697166b 100644 --- a/phpBB/docs/auth_api.html +++ b/phpBB/docs/auth_api.html @@ -35,7 +35,7 @@ -

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

+

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

Auth API

-- cgit v1.2.1 From 4df853abccd48d89e1dfce6dfc1a0b9c5a34c7ee Mon Sep 17 00:00:00 2001 From: Cesar G Date: Tue, 23 Sep 2014 15:12:05 -0700 Subject: [ticket/12599] Remove empty line at end of code boxes. PHPBB3-12599 --- phpBB/docs/auth_api.html | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'phpBB/docs/auth_api.html') diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html index 6dd697166b..d571e72dd4 100644 --- a/phpBB/docs/auth_api.html +++ b/phpBB/docs/auth_api.html @@ -86,8 +86,8 @@

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();
-
+$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.

@@ -114,8 +114,8 @@ $auth = new phpbb\auth\auth();

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);
-
+$auth->acl(userdata); +

Where userdata is the array containing the aforementioned data.

@@ -124,8 +124,8 @@ $auth->acl(userdata);

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]);
-
+$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.

@@ -142,8 +142,8 @@ $result = $auth->acl_get(option[, forum]);

The method should be called thus:

-$result = $auth->acl_gets(option1[, option2, ..., optionN, forum]);
-
+$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.

@@ -154,16 +154,16 @@ $result = $auth->acl_gets(option1[, option2, ..., <

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]);
-
+$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 => ...)
-
+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.

@@ -172,8 +172,8 @@ 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 = $auth->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.

@@ -247,8 +247,8 @@ $result = $auth->acl_get_list($user_id, $permissions, $forum_id);

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();
-
+$auth_admin = new auth_admin(); +

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

-- cgit v1.2.1