diff options
Diffstat (limited to 'phpBB/docs')
| -rw-r--r-- | phpBB/docs/AUTHORS | 93 | ||||
| -rw-r--r-- | phpBB/docs/CHANGELOG.html | 164 | ||||
| -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 | 56 | ||||
| -rw-r--r-- | phpBB/docs/hook_system.html | 883 |
11 files changed, 295 insertions, 1033 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..ab3a42206e 100644 --- a/phpBB/docs/CHANGELOG.html +++ b/phpBB/docs/CHANGELOG.html @@ -46,6 +46,7 @@ <ol> <li><a href="#changelog">Changelog</a> <ol style="list-style-type: lower-roman;"> + <li><a href="#v310b3">Changes since 3.1.0-b3</a></li> <li><a href="#v310b2">Changes since 3.1.0-b2</a></li> <li><a href="#v310b1">Changes since 3.1.0-b1</a></li> <li><a href="#v310a3">Changes since 3.1.0-a3</a></li> @@ -92,7 +93,114 @@ <div class="content"> - <a name="v310b2"></a><h3>1.i. Changes since 3.1.0-b2</h3> + <a name="v310b3"></a><h3>1.i. Changes since 3.1.0-b3</h3> + + <h4>Bug</h4> + <ul> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-10176">PHPBB3-10176</a>] - Imageset Appearance Problem with Google Chrome Browser. </li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11226">PHPBB3-11226</a>] - filespec::move_file() from functions_upload.php does not error correctly</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11232">PHPBB3-11232</a>] - prosilver ajax.js does not respect PHPBB_USE_BOARD_URL_PATH</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11366">PHPBB3-11366</a>] - Add "MOD Version Check" for extensions to the core</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11497">PHPBB3-11497</a>] - The extension finder keeps state, so should be instantiated on each container request, not reset manually</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12025">PHPBB3-12025</a>] - Post Preview no longer shows UNAUTHORISED_BBCODE warning for disallowed BBcodes</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12074">PHPBB3-12074</a>] - Enabling/Disabling/Data deleting of an extension should generate a log entry</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12174">PHPBB3-12174</a>] - "Download all attachments" link displayed when the topic has attachments in hidden posts only</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12185">PHPBB3-12185</a>] - Topic header in viewforum too small for translation</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12270">PHPBB3-12270</a>] - Approving a topic triggers wrong notification</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12275">PHPBB3-12275</a>] - core.modify_username_string is not triggered everytime</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12332">PHPBB3-12332</a>] - Attachments with long file names break the Uploader layout</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12357">PHPBB3-12357</a>] - generate_smilies() does not work for routes</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12402">PHPBB3-12402</a>] - CAPTCHA plugin migration fails to detect missing plugins</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12415">PHPBB3-12415</a>] - Use private message instead of "pm" accronym in cpf visibility options</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12421">PHPBB3-12421</a>] - We try to display attachments in feed even for users who don't have the right to see them</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12428">PHPBB3-12428</a>] - Incorrect from version in database update log entry</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12434">PHPBB3-12434</a>] - No error message with Plupload except for files without extension</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12435">PHPBB3-12435</a>] - purge_notifications() fails for disabled extensions</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12440">PHPBB3-12440</a>] - Change URL in browsers addressbar when a view=unread#unread link was used</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12451">PHPBB3-12451</a>] - posting.php TOO_FEW_CHARS_LIMIT should be split for plurals</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12459">PHPBB3-12459</a>] - Unapproved posts/topics are not correctly handled in feeds</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12460">PHPBB3-12460</a>] - Soft deleted posts/topics are not correctly handled in feeds</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12461">PHPBB3-12461</a>] - Statistics are wrong for topic's based feeds</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12476">PHPBB3-12476</a>] - purge_cache should increase asset version</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12486">PHPBB3-12486</a>] - "Risky" tests from phpunit 4.1</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12491">PHPBB3-12491</a>] - Conflict between USERNAME_FULL in functions.php and mcp_notes.php</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12493">PHPBB3-12493</a>] - User can not send PMs to users with PMs disabled, but PM button is visible on posts</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12498">PHPBB3-12498</a>] - IE8 displays avatar in header with wrong width</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12499">PHPBB3-12499</a>] - Incorrect call to phpbb\log\log::add() in db:migrate console command</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12500">PHPBB3-12500</a>] - user.img does not set a title attribute for resulting span</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12501">PHPBB3-12501</a>] - Weird post attachment behavior in MCP report details</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12503">PHPBB3-12503</a>] - All test cases should extend phpbb_test_case instead of PHPUnit_Framework_TestCase</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12504">PHPBB3-12504</a>] - Avatar manager test is using undefined variables</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12509">PHPBB3-12509</a>] - Extentions can't send email with new notification system</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12510">PHPBB3-12510</a>] - build_url() is not encoding url entities</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12511">PHPBB3-12511</a>] - Missing language strings in memberlist group view for mobile prosilver</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12513">PHPBB3-12513</a>] - simple_headers do not support extension loaded CSS stylesheets</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12517">PHPBB3-12517</a>] - Missing argument in call to log.add() in prune_shadow_topics.php</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12519">PHPBB3-12519</a>] - m_approve language update from soft delete patch got nucked by a merge conflict</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12520">PHPBB3-12520</a>] - Can not move text with the mouse anymore in post-box when attachments are allowed</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12522">PHPBB3-12522</a>] - Add parameter description in guesser_interface</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12525">PHPBB3-12525</a>] - CONTACT_USER used with username</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12526">PHPBB3-12526</a>] - "Undefined index: filesize" error thrown when editing a PM with attachments</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12527">PHPBB3-12527</a>] - Remove translation editor from ACP</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12529">PHPBB3-12529</a>] - phpbb\controller\resolver::getController doesn't use $phpbb_root_path to check if the template dir exist</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12533">PHPBB3-12533</a>] - The notification link should fill the parent li-container in the notifications dialog</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12534">PHPBB3-12534</a>] - Enabling and disabling extensions should not abuse the red errorbox</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12536">PHPBB3-12536</a>] - Get Versions Should Not Require Both Stable and Unstable Branches</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12540">PHPBB3-12540</a>] - WRONG_FILESIZE contains broken placeholders</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12543">PHPBB3-12543</a>] - Enter key no longer works in posting when attachment error is triggered</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12547">PHPBB3-12547</a>] - Rename jquery.js to jquery.min.js in assets directory</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12548">PHPBB3-12548</a>] - [RTL] - Posting button icons should display on left side of text</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12549">PHPBB3-12549</a>] - [RTL] - Forumlist/topiclist <dfn> tags should not be visible</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12550">PHPBB3-12550</a>] - [RTL] - Last post column breaks into second line</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12551">PHPBB3-12551</a>] - [RTL] - Breadcrumb separator does not display correctly</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12561">PHPBB3-12561</a>] - Create_schema_files.php should process colum "after" instead of adding it to the JSON</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12570">PHPBB3-12570</a>] - db_text throws an error, when set() is called with the current value</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12572">PHPBB3-12572</a>] - JavaScript console throws error when alert message title is not defined (core.js bug)</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12580">PHPBB3-12580</a>] - :link Pseudo causing over specificity issues in the theme</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12586">PHPBB3-12586</a>] - \phpbb\extension\manager::all_available() should only locate ext files two levels deep and ignore dot-files/folders</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12594">PHPBB3-12594</a>] - File headers, credit lines, etc. should reflect updated legal info</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12600">PHPBB3-12600</a>] - The cli command extension:show is broken</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12604">PHPBB3-12604</a>] - Notifications Dropdown Padding Broken When Empty</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12611">PHPBB3-12611</a>] - phpBB Group copyright notice should be removed from all images</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12614">PHPBB3-12614</a>] - Do not hide post buttons before hovering over post</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12621">PHPBB3-12621</a>] - schema.json is not up to date with migration files</li> + </ul> + <h4>Improvement</h4> + <ul> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-9388">PHPBB3-9388</a>] - use DOM scripting to hide unnecessary input fields</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11163">PHPBB3-11163</a>] - Include ext/ directory in installation and update packages</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12155">PHPBB3-12155</a>] - Use CSS instead of translated images for the mini post buttons</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12407">PHPBB3-12407</a>] - Allow changing of post_data and other variables with core.posting_modify_template_vars</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12431">PHPBB3-12431</a>] - Add has_poll icon to topiclists</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12433">PHPBB3-12433</a>] - QUOTE_DEPTH_EXCEEDED needs a different string for '1'</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12488">PHPBB3-12488</a>] - Add user warning indication to viewtopic posts</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12507">PHPBB3-12507</a>] - Add console command to purge the cache</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12518">PHPBB3-12518</a>] - Allow extensions to overwrite CANNOT_EDIT_* checks in posting.php and viewtopic.php</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12523">PHPBB3-12523</a>] - Add search_results.html template events search_results_topic_(before/after)</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12524">PHPBB3-12524</a>] - Add search.php core event to modify search results rowset</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12531">PHPBB3-12531</a>] - Restore default topic title links in subsilver2</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12555">PHPBB3-12555</a>] - Make use of canonical urls to avoid duplicate content</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12583">PHPBB3-12583</a>] - Add event core.mcp_warn_post_before/after</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12584">PHPBB3-12584</a>] - Add event core.mcp_warn_user_before/after</li> + </ul> + <h4>Sub-task</h4> + <ul> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12576">PHPBB3-12576</a>] - Remove cron from common.php</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12585">PHPBB3-12585</a>] - Don't check the cron on each page load</li> + </ul> + <h4>Task</h4> + <ul> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-10839">PHPBB3-10839</a>] - Remove phpunit.xml.functional and always include functional tests</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12384">PHPBB3-12384</a>] - Run Travis CI HHVM tests against MySQLi instead of MySQL</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12495">PHPBB3-12495</a>] - Add Sami to composer dependencies and build script</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12544">PHPBB3-12544</a>] - Update Plupload to 2.1.2</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12582">PHPBB3-12582</a>] - Strip away copyrighted ICC profile from images</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12592">PHPBB3-12592</a>] - Run mysql driver on Travis CI</li> + <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12603">PHPBB3-12603</a>] - Remove hook_system.html from docs</li> + </ul> + + + <a name="v310b2"></a><h3>1.ii. Changes since 3.1.0-b2</h3> <h4>Bug</h4> <ul> @@ -257,7 +365,7 @@ </ul> - <a name="v310b1"></a><h3>1.ii. Changes since 3.1.0-b1</h3> + <a name="v310b1"></a><h3>1.iii. Changes since 3.1.0-b1</h3> <h4>Bug</h4> <ul> @@ -325,7 +433,7 @@ <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12302">PHPBB3-12302</a>] - Upgrade composer.phar to 1.0.0-alpha8</li> </ul> - <a name="v310a3"></a><h3>1.iii. Changes since 3.1.0-a3</h3> + <a name="v310a3"></a><h3>1.iv. Changes since 3.1.0-a3</h3> <h4>Bug</h4> <ul> @@ -472,7 +580,7 @@ </ul> - <a name="v310a2"></a><h3>1.iv. Changes since 3.1.0-a2</h3> + <a name="v310a2"></a><h3>1.v. Changes since 3.1.0-a2</h3> <h4>Bug</h4> <ul> @@ -580,7 +688,7 @@ <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-12147">PHPBB3-12147</a>] - Remove Travis CI notification configuration</li> </ul> - <a name="v310a1"></a><h3>1.v. Changes since 3.1.0-a1</h3> + <a name="v310a1"></a><h3>1.vi. Changes since 3.1.0-a1</h3> <h4>Bug</h4> <ul> @@ -656,7 +764,7 @@ <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11998">PHPBB3-11998</a>] - Add console / command line client environment </li> </ul> - <a name="v30x"></a><h3>1.vi. Changes since 3.0.x</h3> + <a name="v30x"></a><h3>1.vii. Changes since 3.0.x</h3> <h4>Bug</h4> <ul> @@ -1337,7 +1445,7 @@ <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11913">PHPBB3-11913</a>] - Apply reorganisation of download.phpbb.com to build_announcement.php</li> </ul> - <a name="v3011"></a><h3>1.vii. Changes since 3.0.11</h3> + <a name="v3011"></a><h3>1.viii. Changes since 3.0.11</h3> <h4>Bug</h4> <ul> @@ -1492,7 +1600,7 @@ <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11753">PHPBB3-11753</a>] - Upgrade mysql_upgrader.php schema data.</li> </ul> - <a name="v3010"></a><h3>1.viii. Changes since 3.0.10</h3> + <a name="v3010"></a><h3>1.ix. Changes since 3.0.10</h3> <h4>Bug</h4> <ul> @@ -1617,7 +1725,7 @@ <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-10909">PHPBB3-10909</a>] - Update Travis Test Configuration: Travis no longer supports PHP 5.3.2</li> </ul> - <a name="v309"></a><h3>1.ix. Changes since 3.0.9</h3> + <a name="v309"></a><h3>1.x. Changes since 3.0.9</h3> <h4>Bug</h4> <ul> @@ -1753,7 +1861,7 @@ <li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-10480">PHPBB3-10480</a>] - Automate changelog building</li> </ul> - <a name="v308"></a><h3>1.x. Changes since 3.0.8</h3> + <a name="v308"></a><h3>1.xi. Changes since 3.0.8</h3> <h4> Bug </h4> @@ -2121,7 +2229,7 @@ </ul> - <a name="v307-PL1"></a><h3>1.xi. Changes since 3.0.7-PL1</h3> + <a name="v307-PL1"></a><h3>1.xii. Changes since 3.0.7-PL1</h3> <h4> Security </h4> <ul> @@ -2579,13 +2687,13 @@ </ul> - <a name="v307"></a><h3>1.xii. Changes since 3.0.7</h3> + <a name="v307"></a><h3>1.xiii. Changes since 3.0.7</h3> <ul> <li>[Sec] Do not expose forum content of forums with ACL entries but no actual permission in ATOM Feeds. (Bug #58595)</li> </ul> - <a name="v306"></a><h3>1.xiii. Changes since 3.0.6</h3> + <a name="v306"></a><h3>1.xiv. Changes since 3.0.6</h3> <ul> <li>[Fix] Allow ban reason and length to be selected and copied in ACP and subsilver2 MCP. (Bug #51095)</li> @@ -2689,7 +2797,7 @@ </ul> - <a name="v305"></a><h3>1.xiv. Changes since 3.0.5</h3> + <a name="v305"></a><h3>1.xv. Changes since 3.0.5</h3> <ul> <li>[Fix] Allow whitespaces in avatar gallery names. (Bug #44955)</li> @@ -2911,7 +3019,7 @@ <li>[Feature] Send anonymous statistical information to phpBB on installation and update (optional).</li> </ul> - <a name="v304"></a><h3>1.xv. Changes since 3.0.4</h3> + <a name="v304"></a><h3>1.xvi. Changes since 3.0.4</h3> <ul> <li>[Fix] Delete user entry from ban list table upon user deletion (Bug #40015 - Patch by TerraFrost)</li> @@ -3000,7 +3108,7 @@ <li>[Sec] Only use forum id supplied for posting if global announcement detected. (Reported by nickvergessen)</li> </ul> - <a name="v303"></a><h3>1.xvi. Changes since 3.0.3</h3> + <a name="v303"></a><h3>1.xvii. Changes since 3.0.3</h3> <ul> <li>[Fix] Allow mixed-case template directories to be inherited (Bug #36725)</li> @@ -3032,7 +3140,7 @@ <li>[Sec] Ask for forum password if post within passworded forum quoted in private message. (Reported by nickvergessen)</li> </ul> - <a name="v302"></a><h3>1.xvii. Changes since 3.0.2</h3> + <a name="v302"></a><h3>1.xviii. Changes since 3.0.2</h3> <ul> <li>[Fix] Correctly set topic starter if first post in topic removed (Bug #30575 - Patch by blueray2048)</li> @@ -3131,7 +3239,7 @@ <li>[Sec Precaution] Stricter validation of the HTTP_HOST header (Thanks to Techie-Micheal et al for pointing out possible issues in derived code)</li> </ul> - <a name="v301"></a><h3>1.xviii. Changes since 3.0.1</h3> + <a name="v301"></a><h3>1.xix. Changes since 3.0.1</h3> <ul> <li>[Fix] Ability to set permissions on non-mysql dbms (Bug #24955)</li> @@ -3179,7 +3287,7 @@ <li>[Sec] Only allow urls gone through redirect() being used within login_box(). (thanks nookieman)</li> </ul> - <a name="v300"></a><h3>1.xix. Changes since 3.0.0</h3> + <a name="v300"></a><h3>1.xx. Changes since 3.0.0</h3> <ul> <li>[Change] Validate birthdays (Bug #15004)</li> @@ -3250,7 +3358,7 @@ <li>[Fix] Find and display colliding usernames correctly when converting from one database to another (Bug #23925)</li> </ul> - <a name="v30rc8"></a><h3>1.xx. Changes since 3.0.RC8</h3> + <a name="v30rc8"></a><h3>1.xxi. Changes since 3.0.RC8</h3> <ul> <li>[Fix] Cleaned usernames contain only single spaces, so "a_name" and "a__name" are treated as the same name (Bug #15634)</li> @@ -3259,7 +3367,7 @@ <li>[Fix] Call garbage_collection() within database updater to correctly close connections (affects Oracle for example)</li> </ul> - <a name="v30rc7"></a><h3>1.xxi. Changes since 3.0.RC7</h3> + <a name="v30rc7"></a><h3>1.xxii. Changes since 3.0.RC7</h3> <ul> <li>[Fix] Fixed MSSQL related bug in the update system</li> @@ -3294,7 +3402,7 @@ <li>[Fix] No duplication of active topics (Bug #15474)</li> </ul> - <a name="v30rc6"></a><h3>1.xxii. Changes since 3.0.RC6</h3> + <a name="v30rc6"></a><h3>1.xxiii. Changes since 3.0.RC6</h3> <ul> <li>[Fix] Submitting language changes using acp_language (Bug #14736)</li> @@ -3304,7 +3412,7 @@ <li>[Fix] Able to request new password (Bug #14743)</li> </ul> - <a name="v30rc5"></a><h3>1.xxiii. Changes since 3.0.RC5</h3> + <a name="v30rc5"></a><h3>1.xxiv. Changes since 3.0.RC5</h3> <ul> <li>[Feature] Removing constant PHPBB_EMBEDDED in favor of using an exit_handler(); the constant was meant to achive this more or less.</li> @@ -3367,7 +3475,7 @@ <li>[Sec] New password hashing mechanism for storing passwords (#i42)</li> </ul> - <a name="v30rc4"></a><h3>1.xxiv. Changes since 3.0.RC4</h3> + <a name="v30rc4"></a><h3>1.xxv. Changes since 3.0.RC4</h3> <ul> <li>[Fix] MySQL, PostgreSQL and SQLite related database fixes (Bug #13862)</li> @@ -3418,7 +3526,7 @@ <li>[Fix] odbc_autocommit causing existing result sets to be dropped (Bug #14182)</li> </ul> - <a name="v30rc3"></a><h3>1.xxv. Changes since 3.0.RC3</h3> + <a name="v30rc3"></a><h3>1.xxvi. Changes since 3.0.RC3</h3> <ul> <li>[Fix] Fixing some subsilver2 and prosilver style issues</li> @@ -3527,7 +3635,7 @@ </ul> - <a name="v30rc2"></a><h3>1.xxvi. Changes since 3.0.RC2</h3> + <a name="v30rc2"></a><h3>1.xxvii. Changes since 3.0.RC2</h3> <ul> <li>[Fix] Re-allow searching within the memberlist</li> @@ -3573,7 +3681,7 @@ </ul> - <a name="v30rc1"></a><h3>1.xxvii. Changes since 3.0.RC1</h3> + <a name="v30rc1"></a><h3>1.xxviii. Changes since 3.0.RC1</h3> <ul> <li>[Fix] (X)HTML issues within the templates (Bug #11255, #11255)</li> @@ -3708,7 +3816,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..a4ba4cb87c --- /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..173c7e5441 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 66b558a665..44a7824901 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 @@ -52,6 +64,20 @@ acp_overall_header_head_append * Since: 3.1.0-a1 * Purpose: Add assets within the `<head>` tags in the ACP +acp_posting_buttons_after +=== +* Locations: + + adm/style/acp_posting_buttons.html +* Since: 3.1.0-b4 +* Purpose: Add content after BBCode posting buttons in the ACP + +acp_posting_buttons_before +=== +* Locations: + + adm/style/acp_posting_buttons.html +* Since: 3.1.0-b4 +* Purpose: Add content before BBCode posting buttons in the ACP + acp_simple_footer_after === * Location: adm/style/simple_footer.html @@ -124,20 +150,6 @@ acp_users_prefs_view_prepend * Since: 3.1.0-b3 * Purpose: Add user options fieldset to the top of ACP users view prefs settings -acp_users_signature_editor_buttons_after -=== -* Locations: - + adm/style/acp_users_signature.html -* Since: 3.1.0-a3 -* Purpose: Add content after BBCode posting buttons in the ACP user signature - -acp_users_signature_editor_buttons_before -=== -* Locations: - + adm/style/acp_users_signature.html -* Since: 3.1.0-a3 -* Purpose: Add content before BBCode posting buttons in the ACP user signature - forumlist_body_category_header_after === * Locations: @@ -601,6 +613,22 @@ search_results_postprofile_before * Since: 3.1.0-b3 * Purpose: Add content directly before the post author in search results (posts view mode) +search_results_topic_after +=== +* Locations: + + styles/prosilver/template/search_results.html + + styles/subsilver2/template/search_results.html +* Since: 3.1.0-b4 +* Purpose: Add data after search result topics + +search_results_topic_before +=== +* Locations: + + styles/prosilver/template/search_results.html + + styles/subsilver2/template/search_results.html +* Since: 3.1.0-b4 +* Purpose: Add data before search result topics + simple_footer_after === * Locations: 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> |