扩展开发

此页面的官方英文版还未最终确立，因此暂不提供翻译

The nature of the extension system allows you to easily extend FluxBB's functionality without touching the source code of the core. The way FluxBB manages this is using hooks and a manifest that describes how to use them.

This page outlines how we expect FluxBB extensions to be written. These are both designed to make sure all extensions are secure and of good quality, and also to help developers write them. It is important that you read this entire page before you begin developing extensions.

The rules and recommendations set forth in this section apply to PHP, JavaScript, SQL and any other programming language (where applicable) in use by FluxBB. Please note that tabs in this document have been substituted by spaces for visual reasons only.

The naming rules apply to the naming of variables, functions, classes, attributes, arrays, array elements, HTML form fields, query string parameters, database tables, database fields as well as any other applicable entities.

• All names should be all lowercase.
• Use _ (underscore) as word seperator. E.g. date_format. Never start a name with the underscore character.
• Use the prefix “num” for entities that represent a count. E.g. num_users. Use the prefix “cur” for entities that represent the current element when iterating through any type of collection (database result set, array etc).
• Avoid all forms of Hungarian notation or derivates or variations thereof.
• Use common sense. If in doubt, look at similar sections in the FluxBB source code.

The indent style and brace policy of choice for the FluxBB project is the Allman style. All indentation should be made with tabs, not spaces. Here's an example:

if ($a == $b)
{
    do_something();
}
else
{
    do_something_else();
}

Note the whitespace between the keyword and the parenthesis. One allowed exception from the standard Allman style is “braceless” blocks. The use of braceless blocks is actually encouraged. For example:

if ($a == $b)
    do_something();
else
    do_something_else();

If the author prefers it, the code block can also be placed on the same line as the control statement.

All line breaks should be LF only. Set your editor to save files with UNIX style line breaks.

The following rules apply only to PHP.

• Use singlequotes as opposed to doublequotes when working with strings. E.g. $str = 'Users: '.$num_users; as opposed to $str = "Users: $num_users";.
• Leave one line of whitespace above and below each block of markup, provided the block constitutes multiple lines of markup. I.e. one empty line above each ?> and below each <?php. The exception to this is when there is only one line of code, in which case the entire section of code should be on one line.
• Don't use PHP's short tags (<?, <?=), but use its full equivalent (<?php, <?php echo).

The following rules apply only to SQL.

• Always escape potentially harmful data using $forum_db->escape(). Expected integer values should be forced into integer form using intval() before use in a query.
• Prefix tables names and table indices with $forum_db->prefix.
• Use the SQL2003 style explicit join notation.
• Whenever possible, write cross-database compatible queries. If database specific queries are required, provide alternative queries for other supported databases.

Validating/escaping data before saving in the db and before outputting to browser

All extensions come with a manifest file, manifest.xml. The manifest file is basically the entry point to an extension. It is a regular XML file that contains information about the extension, such as author name, short description of what it does, and what version of FluxBB it requires.¹⁾ It also has information about hooks, and how FluxBB should use them.

A typical manifest file looks like this:

<?xml version="1.0" encoding="UTF-8"?>
 
<extension engine="1.0">
  <id>example_extension</id>
  <title>Example Extension</title>
  <version>0.1</version>
  <description>This is a short description of the extension.</description>
  <author>John Doe</author>
  <minversion>1.3 Beta</minversion>
  <maxtestedon>1.3 Beta</maxtestedon>
  <dependencies>
    <dependency>another_extension</dependency>
  </dependencies>
 
  <hooks>
    <hook id="vf_start"><![CDATA[
	// Include a file from the extension directory
	require $ext_info['path'].'/foobar.php';
    ]]></hook>
    <hook id="vf_pre_header_load"><![CDATA[
	// Call a function from foobar.php
	foobar_function();
    ]]></hook>
  </hooks>
</extension>

Now we will break this down:

<?xml version="1.0" encoding="UTF-8"?>

This is the basic XML declaration that describes what version of XML the document follows, and what character encoding is used. Since FluxBB has full support for UTF-8 from version 1.3 onwards, you should use UTF-8 encoding.

<extension engine="1.0">

This tells FluxBB which extension engine the extension was designed for. This is required in case the FluxBB extension system is significantly changed in the future (making old extensions incompatible). The current extension engine version is 1.0.

<id>example_extension</id>

This is an identifier of the extension. FluxBB uses this for identifying each of your installed extensions, so it should be unique. Note that the extension directory should be named after the extension ID. A good idea would be to use only lowercase letters and the underscore character “_” for spaces. The ID cannot be more than 50 characters long.

<title>Example Extension</title>

This is the title of your extension. Use your imagination.

<version>0.1</version>

The version number of your extension. You should follow the version numbering rules in determining what version number to use.

<author>John Doe</author>

This is your name. Does not require that much imagination now, does it?

<minversion>1.3 Beta</minversion>
<maxtestedon>1.3 Beta</maxtestedon>

The minimum of FluxBB the extension requires, and the maximum version it was tested on. If your FluxBB version is lower than minversion or maxtestedon, FluxBB gives you a warning when installing the extension.

  <dependencies>
    <dependency>another_extension</dependency>
  </dependencies>

This tells FluxBB to only allow this extension to be installed if the given dependencies are both installed and enabled, it will also stop any given extensions being uninstalled or disabled while this extension is running.

Explain <install> XML

One important thing to note about the install procedure is it will be repeated when upgrading, therefore it should check before it does anything that only needs to be done once.

Hooks are special “tags” in the FluxBB code, that can be replaced with any piece of code specified in a manifest file. A typical hook looks like this:

($hook = get_hook('vf_start')) ? eval($hook) : null;

What you need to pay attention to here is “vf_start”. This is the name of the hook. In this case, the hook resides in the beginning of viewforum.php (thus the prefix “vf_”). If you were to replace that hook with a code snippet of your own, you will need to remember this name for the manifest.

<hooks>
  <hook id="vf_start"><![CDATA[
	// Include a file from the extension directory
	require $ext_info['path'].'/foobar.php';
  ]]></hook>
  <hook id="vf_pre_header_load"><![CDATA[
	// Call a function from foobar.php
	foobar_function();
  ]]></hook>
</hooks>

The hooks section tells FluxBB what to do with the hooks. It has subsections for each hook used in the extension, identified with their name. The PHP code with which the hook is replaced with resides in the CDATA section (identified by the <![CDATA[ and ]]> tags). That is, the hooks vf_start and vf_pre_header_load will be replaced with anything you enter in their respective CDATA sections.²⁾

This example uses two hooks, both in viewforum.php.³⁾ The first hook (vf_start) simply includes a PHP file from the extension directory. As you can see, we use $ext_info['path'] to get the path to the extensions folder. The second hook simply calls a function called defined in foobar.php.

In addition to “merely” adding functions through external files, hooks allow you to circumvent FluxBB's core functionality, and replace them with your own. For example, you can use temporary variables to get around the BBCode parser, and replace it with a completely different parser.⁴⁾

If you want to repeat code in multiple hooks you can do it by separating the hook nams with a ”,” the code below shows how to use the same code in vf_start and vt_start

<hooks>
  <hook id="vf_start, vt_start"><![CDATA[
	// Do something in both viewforum and viewtopic
  ]]></hook>
</hooks>

When using hooks we can also give them a priority, this is in case of conflicts with other extensions. To set the priority see the following example (the default priority is 5)

<hooks>
  <hook id="vf_start" priority="2"><![CDATA[
	// Include a file from the extension directory
	require $ext_info['path'].'/foobar.php';
  ]]></hook>
</hooks>

All extensions are contained within a single folder which is named after their id, this folder is then placed in the extensions directory within FluxBB, i.e. for the above extensions this would be extensions/example_extension/* where * is the extensions files.

The manifest file is saved as manifest.xml and put directly in the extensions folder.

If the extension contains any strings that could be translated these should be put in a language file. The structure for language files is extensions/ext_id/lang/Language.php, for example extensions/example_extension/lang/English.php. The language file would then contain

<?php
 
$lang_example_extension = array(
'Example 1'		=>	'An example language string',
);

To include the language file the following code would be used

	if (file_exists($ext_info['path'].'/lang/'.$forum_user['language'].'.php'))
		require $ext_info['path'].'/lang/'.$forum_user['language'].'.php';
	else
		require $ext_info['path'].'/lang/English.php';

Notice $ext_info['path'] is used for the extensions directory, and if the users language is not avaliable a default language is loaded.

• You must not use includes in the install or uninstall process. All of the code for these must be contained within the manifest.xml file.
• When using includes in hooks in general you must only include functions and libraries, you may not put all the code from a hook in a separate file and include it.

Extension versions should be numbered in the same format as FluxBB, that is for example 1.2.3 where 1 is the major version, 2 is the minor version and 3 is the release. Extensions in beta stages should be numbered 0.x.x, each time new functionality is added the minor version should be increased, and after a full/major rewrite the major number should be increased. Small bugfixes should increase the release number.

Every extension is provided with the $ext_info array, which contains information about the extension.

Extensions in FluxBB can be disabled from the admin panel, this does not uninstall the extension but simply turns off its hooks, it is important you think about this when coding your extension. This generally means you cannot edit the core database, i.e. do not drop core tables or fields.

It is also important that you make sure any files in your extension that are accessed directly return some form of error message if they are accessed when the extension is disabled.

It is important your extension works in all 3 databases supported by FluxBB, to do this you should use functions provided in the database abstraction layer (need more details here) as much as possible. If you need help testing the different databases you can ask in the forums.

An example query from post.php. Don't use $query in extensions as this variable is used in the core and might interfere with it. Use $ext_query or any other name you like

$query = array(
  'SELECT'	=> 'f.id, f.forum_name, f.moderators, f.redirect_url, fp.post_replies, fp.post_topics, t.subject, t.closed, s.user_id AS is_subscribed',
  'FROM'		=> 'topics AS t',
  'JOINS'		=> array(
    array(
      'INNER JOIN'	=> 'forums AS f',
      'ON'			=> 'f.id=t.forum_id'
    ),
    array(
      'LEFT JOIN'		=> 'forum_perms AS fp',
      'ON'			=> '(fp.forum_id=f.id AND fp.group_id='.$forum_user['g_id'].')'
    ),
    array(
      'LEFT JOIN'		=> 'subscriptions AS s',
      'ON'			=> '(t.id=s.topic_id AND s.user_id='.$forum_user['id'].')'
    )
  ),
  'WHERE'		=> '(fp.read_forum IS NULL OR fp.read_forum=1) AND t.id='.$tid
);

When writing extensions it is important you think about the task your extension will perform, where possible try to do one task and do it well. When writing more complex extensions it is best to break them down into multiple extensions and use dependencies to combine them. For example a donation extension could be separate from a cash extension but depend on it. Then users who do not want the donate function can not install that part.

Even extensions themselves can be extended. Use hooks in your extension to give other developers the chance to enhance your extension. Your hook may look like the following:

($hook = get_hook('xn_example_extension_common')) ? eval($hook) : null;

• xn stands for extension
• Replace example_extension with the id of your extension to create a unique namespace
• common is the key of your hook - in this case a common point (e.g.for variable modifications)
• If the hook is placed within a FluxBB file it should contain the files id used for FluxBB hooks. i.e. xn_example_extension_vt_hookname for a hook in viewtopic.php

Hooks of extensions can be used exactly like normal hooks. To guarantee that the extension you extended is available, add dependencies to your manifest.