diff options
Diffstat (limited to 'phpBB/docs')
| -rw-r--r-- | phpBB/docs/AUTHORS | 93 | ||||
| -rw-r--r-- | phpBB/docs/CHANGELOG.html | 2 | ||||
| -rw-r--r-- | phpBB/docs/CREDITS.txt | 98 | ||||
| -rw-r--r-- | phpBB/docs/FAQ.html | 4 | ||||
| -rw-r--r-- | phpBB/docs/INSTALL.html | 2 | ||||
| -rw-r--r-- | phpBB/docs/LICENSE.txt (renamed from phpBB/docs/COPYING) | 0 | ||||
| -rw-r--r-- | phpBB/docs/README.html | 10 | ||||
| -rw-r--r-- | phpBB/docs/auth_api.html | 2 | ||||
| -rw-r--r-- | phpBB/docs/coding-guidelines.html | 16 | ||||
| -rw-r--r-- | phpBB/docs/events.md | 12 | ||||
| -rw-r--r-- | phpBB/docs/hook_system.html | 883 |
11 files changed, 130 insertions, 992 deletions
diff --git a/phpBB/docs/AUTHORS b/phpBB/docs/AUTHORS deleted file mode 100644 index 29ee72caa3..0000000000 --- a/phpBB/docs/AUTHORS +++ /dev/null @@ -1,93 +0,0 @@ -/** -* -* phpBB3 © Copyright phpBB Group -* http://www.phpbb.com -* -* This program is free software: you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published by -* the Free Software Foundation, version 2 of the License. -* -* This program is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -* GNU General Public License for more details. -* -* You should have received a copy of the GNU General Public License -* along with this program. If not, see <http://opensource.org/licenses/gpl-2.0.php> -* -*/ - -Please see: http://www.phpbb.com/about/team/ for a list of all the people currently -involved in phpBB. - -phpBB Lead Developer: naderman (Nils Adermann) - -phpBB Developers: bantu (Andreas Fischer) - dhruv.goel92 (Dhruv Goel) - EXreaction (Nathan Guse) - imkingdavid (David King) - marc1706 (Marc Alexander) - nickvergessen (Joas Schilling) - prototech (Cesar Gallegos) - -Contributions by: leviatan21 (Gabriel Vazquez) - Raimon (Raimon Meuldijk) - Xore (Robert Hetzler) - - --- Former Contributors -- - -phpBB Project Manager: theFinn (James Atkinson) [Founder - 04/2007] - SHS` (Jonathan Stanley) - -phpBB Lead Developer: Acyd Burn (Meik Sievertsen) [09/2005 - 01/2010] - psoTFX (Paul S. Owen) [2001 - 09/2005] - -phpBB Developers: A_Jelly_Doughnut (Josh Woody) [01/2010 - 11/2010] - Acyd Burn (Meik Sievertsen) [02/2003 - 09/2005] - APTX (Marek A. Ruszczyński) [12/2007 - 04/2011] - Arty (Vjacheslav Trushkin) [02/2012 - 07/2012] - Ashe (Ludovic Arnaud) [10/2002 - 11/2003, 06/2006 - 10/2006] - BartVB (Bart van Bragt) [11/2000 - 03/2006] - ckwalsh (Cullen Walsh) [01/2010 - 07/2011] - DavidMJ (David M.) [12/2005 - 08/2009] - dhn (Dominik Dröscher) [05/2007 - 01/2011] - GrahamJE (Graham Eames) [09/2005 - 11/2006] - kellanved (Henry Sudhof) [04/2007 - 03/2011] - igorw (Igor Wiedler) [08/2010 - 02/2013] - Oleg (Oleg Pudeyev) [01/2011 - 05/2013] - rxu (Ruslan Uzdenov) [04/2010 - 12/2012] - TerraFrost (Jim Wigginton) [04/2009 - 01/2011] - ToonArmy (Chris Smith) [06/2008 - 11/2011] - Vic D'Elfant (Vic D'Elfant) [04/2007 - 04/2009] - --- Copyrights -- - -Visual Confirmation: Xore (Robert Hetzler) - -Original subSilver by subBlue Design, Tom Beddard, (c) 2001 phpBB Group -prosilver by subBlue Design, Tom Beddard, (c) 2004 phpBB Group -subsilver2 by subBlue Design, Tom Beddard, (c) 2004 phpBB Group - -phpBB3 contains code from the following applications: - -LGPL licenced: -Smarty (c) 2001, 2002 by ispi of Lincoln, Inc, http://smarty.php.net/ - -GPL licenced: -phpMyAdmin (c) 2001,2003 phpMyAdmin Devel team, http://www.phpmyadmin.net/ -Jabber Class (c) 2006 Flyspray.org, http://www.flyspray.org/ -Chora (c) 2000-2006, The Horde Project. http://horde.org/chora/ -Horde Project (c) 2000-2006, The Horde Project. http://horde.org/ -jQuery (c) 2011, John Resig. http://jquery.com/ -Sphinx Technologies Inc (c) 2001-2012 Andrew Aksyonoff, http://sphinxsearch.com/ -Plupload (c) 2010-2013 Moxiecode Systems AB, http://www.plupload.com/ - -PHP License, version 3.0: -Pear (c) 2001-2004 PHP Group, http://pear.php.net - -Text_Diff-0.2.1 http://pear.php.net/package/Text_Diff - -MIT licenced: -Symfony2 (c) 2004-2011 Fabien Potencier, http://symfony.com/ - diff --git a/phpBB/docs/CHANGELOG.html b/phpBB/docs/CHANGELOG.html index b1e85131f2..36d0ccf68d 100644 --- a/phpBB/docs/CHANGELOG.html +++ b/phpBB/docs/CHANGELOG.html @@ -3708,7 +3708,7 @@ <div class="content"> - <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License v2</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) <a href="https://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + <p>phpBB is free software, released under the terms of the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License, version 2 (GPL-2.0)</a>. Copyright © <a href="https://www.phpbb.com">phpBB Limited</a>. For full copyright and license information, please see the docs/CREDITS.txt file.</p> </div> diff --git a/phpBB/docs/CREDITS.txt b/phpBB/docs/CREDITS.txt new file mode 100644 index 0000000000..8c98843df5 --- /dev/null +++ b/phpBB/docs/CREDITS.txt @@ -0,0 +1,98 @@ +/** +* +* phpBB © Copyright phpBB Limited 2003-2014 +* http://www.phpbb.com +* +* phpBB is free software. You can redistribute it and/or modify it +* under the terms of the GNU General Public License, version 2 (GPL-2.0) +* as published by the Free Software Foundation. +* +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +* +* A copy of the license can be viewed in the docs/LICENSE.txt file. +* The same can be viewed at <http://opensource.org/licenses/gpl-2.0.php> +* +*/ + + +phpBB Project Manager: Marshalrusty (Yuriy Rusko) + +phpBB Lead Developer: naderman (Nils Adermann) + +phpBB Developers: bantu (Andreas Fischer) + dhruv.goel92 (Dhruv Goel) + EXreaction (Nathan Guse) + imkingdavid (David King) + marc1706 (Marc Alexander) + nickvergessen (Joas Schilling) + prototech (Cesar Gallegos) + +For a list of phpBB Team members, please see: +http://www.phpbb.com/about/team/ + +For a full list of phpBB code contributors, please see: +https://github.com/phpbb/phpbb/graphs/contributors + +-- Former Developers -- + +phpBB Project Manager: theFinn (James Atkinson) [Founder - 04/2007] + SHS` (Jonathan Stanley) + +phpBB Lead Developer: Acyd Burn (Meik Sievertsen) [09/2005 - 01/2010] + psoTFX (Paul S. Owen) [2001 - 09/2005] + +phpBB Developers: A_Jelly_Doughnut (Josh Woody) [01/2010 - 11/2010] + Acyd Burn (Meik Sievertsen) [02/2003 - 09/2005] + APTX (Marek A. Ruszczyński) [12/2007 - 04/2011] + Arty (Vjacheslav Trushkin) [02/2012 - 07/2012] + Ashe (Ludovic Arnaud) [10/2002 - 11/2003, 06/2006 - 10/2006] + BartVB (Bart van Bragt) [11/2000 - 03/2006] + ckwalsh (Cullen Walsh) [01/2010 - 07/2011] + DavidMJ (David M.) [12/2005 - 08/2009] + dhn (Dominik Dröscher) [05/2007 - 01/2011] + GrahamJE (Graham Eames) [09/2005 - 11/2006] + igorw (Igor Wiedler) [08/2010 - 02/2013] + kellanved (Henry Sudhof) [04/2007 - 03/2011] + Oleg (Oleg Pudeyev) [01/2011 - 05/2013] + rxu (Ruslan Uzdenov) [04/2010 - 12/2012] + TerraFrost (Jim Wigginton) [04/2009 - 01/2011] + ToonArmy (Chris Smith) [06/2008 - 11/2011] + Vic D'Elfant (Vic D'Elfant) [04/2007 - 04/2009] + +Major contributions by: leviatan21 (Gabriel Vazquez) + Neothermic (Ashley Pinner) + Raimon (Raimon Meuldijk) + Xore (Robert Hetzler) + +-- Copyrights -- + +Visual Confirmation: Xore (Robert Hetzler) + +Original subSilver by subBlue Design, Tom Beddard, (c) 2001 phpBB Limited +prosilver by subBlue Design, Tom Beddard, (c) 2004 phpBB Limited +subsilver2 by subBlue Design, Tom Beddard, (c) 2004 phpBB Limited + +phpBB contains code from the following applications: + +LGPL licenced: +Smarty (c) 2001, 2002 by ispi of Lincoln, Inc, http://smarty.php.net/ + +GPL licenced: +phpMyAdmin (c) 2001, 2003 phpMyAdmin Devel team, http://www.phpmyadmin.net/ +Jabber Class (c) 2006 Flyspray.org, http://www.flyspray.org/ +Chora (c) 2000-2006, The Horde Project. http://horde.org/chora/ +Horde Project (c) 2000-2006, The Horde Project. http://horde.org/ +jQuery (c) 2011, John Resig. http://jquery.com/ +Sphinx Technologies Inc (c) 2001-2012 Andrew Aksyonoff, http://sphinxsearch.com/ +Plupload (c) 2010-2013 Moxiecode Systems AB, http://www.plupload.com/ + +PHP License, version 3.0: +Pear (c) 2001-2004 PHP Group, http://pear.php.net + +Text_Diff-0.2.1 http://pear.php.net/package/Text_Diff + +MIT licenced: +Symfony2 (c) 2004-2011 Fabien Potencier, http://symfony.com/ diff --git a/phpBB/docs/FAQ.html b/phpBB/docs/FAQ.html index a76b6be72a..1180c898dd 100644 --- a/phpBB/docs/FAQ.html +++ b/phpBB/docs/FAQ.html @@ -187,7 +187,7 @@ I want to sue you because i think you host an illegal board!</h2> <p>Unfortunately this only works when the users IP is constant as they browse the board. For most users this will be the case. However certain providers route their users via a cluster of proxys. In some cases, particularly the AOL browser, this results in different IPs being forwarded as the user moves between pages. We take account of this by not checking the entire IP by default but only the first "three quads" (<samp>A.B.C</samp>). Again in most cases this will be fine. However again AOL uses IPs which can vary so much that checking only the first two quads results in a fairly static IP being available for session validation.</p> -<p>If you are experiencing problems related to this you can set the Session IP validation parameter found in <code>Admin->General->Server Configuration->Security Settings</code> to <samp>A.B</samp>. Please note that reducing the IP validation length does potentially increase the risk of sessions being hijacked (this is something for you to consider, phpBB Group takes no responsibility should anything happen!). We suggest to at least additionally enable the browser validation.</p> +<p>If you are experiencing problems related to this you can set the Session IP validation parameter found in <code>Admin->General->Server Configuration->Security Settings</code> to <samp>A.B</samp>. Please note that reducing the IP validation length does potentially increase the risk of sessions being hijacked (this is something for you to consider, phpBB Limited takes no responsibility should anything happen!). We suggest to at least additionally enable the browser validation.</p> </div> @@ -321,7 +321,7 @@ I want to sue you because i think you host an illegal board!</h2> <div class="content"> - <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License v2</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) <a href="https://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + <p>phpBB is free software, released under the terms of the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License, version 2 (GPL-2.0)</a>. Copyright © <a href="https://www.phpbb.com">phpBB Limited</a>. For full copyright and license information, please see the docs/CREDITS.txt file.</p> </div> diff --git a/phpBB/docs/INSTALL.html b/phpBB/docs/INSTALL.html index 0b5d06c191..0fce349974 100644 --- a/phpBB/docs/INSTALL.html +++ b/phpBB/docs/INSTALL.html @@ -449,7 +449,7 @@ <div class="content"> - <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License v2</a>. Please see the source code and <code>docs/</code> directory for more details. This package and its contents are Copyright © <a href="https://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + <p>phpBB is free software, released under the terms of the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License, version 2 (GPL-2.0)</a>. Copyright © <a href="https://www.phpbb.com">phpBB Limited</a>. For full copyright and license information, please see the docs/CREDITS.txt file.</p> </div> diff --git a/phpBB/docs/COPYING b/phpBB/docs/LICENSE.txt index ce992b2ce7..ce992b2ce7 100644 --- a/phpBB/docs/COPYING +++ b/phpBB/docs/LICENSE.txt diff --git a/phpBB/docs/README.html b/phpBB/docs/README.html index 27ace05169..b0fd86f959 100644 --- a/phpBB/docs/README.html +++ b/phpBB/docs/README.html @@ -138,7 +138,7 @@ <a name="styles"></a><h3>2.ii. Styles</h3> - <p>Although the phpBB Group is rather proud of the included styles, we realise that they may not be to everyone's taste. Therefore, phpBB3 allows styles to be switched with relative ease. First, you need to locate and download a style you like. You can find them listed in the <a href="https://www.phpbb.com/customise/db/styles-2/">Styles</a> section of our <a href="https://www.phpbb.com/customise/db/">Customisation Database</a>.</p> + <p>Although we are rather proud of the included styles, we realise that they may not be to everyone's taste. Therefore, phpBB3 allows styles to be switched with relative ease. First, you need to locate and download a style you like. You can find them listed in the <a href="https://www.phpbb.com/customise/db/styles-2/">Styles</a> section of our <a href="https://www.phpbb.com/customise/db/">Customisation Database</a>.</p> <p>For more information about styles, please see: <a href="https://www.phpbb.com/styles/">https://www.phpbb.com/styles/</a></p> @@ -150,7 +150,7 @@ <a name="mods"></a><h3>2.iii. Modifications</h3> - <p>Although not officially supported by the phpBB Group, phpBB has a thriving modification scene. These third party modifications to the standard phpBB software, known as <strong>MODs</strong>, extend its capabilities still further. You can browse through many of the MODs in the <a href="https://www.phpbb.com/customise/db/modifications-1/">Modifications</a> section of our <a href="https://www.phpbb.com/customise/db/">Customisation Database</a>.</p> + <p>We are proud to have a thriving modifications community. These third party modifications to the standard phpBB software, known as <strong>MODs</strong>, extend its capabilities still further. You can browse through many of the MODs in the <a href="https://www.phpbb.com/customise/db/modifications-1/">Modifications</a> section of our <a href="https://www.phpbb.com/customise/db/">Customisation Database</a>.</p> <p>For more information about MODs, please see: <a href="https://www.phpbb.com/mods/">https://www.phpbb.com/mods/</a></p> @@ -192,7 +192,7 @@ <a name="website"></a><h3>3.iii. Community Forums</h3> - <p>The phpBB Group maintains a thriving community where a number of people have generously decided to donate their time to help support users. This site can be found at:</p> + <p>The phpBB project maintains a thriving community where a number of people have generously decided to donate their time to help support users. This site can be found at:</p> <p><a href="https://www.phpbb.com/community/">https://www.phpbb.com/community/</a></p> @@ -244,7 +244,7 @@ <div class="content"> - <p>The phpBB Group uses a bug tracking system to store, list and manage all reported bugs, it can be found at the location listed below. Please <strong>DO NOT</strong> post bug reports to our forums. In addition please <strong>DO NOT</strong> use the bug tracker for support requests. Posting such a request will only see you directed to the support forums (while taking time away from working on real bugs).</p> + <p>The phpBB Limited uses a bug tracking system to store, list and manage all reported bugs, it can be found at the location listed below. Please <strong>DO NOT</strong> post bug reports to our forums. In addition please <strong>DO NOT</strong> use the bug tracker for support requests. Posting such a request will only see you directed to the support forums (while taking time away from working on real bugs).</p> <p><a href="http://tracker.phpbb.com/browse/PHPBB3">http://tracker.phpbb.com/browse/PHPBB3</a></p> @@ -345,7 +345,7 @@ <div class="content"> - <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License v2</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright © <a href="https://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + <p>phpBB is free software, released under the terms of the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License, version 2 (GPL-2.0)</a>. Copyright © <a href="https://www.phpbb.com">phpBB Limited</a>. For full copyright and license information, please see the docs/CREDITS.txt file.</p> </div> diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html index c68ae7821f..703e7a18c1 100644 --- a/phpBB/docs/auth_api.html +++ b/phpBB/docs/auth_api.html @@ -268,7 +268,7 @@ $auth_admin = new auth_admin(); <div class="content"> - <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License v2</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) <a href="https://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + <p>phpBB is free software, released under the terms of the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License, version 2 (GPL-2.0)</a>. Copyright © <a href="https://www.phpbb.com">phpBB Limited</a>. For full copyright and license information, please see the docs/CREDITS.txt file.</p> </div> diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index cedf03ba9b..43417d0078 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -125,9 +125,13 @@ <div class="codebox"><pre> /** * -* @package {PACKAGENAME} -* @copyright (c) 2007 phpBB Group -* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. * */ </pre></div> @@ -1180,7 +1184,7 @@ append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=group&amp; <div class="codebox"><pre> # General Information about this style name = prosilver_duplicate -copyright = © phpBB Group, 2007 +copyright = © phpBB Limited, 2007 style_version = 3.1.0 phpbb_version = 3.1.0 @@ -1670,7 +1674,7 @@ div <div class="codebox"><pre> # General Information about this style name = Custom Style -copyright = © phpBB Group, 2007 +copyright = © phpBB Limited, 2007 style_version = 3.1.0-b1 phpbb_version = 3.1.0-b1 @@ -2546,7 +2550,7 @@ if (utf8_case_fold_nfc($string1) == utf8_case_fold_nfc($string2)) <div class="content"> - <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License v2</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) <a href="https://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + <p>phpBB is free software, released under the terms of the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License, version 2 (GPL-2.0)</a>. Copyright © <a href="https://www.phpbb.com">phpBB Limited</a>. For full copyright and license information, please see the docs/CREDITS.txt file.</p> </div> diff --git a/phpBB/docs/events.md b/phpBB/docs/events.md index 4a6a1895dd..4dc55540f3 100644 --- a/phpBB/docs/events.md +++ b/phpBB/docs/events.md @@ -22,6 +22,18 @@ acp_forums_normal_settings_append * Since: 3.1.0-a1 * Purpose: Add settings to forums +acp_group_options_before +=== +* Location: adm/style/acp_groups.html +* Since: 3.1.0-b4 +* Purpose: Add addtional options to group settings (before GROUP_FOUNDER_MANAGE) + +acp_group_options_after +=== +* Location: adm/style/acp_groups.html +* Since: 3.1.0-b4 +* Purpose: Add addtional options to group settings (after GROUP_RECEIVE_PM) + acp_main_actions_append === * Location: adm/style/acp_main.html diff --git a/phpBB/docs/hook_system.html b/phpBB/docs/hook_system.html deleted file mode 100644 index 3f209b8a34..0000000000 --- a/phpBB/docs/hook_system.html +++ /dev/null @@ -1,883 +0,0 @@ -<!DOCTYPE html> -<html dir="ltr" lang="en"> -<head> -<meta charset="utf-8"> -<meta name="keywords" content="" /> -<meta name="description" content="Hook System explanation" /> -<title>phpBB3 • Hook System</title> - -<style type="text/css"> -/* <![CDATA[ */ - -/* - The original "prosilver" theme for phpBB3 - Created by subBlue design :: http://www.subBlue.com -*/ - -* { margin: 0; padding: 0; } - -html { font-size: 100%; height: 100%; margin-bottom: 1px; } - -body { - font-family: Verdana, Helvetica, Arial, sans-serif; - color: #828282; - background-color: #FFFFFF; - font-size: 12px; - margin: 0; - padding: 12px 0; -} - -img { border-width: 0; } - -p { - line-height: 1.3em; - font-size: 1.1em; - margin-bottom: 1.5em; -} - -hr { - border: 0 none #FFFFFF; - border-top: 1px solid #CCCCCC; - height: 1px; - margin: 5px 0; - display: block; - clear: both; -} - -html, body { - color: #536482; - background-color: #FFFFFF; -} - -#doc-description h1 { - font-family: "Trebuchet MS", Arial, Helvetica, sans-serif; - margin-right: 200px; - color: #FFFFFF; - margin-top: 15px; - font-weight: bold; - font-size: 2em; - color: #fff; -} - -h1 { - font-family: "Trebuchet MS", Arial, Helvetica, sans-serif; - font-weight: normal; - color: #000; - font-size: 2em; - margin: 0.8em 0 0.2em 0; -} - -h2 { - font-family: "Trebuchet MS", Arial, Helvetica, sans-serif; - font-weight: normal; - color: #28313F; - font-size: 1.5em; - margin: 0.8em 0 0.2em 0; -} - -h3 { - font-family: Arial, Helvetica, sans-serif; - font-weight: bold; - border-bottom: 1px solid #CCCCCC; - margin-bottom: 3px; - padding-bottom: 2px; - font-size: 1.05em; - color: #115098; - margin-top: 20px; -} - -.good { color: green; } -.bad { color: red; } - -.version { - margin-top: 20px; - text-align: left; - font-size: 70%; - color: #006600; - border-top: 1px solid #ccc; -} - -code { - color: #006600; - font-weight: normal; - font-family: 'Courier New', monospace; - border-color: #D1D7DC; - border-width: 1px; - border-style: solid; - background-color: #FAFAFA; -} - -#wrap { - padding: 0 20px; - min-width: 650px; -} - -#simple-wrap { - padding: 6px 10px; -} - -#page-body { - margin: 4px 0; - clear: both; -} - -#page-footer { - clear: both; -} - -#logo { - float: left; - width: auto; - padding: 10px 13px 0 10px; -} - -a#logo:hover { - text-decoration: none; -} - -#doc-description { - float: left; - width: 70%; -} - -#doc-description h1 { - margin-right: 0; -} - -.headerbar { - background: #ebebeb none repeat-x 0 0; - color: #FFFFFF; - margin-bottom: 4px; - padding: 0 5px; -} - -span.corners-top, span.corners-bottom, span.corners-top span, span.corners-bottom span { - font-size: 1px; - line-height: 1px; - display: block; - height: 5px; - background-repeat: no-repeat; -} - -span.corners-top { - background-image: none; - background-position: 0 0; - margin: 0 -5px; -} - -span.corners-top span { - background-image: none; - background-position: 100% 0; -} - -span.corners-bottom { - background-image: none; - background-position: 0 100%; - margin: 0 -5px; - clear: both; -} - -span.corners-bottom span { - background-image: none; - background-position: 100% 100%; -} - -.paragraph { - padding: 0 10px; - margin-bottom: 4px; - background-repeat: no-repeat; - background-position: 100% 0; - background-color: #ECF3F7; -} - -.paragraph:target .content { - color: #000000; -} - -.paragraph:target h3 a { - color: #000000; -} - -.content { - color: #333333; -} - -.content h2, .panel h2 { - color: #115098; - border-bottom-color: #CCCCCC; -} - -a:link { color: #898989; text-decoration: none; } -a:visited { color: #898989; text-decoration: none; } -a:hover { color: #d3d3d3; text-decoration: underline; } -a:active { color: #d2d2d2; text-decoration: none; } - -hr { - border-color: #FFFFFF; - border-top-color: #CCCCCC; -} - -.menu { - background-color: #cadceb; -} - -.headerbar { - background-color: #12A3EB; - background-image: url("bg_header.gif"); - color: #FFFFFF; -} - -.panel { - background-color: #ECF1F3; - color: #28313F; -} - - -span.corners-top { - background-image: url("corners_left.png"); -} - -span.corners-top span { - background-image: url("corners_right.png"); -} - -span.corners-bottom { - background-image: url("corners_left.png"); -} - -span.corners-bottom span { - background-image: url("corners_right.png"); -} - -.error { - color: #BC2A4D; -} - -a:link { color: #105289; } -a:visited { color: #105289; } -a:hover { color: #D31141; } -a:active { color: #368AD2; } - -.paragraph span.corners-top, .paragraph span.corners-bottom { - margin: 0 -10px; -} - -.content { - padding: 0; - line-height: 1.48em; - color: #333333; -} - -.content h2, .panel h2 { - color: #115098; - border-bottom-color: #CCCCCC; -} - -.notice { - border-top-color: #CCCCCC; -} - -.codebox { - padding: 3px; - background-color: #FFFFFF; - border: 1px solid #C9D2D8; - font-size: 1em; - margin-bottom: 10px; - display: block; - font: 0.9em Monaco, "Andale Mono","Courier New", Courier, mono; - line-height: 1.3em; -} - -* html hr { margin: 0; } -* html span.corners-top, * html span.corners-bottom { background-image: url("corners_left.gif"); } -* html span.corners-top span, * html span.corners-bottom span { background-image: url("corners_right.gif"); } - -.back2top { - clear: both; - height: 11px; - text-align: right; -} - -.content ol { - margin-left: 25px; -} - -/* ]]> */ -</style> - -</head> - -<body id="phpbb" class="section-docs"> - -<div id="wrap"> - <a id="top" name="top" accesskey="t"></a> - <div id="page-header"> - <div class="headerbar"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div id="doc-description"> - <a href="../index.php" id="logo"><img src="site_logo.gif" alt="" /></a> - <h1>Hook System</h1> - <p>This is an explanation of how to use the phpBB3 hook system.</p> - <p style="display: none;"><a href="#start_here">Skip</a></p> - </div> - - <span class="corners-bottom"><span></span></span></div> - </div> - </div> - - <a name="start_here"></a> - - <div id="page-body"> - - <h1>Hook System</h1> - - <div class="paragraph menu"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> - - <ol> - <li><a href="#intro">Introduction</a></li> - <li><a href="#use">Allow hooks in functions/methods</a></li> - <li><a href="#register">Registering hooks</a></li> - <li><a href="#return">Result returning</a></li> - <li><a href="#embed">Embedding your hook files/classes/methods</a></li> - <li><a href="#disclaimer">Copyright and disclaimer</a></li> - </ol> - - </div> - - <span class="corners-bottom"><span></span></span></div> - </div> - - <hr /> - - <a name="intro"></a><h2>1. Introduction</h2> - - <div class="paragraph"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> - -<h3>What is it?</h3> - -<p>The hook system allows applicaton and mod developers to hook into phpBB's or their own functions.</p> - -<h3>Pre-defined hookable phpBB3 functions</h3> - -<p>In phpBB3 there are four functions you are able to hook into with your custom functions:</p> - -<p><code>phpbb_user_session_handler();</code> which is called within phpbb_user::setup after the session and the user object is correctly initialized.<br /> -<code>append_sid($url, $params = false, $is_amp = true, $session_id = false);</code> which is called for building urls (appending the session id)<br /> -<code>$template->display($handle, $template);</code> which is called directly before outputting the (not-yet-compiled) template.<br /> -<code>exit_handler();</code> which is called at the very end of phpBB3's execution.</p> - -<p>Please note: The <code>$template->display</code> hook takes a <code>$template</code> argument, which is the template instance being used, which should be used instead of the global.</p> - -<p>There are also valid external constants you may want to use if you embed phpBB3 into your application:</p> - -<div class="codebox"><pre> -PHPBB_MSG_HANDLER (overwrite message handler) -PHPBB_DB_NEW_LINK (overwrite new_link parameter for sql_connect) -PHPBB_ROOT_PATH (overwrite $phpbb_root_path) -PHPBB_ADMIN_PATH (overwrite $phpbb_admin_path) -PHPBB_USE_BOARD_URL_PATH (use generate_board_url() for image paths instead of $phpbb_root_path) -</pre></div> - -<p>If the <code>PHPBB_USE_BOARD_URL_PATH</code> constant is set to true, phpBB uses generate_board_url() (this will return the boards url with the script path included) on all instances where web-accessible images are loaded. The exact locations are:</p> - -<ul> - <li>/includes/user.php - phpbb_user::img()</li> - <li>/includes/functions_content.php - smiley_text()</li> -</ul> - -<p>Path locations for the following template variables are affected by this too:</p> - -<ul> - <li>{T_ASSETS_PATH} - assets</li> - <li>{T_THEME_PATH} - styles/xxx/theme</li> - <li>{T_TEMPLATE_PATH} - styles/xxx/template</li> - <li>{T_SUPER_TEMPLATE_PATH} - styles/xxx/template</li> - <li>{T_IMAGESET_PATH} - styles/xxx/imageset</li> - <li>{T_IMAGESET_LANG_PATH} - styles/xxx/imageset/yy</li> - <li>{T_IMAGES_PATH} - images/</li> - <li>{T_SMILIES_PATH} - $config['smilies_path']/</li> - <li>{T_AVATAR_PATH} - $config['avatar_path']/</li> - <li>{T_AVATAR_GALLERY_PATH} - $config['avatar_gallery_path']/</li> - <li>{T_ICONS_PATH} - $config['icons_path']/</li> - <li>{T_RANKS_PATH} - $config['ranks_path']/</li> - <li>{T_UPLOAD_PATH} - $config['upload_path']/</li> - <li>{T_STYLESHEET_LINK} - styles/xxx/theme/stylesheet.css (or link to style.php if css is parsed dynamically)</li> - <li>New template variable {BOARD_URL} for the board url + script path.</li> -</ul> - - - </div> - - <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> - - <span class="corners-bottom"><span></span></span></div> - </div> - - <a name="use"></a><h2>2. Allow hooks in functions/methods</h2> - - <div class="paragraph"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> - -<p>The following examples explain how phpBB3 utilize the in-build hook system. You will be more interested in registering your hooks, but showing you this may help you understand the system better along the way.</p> - -<p>First of all, this is how a function need to be layed out if you want to allow it to be hookable...</p> - -<div class="codebox"><pre> -function my_own_function($my_first_parameter, $my_second_parameter) -{ - global $phpbb_hook; - - if ($phpbb_hook->call_hook(__FUNCTION__, $my_first_parameter, $my_second_parameter)) - { - if ($phpbb_hook->hook_return(__FUNCTION__)) - { - return $phpbb_hook->hook_return_result(__FUNCTION__); - } - } - - [YOUR CODE HERE] -} -</pre></div> - -<p>Above, the call_hook function should always be mapping your function call... in regard to the number of parameters passed.</p> - -<p>This is how you could make a method being hookable...</p> - -<div class="codebox"><pre> -class my_hookable_object -{ - function hook_me($my_first_parameter, $my_second_parameter) - { - global $phpbb_hook; - - if ($phpbb_hook->call_hook(array(__CLASS__, __FUNCTION__), $my_first_parameter, $my_second_parameter)) - { - if ($phpbb_hook->hook_return(array(__CLASS__, __FUNCTION__))) - { - return $phpbb_hook->hook_return_result(array(__CLASS__, __FUNCTION__)); - } - } - - [YOUR CODE HERE] - } -} -</pre></div> - -<p>The only difference about calling it is the way you define the first parameter. For a function it is only <code>__FUNCTION__</code>, for a method it is <code>array(__CLASS__, __FUNCTION__)</code>. In PHP4 __CLASS__ is always returning the class in lowercase.</p> - -<p>Now, in phpBB there are some pre-defined hooks available, but how do you make your own hookable function available (and therefore allowing others to hook into it)? For this, there is the add_hook() method:</p> - -<div class="codebox"><pre> -// Adding your own hookable function: -$phpbb_hook->add_hook('my_own_function'); - -// Adding your own hookable method: -$phpbb_hook->add_hook(array('my_hookable_object', 'hook_me')); -</pre></div> - -<p>You are also able to remove the possibility of hooking a function/method by calling <code>$phpbb_hook->remove_hook()</code> with the same parameters as add_hook().<br /> -This comes in handy if you want to force some hooks not to be called - at all.</p> - - </div> - - <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> - - <span class="corners-bottom"><span></span></span></div> - </div> - - <a name="register"></a><h2>3. Registering hooks</h2> - - <div class="paragraph"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> - - <h3>Registering hooks</h3> - -<p>Now to actually defining your functions which should be called. For this we take the append_sid() function as an example (this function is able to be hooked by default). We create two classes, one being static and a function:</p> - -<div class="codebox"><pre> -class my_append_sid_class -{ - // Our functions - function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false) - { - // Get possible previous results - $result = $hook->previous_hook_result('append_sid'); - - return $result['result'] . '<br />And i was the second one.'; - } -} - -// Yet another class :o -class my_second_append_sid_class -{ - function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false) - { - // Get possible previous results - $result = $hook->previous_hook_result('append_sid'); - - echo $result['result'] . '<br />I was called as the third one.'; - } -} - -// And a normal function -function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false) -{ - // Get possible previous results - $result = $hook->previous_hook_result('append_sid'); - - return 'I was called as the first one'; -} - -// Initializing the second class -$my_second_append_sid_class = new my_second_append_sid_class(); -</pre></div> - -<p>Make sure you add the same parameters to your function as is defined for the hookable function with one exception: The first variable is always <code>&$hook</code>... this is the hook object itself you are able to operate on.</p> - -<p>Now we register the hooks one by one with the <code>$phpbb_hook->register()</code> method:</p> - -<div class="codebox"><pre> -// Now, we register our append_sid "replacements" in a stacked way... -// Registering the function (this is called first) -$phpbb_hook->register('append_sid', 'my_append_sid'); - -// Registering the first class -$phpbb_hook->register('append_sid', array('my_append_sid_class', 'my_append_sid')); -$phpbb_hook->register('append_sid', array(&$my_second_append_sid_class, 'my_append_sid')); -</pre></div> - -<p>With this you are even able to make your own functions that are already hooked itself being hooked again...</p> - -<div class="codebox"><pre> -// Registering hook, which will be called -$phpbb_hook->register('append_sid', 'my_own_append_sid'); - -// Add hook to our called hook function -$phpbb_hook->add_hook('my_own_append_sid'); - -// Register added hook -$phpbb_hook->register('my_own_append_sid', 'also_my_own_append_sid'); -</pre></div> - - <h3>Special treatment/chains</h3> - - <p>The <code>register</code> method is able to take a third argument to specify a special 'chain' mode. The valid modes are <code>first</code>, <code>last</code> and <code>standalone</code></p> - - <p><code>$phpbb_hook->register('append_sid', 'my_own_append_sid', 'first')</code> would make sure that the function is called in the beginning of the chain. It is possible that more than one function is called within the first block - here the FIFO principle is used.</p> - - <p><code>$phpbb_hook->register('append_sid', 'my_own_append_sid', 'last')</code> would make sure that the function is called at the very end of the chain. It is possible that more than one function is called within the last block - here the FIFO principle is used.</p> - - <p><code>$phpbb_hook->register('append_sid', 'my_own_append_sid', 'standalone')</code> makes sure only the defined function is called. All other functions are removed from the chain and no other functions are added to it later on. If two applications try to trigger the standalone mode a PHP notice will be printed and the second function being discarded.</p> - - <h3>Only allowing hooks for some objects</h3> - - <p>Because the hook system is not able to differate between initialized objects and only operate on the class, you need to solve this on the code level.</p> - - <p>One possibility would be to use a property:</p> - - <div class="codebox"><pre> -class my_hookable_object -{ - function blabla() - { - } -} - -class my_hookable_object2 extends my_hookable_object -{ - var $call_hook = true; - - function hook_me($my_first_parameter, $my_second_parameter) - { - if ($this->call_hook) - { - global $phpbb_hook; - - if ($phpbb_hook->call_hook(array(__CLASS__, __FUNCTION__), $my_first_parameter, $my_second_parameter)) - { - if ($phpbb_hook->hook_return(array(__CLASS__, __FUNCTION__))) - { - return $phpbb_hook->hook_return_result(array(__CLASS__, __FUNCTION__)); - } - } - } - - return 'not hooked'; - } -} - -function hooking(&$hook, $first, $second) -{ - return 'hooked'; -} - -$first_object = new my_hookable_object2(); -$second_object = new my_hookable_object2(); - -$phpbb_hook->add_hook(array('my_hookable_object2', 'hook_me')); - -$phpbb_hook->register(array('my_hookable_object2', 'hook_me'), 'hooking'); - -// Do not call the hook for $first_object -$first_object->call_hook = false; - -echo $first_object->hook_me('first', 'second') . '<br />'; -echo $second_object->hook_me('first', 'second') . '<br />'; -</pre></div> - -<p>OUTPUT:</p> - -<div class="codebox"><pre> -not hooked -hooked -</pre></div> - - <p>A different possibility would be using a function variable (which could be left out on passing the function variables to the hook):</p> - - <div class="codebox"><pre> -class my_hookable_object -{ - function blabla() - { - } -} - -class my_hookable_object2 extends my_hookable_object -{ - function hook_me($my_first_parameter, $my_second_parameter, $hook_me = true) - { - if ($hook_me) - { - global $phpbb_hook; - - if ($phpbb_hook->call_hook(array(__CLASS__, __FUNCTION__), $my_first_parameter, $my_second_parameter)) - { - if ($phpbb_hook->hook_return(array(__CLASS__, __FUNCTION__))) - { - return $phpbb_hook->hook_return_result(array(__CLASS__, __FUNCTION__)); - } - } - } - - return 'not hooked'; - } -} - -function hooking(&$hook, $first, $second) -{ - return 'hooked'; -} - -$first_object = new my_hookable_object2(); -$second_object = new my_hookable_object2(); - -$phpbb_hook->add_hook(array('my_hookable_object2', 'hook_me')); - -$phpbb_hook->register(array('my_hookable_object2', 'hook_me'), 'hooking'); - -echo $first_object->hook_me('first', 'second', false) . '<br />'; -echo $second_object->hook_me('first', 'second') . '<br />'; - </pre></div> - - <p>OUTPUT:</p> - - <div class="codebox"><pre> -not hooked -hooked - </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> - - <a name="return"></a><h2>4. Result returning</h2> - - <div class="paragraph"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> - -<p>Generally, the distinction has to be made if a function returns the result obtained from the called function or continue the execution. Based on the needs of the application this may differ. Therefore, the function returns the results only if the called hook function is returning a result.</p> - -<h3>Case 1 - Returning the result</h3> - -<p>Imagine the following function supporting hooks:</p> - -<div class="codebox"><pre> -function append_sid($url, $params = false, $is_amp = true, $session_id = false) -{ - global $_SID, $_EXTRA_URL, $phpbb_hook; - - // Developers using the hook function need to globalise the $_SID and $_EXTRA_URL on their own and also handle it appropiatly. - // They could mimick most of what is within this function - if ($phpbb_hook->call_hook(__FUNCTION__, $url, $params, $is_amp, $session_id)) - { - if ($phpbb_hook->hook_return(__FUNCTION__)) - { - return $phpbb_hook->hook_return_result(__FUNCTION__); - } - } - - [...] -} -</pre></div> - -<p>Now, the following function is yours. Since you return a value, the append_sid() function itself is returning it as is:</p> - -<div class="codebox"><pre> -// The function called -function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false) -{ - // Get possible previous results - $result = $hook->previous_hook_result('append_sid'); - - return 'Since i return something the append_sid() function will return my result.'; -} -</pre></div> - -<p>To be able to get the results returned from functions higher in the change the <code>previous_hook_result()</code> method should always be used, it returns an <code>array('result' => [your result])</code> construct.</p> - -<h3>Case 2 - Not Returning any result</h3> - -<p>Sometimes applications want to return nothing and therefore force the underlying function to continue it's execution:</p> - -<div class="codebox"><pre> -function append_sid($url, $params = false, $is_amp = true, $session_id = false) -{ - global $_SID, $_EXTRA_URL, $phpbb_hook; - - // Developers using the hook function need to globalise the $_SID and $_EXTRA_URL on their own and also handle it appropiatly. - // They could mimick most of what is within this function - if ($phpbb_hook->call_hook(__FUNCTION__, $url, $params, $is_amp, $session_id)) - { - if ($phpbb_hook->hook_return(__FUNCTION__)) - { - return $phpbb_hook->hook_return_result(__FUNCTION__); - } - } - - [...] -} - -// The function called -function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false) -{ - // Get possible previous results - $result = $hook->previous_hook_result('append_sid'); - - [...] - - // I only rewrite some variables, but return nothing. Therefore, the append_sid() function will not return my (non)result. -} -</pre></div> - -<p>Please Note: The decision to return or not return is solely made of the very last function call within the hook chain. An example:</p> - -<div class="codebox"><pre> -// The function called -function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false) -{ - // Get possible previous results - $result = $hook->previous_hook_result('append_sid'); - - // $result is not filled - - return 'FILLED'; -} - -// This function is registered too and gets executed after my_append_sid() -function my_own_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false) -{ - $result = $hook->previous_hook_result('append_sid'); - - // $result is actually filled with $result['result'] = 'FILLED' - // But i return nothing, therefore append_sid() continues it's execution. -} - -// The way both functions are registered. -$phpbb_hook->register('append_sid', 'my_append_sid'); -$phpbb_hook->register('append_sid', 'my_own_append_sid'); -</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> - - <a name="embed"></a><h2>5. Embedding your hook files/classes/methods</h2> - - <div class="paragraph"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> - -<p>There are basically two methods you are able to choose from:</p> - -<p>1) Add a file to includes/hooks/. The file need to be prefixed by <code>hook_</code>. This file is included within common.php, you are able to register your hooks, include other files or functions, etc. It is advised to only include other files if needed (within a function call for example).</p> - -<p>Please be aware that you need to purge your cache within the ACP to make your newly placed file available to phpBB3.</p> - -<p>2) The second method is meant for those wanting to wrap phpBB3 without placing a custom file to the hooks directory. This is mostly done by including phpBB's files within the application file. To be able to register your hooks you need to create a function within your application:</p> - -<div class="codebox"><pre> -// My function which gets executed within the hooks constuctor -function phpbb_hook_register(&$hook) -{ - $hook->register('append_sid', 'my_append_sid'); -} - -[...] -</pre></div> - -<p>You should get the idea. ;)</p> - - </div> - - <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> - - <span class="corners-bottom"><span></span></span></div> - </div> - - <a name="disclaimer"></a><h2>6. Copyright and disclaimer</h2> - - <div class="paragraph"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> - - <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License v2</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) <a href="https://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> - - </div> - - <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> - - <span class="corners-bottom"><span></span></span></div> - </div> - - <div id="page-footer"> - <div class="version"> </div> - </div> -</div></div> - -<div> - <a id="bottom" name="bottom" accesskey="z"></a> -</div> - -</body> -</html> |