diff options
| -rw-r--r-- | phpBB/docs/auth_api.html | 48 | ||||
| -rw-r--r-- | phpBB/docs/coding-guidelines.html | 124 |
2 files changed, 62 insertions, 110 deletions
diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html index a33a0840f6..8973582bdb 100644 --- a/phpBB/docs/auth_api.html +++ b/phpBB/docs/auth_api.html @@ -61,6 +61,9 @@ <li><a href="#acl_getf">acl_getf</a></li> <li><a href="#acl_getf_global">acl_getf_global</a></li> <li><a href="#acl_cache">acl_cache</a></li> + <li><a href="#acl_clear_prefetch">acl_clear_prefetch</a></li> + <li><a href="#acl_get_list">acl_get_list</a></li> + <li><a href="#misc">Miscellaneous</a></li> </ol> </li> <li><a href="#admin_related">Admin related functions</a></li> @@ -176,7 +179,7 @@ array(<em>forum_id1</em> => array(<em>option</em> => <em>integer</em>), <e <p>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 <code>acl_getf(option, true)</code> returned one or more forums but it's faster. It should be called in the following way:</p> <div class="codebox"><pre> -$result = acl_getf_global(<code>option</code>) +$result = $auth->acl_getf_global(<code>option</code>) </pre></div> <p>As with the previous methods option is a string specifying the permission which has to be checked.</p> @@ -187,6 +190,49 @@ $result = acl_getf_global(<code>option</code>) <p>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 <code>acl</code>.</p> + <a name="acl_clear_prefetch"></a><h3>2.vii. acl_clear_prefetch</h3> + + <p>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.</p> + + <div class="codebox"><pre> +// clear stored permissions for user 2 +$user_id = 2; +$auth->acl_clear_prefetch($user_id); +</pre></div> + + <p>This method returns void.</p> + + <a name="acl_get_list"></a><h3>2.viii. acl_get_list</h3> + + <p>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.</p> + + <div class="codebox"><pre> +$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); +</pre></div> + + <p>The parameters may be of the following legal types:</p> + <ul> + <li><strong>$user_id</strong>: <code>false</code>, int, array(int, int, int, ...)</li> + <li><strong>$permissions</strong>: <code>false</code>, string, array(string, string, ...)</li> + <li><strong>$forum_id</strong>: <code>false</code>, int, array(int, int, int, ...)</li> + </ul> + + <a name="misc"></a><h3>2.ix. Miscellaneous</h3> + + <p>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:</p> + <ul> + <li><pre>function acl_group_raw_data($group_id = false, $opts = false, $forum_id = false)</pre></li> + <li><pre>function acl_user_raw_data($user_id = false, $opts = false, $forum_id = false)</pre></li> + <li><pre>function acl_raw_data_single_user($user_id)</pre></li> + <li><pre>function acl_raw_data($user_id = false, $opts = false, $forum_id = false)</pre></li> + <li><pre>function acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false)</pre></li> + </ul> + + <p>Of these, <code>acl_raw_data</code> is the most general, but the others will be faster if you need a smaller amount of data.</p> + </div> <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index c9b34886df..76afc79f99 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -90,10 +90,9 @@ <li><a href="#vcs">VCS Guidelines</a> <ol style="list-style-type: lower-roman;"> <li><a href="#repostruct">Repository structure</a></li> - <li><a href="#commitmessage">Commit messages</a></li> + <li><a href="#commitmessage">Commit Messages and Repository Rules</a></li> </ol> </li> - <li><a href="#changes">Guidelines Changelog</a></li> <li><a href="#disclaimer">Copyright and disclaimer</a></li> </ol> @@ -2326,126 +2325,33 @@ if (utf8_case_fold_nfc($string1) == utf8_case_fold_nfc($string2)) <div class="content"> - <p>The version control system for phpBB3 is subversion. The repository is available at <a href="http://code.phpbb.com/svn/phpbb" title="repository">http://code.phpbb.com/svn/phpbb</a>.</p> + <p>The version control system for phpBB3 is git. The repository is available at <a href="http://github.com/phpbb/phpbb3" title="repository">http://github.com/phpbb/phpbb3</a>.</p> <a name="repostruct"></a><h3>7.i. Repository Structure</h3> <ul> - <li><strong>trunk</strong><br />The latest unstable development version with new features etc. Contains the actual board in <code>/trunk/phpBB</code></li> - <li><strong>branches</strong><br />Development branches of stable phpBB releases. Copied from <code>/trunk</code> at the time of release. + <li><strong>develop</strong><br />The latest unstable development version with new features etc.</li> + <li><strong>develop-*</strong><br />Development branches of stable phpBB releases. Branched off of <code>develop</code> at the time of feature freeze. <ul> - <li><strong>phpBB3.0</strong><code>/branches/phpBB-3_0_0/phpBB</code><br />Development branch of the stable 3.0 line. Bug fixes are applied here.</li> - <li><strong>phpBB2</strong><code>/branches/phpBB-2_0_0/phpBB</code><br />Old phpBB2 development branch.</li> + <li><strong>phpBB3.0</strong><code>develop-olympus</code><br />Development branch of the stable 3.0 line. Bug fixes are applied here.</li> + <li><strong>phpBB3.1</strong><code>develop-ascraeus</code><br />Development branch of the stable 3.1 line. Bug fixes are applied here.</li> </ul> </li> - <li><strong>tags</strong><br />Released versions. Copies of trunk or the respective branch, made at the time of release. + <li><strong>master</strong><br />A branch containing all stable phpBB3 release points</li> + <li><strong>tags</strong><br />Released versions. Stable ones get merged into the master branch. <ul> - <li><code>/tags/release_3_0_BX</code><br />Beta release X of the 3.0 line.</li> - <li><code>/tags/release_3_0_RCX</code><br />Release candidate X of the 3.0 line.</li> - <li><code>/tags/release_3_0_X-RCY</code><br />Release candidate Y of the stable 3.0.X release.</li> - <li><code>/tags/release_3_0_X</code><br />Stable <strong>3.0.X</strong> release.</li> - <li><code>/tags/release_2_0_X</code><br />Old stable 2.0.X release.</li> + <li><code>release-3.Y-BX</code><br />Beta release X of the 3.Y line.</li> + <li><code>release-3.Y-RCX</code><br />Release candidate X of the 3.Y line.</li> + <li><code>release-3.Y.Z-RCX</code><br />Release candidate X of the stable 3.Y.Z release.</li> + <li><code>release-3.0.X</code><br />Stable <strong>3.0.X</strong> release.</li> + <li><code>release-2.0.X</code><br />Old stable 2.0.X release.</li> </ul> </li> </ul> - <a name="commitmessage"></a><h3>7.ii. Commit Messages</h3> - - <p>The commit message should contain a brief explanation of all changes made within the commit. Often identical to the changelog entry. A bug ticket can be referenced by specifying the ticket ID with a hash, e.g. #12345. A reference to another revision should simply be prefixed with r, e.g. r12345.</p> - - <p>Junior Developers need to have their patches approved by a development team member first. The commit message must end in a line with the following format:</p> - - <div class="codebox"><pre> -Authorised by: developer1[, developer2[, ...]] - </pre></div> - - </div> - - <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> - - <span class="corners-bottom"><span></span></span></div> - </div> - - <hr /> - -<a name="changes"></a><h2>8. Guidelines Changelog</h2> - <div class="paragraph"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> -<h3>Revision 10007</h3> - -<ul> - <li>Added <a href="#constants">Special Constants</a> section.</li> -</ul> - -<h3>Revision 9817</h3> - -<ul> - <li>Added VCS section.</li> -</ul> - -<h3>Revision 8732</h3> - -<ul> - <li>Added cfg files.</li> - <li>Added template <a href="#inheritance">inheritance</a>.</li> -</ul> - -<h3>Revision 8596+</h3> - -<ul> - <li>Removed sql_build_array('MULTI_INSERT'... statements.</li> - <li>Added sql_multi_insert() explanation.</li> -</ul> - -<h3>Revision 1.31</h3> - -<ul> - <li>Added add_form_key and check_form_key. </li> -</ul> - -<h3>Revision 1.24</h3> - -<ul> - <li>Added <a href="#translation">5. Character Sets and Encodings</a> section to explain the recommended treatment of strings in phpBB.</li> -</ul> - -<h3>Revision 1.16</h3> - -<ul> - <li>Added <a href="#translation">6. Translation (<abbr title="Internationalisation">i18n</abbr>/<abbr title="Localisation">L10n</abbr>) Guidelines</a> section to explain expected format and authoring considerations for language packs that are to be created for phpBB.</li> -</ul> - -<h3>Revision 1.11-1.15</h3> - -<ul> - <li>Various document formatting, spelling, punctuation, grammar bugs.</li> -</ul> - -<h3>Revision 1.9-1.10</h3> - -<ul> - <li>Added sql_query_limit to <a href="#sql">2.iii. SQL/SQL Layout</a>.</li> -</ul> - -<h3>Revision 1.8</h3> - -<ul> - <li>Some adjustements to wordings</li> - <li>Updated paragraph <a href="#locations">1.iii. File Locations</a> to reflect recent changes</li> - <li>Extended paragraph <a href="#codelayout">2.ii. Code Layout</a>.</li> - <li>Added sql_in_set and sql_build_query explanation to <a href="#sql">2.iii. SQL/SQL Layout</a>.</li> - <li>Updated paragraph <a href="#styling">3. Styling</a>.</li> - <li>Updated paragraph <a href="#templating">4. Templating</a> to explain loop checking, loop breaking and other changes we recently made.</li> -</ul> - -<h3>Revision 1.5</h3> - -<ul> - <li>Changed General function usage paragraph in <a href="#general">2.v. General Guidelines</a></li> -</ul> + <a name="commitmessage"></a><h3>7.ii. Commit Messages and Reposiory Rules</h3> + <p>Information on repository rules, such as commit messages can be found at <a href="http://wiki.phpbb.com/display/DEV/Git" title="phpBB Git Information">http://wiki.phpbb.com/display/DEV/Git</a></p>. </div> |