Documentation :: cBB Chat v1.1.1


Quick Guide • Requirements

cBB Chat needs very few requirements to run correctly.

The basic requirements are:
  1. A phpBB forum whose version is equal or greater than 3.1.1 (3.1.2 is recommended).
  2. The explorer must be support Javascript to use and manage the mod.

Quick Guide • Install

If you already have basic knowledge of FTP and are sure that your system will run smoothly cBB Chat, just follow these simple steps to install it.

  1. Unzip the cBB Chat zip file in a local folder on your computer.
  2. Upload all files contained in the upload directory in that file (keeping the directory structure) to the ext directory in the root of your forum.
  3. Using your web browser, navigate to the Administration Panel and go to Customize >> Extensions
  4. Find cBB Chat and click in the Enable option.
  5. When the extension is enabled, go to ACP >> General and click in Clear cache.

If you experienced problems or do not know how to proceed with any of the steps above, you can put your problem in the correct section of this web forum, where it will help as we can.

Quick Guide • Update

  1. Using your web browser, navigate to the Administration Panel and go to Customize >> Extensions, Find cBB Chat and click in the Disable option.
  2. Delete the folder chat which is within the directory /ext/canidev/ in the server.
  3. Download and unzip the cBB Chat zip file in a local folder on your computer.
  4. Upload all files contained in the upload directory in that file (keeping the directory structure) to the ext directory in the root of your forum.
  5. Using your web browser, navigate to the Administration Panel and go to Customize >> Extensions, Find cBB Chat and click in the Enable option.
  6. When the extension is enabled, go to ACP >> General and click in Clear cache.

Quick Guide • Uninstall

cBB Chat can be uninstalled in a few steps:

  1. Using your web browser visit the location you placed phpBB3 adding /chat/install/,
    Examples:
    http://www.mydomain.com/phpBB3/chat/install/
    http://www.mydomain.com/forum/chat/install/
  2. Click on the "Uninstall" option and follow the steps and fill out all the requested information.
  3. When finished, You have to edit the phpBB files following the steps of "install.xml" file, but in reverse, to remove the mod code. This is not essential, the forum works well even if you don't delete the mod codes.
  4. Using your web browser, visit the Administration Panel and go to Customise >> Manage Extensions
  5. Find cBB Chat and click in the Disable option.
  6. When the extension is disabled, if you want to delete completly, click in Delete data and remove the directory /ext/canidev/chat from your server.

Tricks • Multiline texts

By default, on press the "Enter" key, the chat sends the chat message.
You can write multiline texts by using the Key Combination Ctrl + Enter. This produces a line break in the message.

Tricks • Automatic list creation

The chat editor can be convert many lines in a shorted or numeric list automatically.
To use this function you must select the lines to convert and do click in the List or Numeric List BBcode.

For example:
Line 1
Line 2
Line 3
Will be converted to: [list]
[*]Line 1
[*]Line 2
[*]Line 3
[/list]

Eventos • Eventos de Core


chat.acp_config_vars

  • Added in version: 1.1.1
  • Location: acp\main_module.php
  • Arguments: display_vars, submit
  • Description: Event used to add / modify the parameters of the chat settings page.

chat.custom_bbcodes_modify_sql

  • Added in version: 1.1.1
  • Location: chat.php
  • Arguments: sql_ary
  • Description: Event used to modify the query responsible of read bbcodes that appears on the chat.

chat.generate_bbcodes

  • Added in version: 1.1.1
  • Location: chat.php
  • Arguments: bbcode_name, template_key, row, item_ary
  • Description: Event used to add / modify bbcodes shown in chat.

chat.generate_smilies

  • Added in version: 1.1.1
  • Location: chat.php
  • Arguments: row, item_ary
  • Description: Event used to add / modify smilies shown in chat.

Eventos • Eventos Javascript


chat.beforeInit

  • Added in version: 1.1.1
  • Arguments: None
  • Description: Event which is loaded before displaying the chat.

chat.beforeSubmit

  • Added in version: 1.1.1
  • Arguments: None
  • Description: Event that is loaded when the user sends a message in chat, before it is processed.

chat.onBindRows

  • Added in version: 1.1.1
  • Arguments: None
  • Description: Event that loads when new messages are displayed in chat and assigned appropriate actiona.

chat.onBindTabs

  • Added in version: 1.1.1
  • Arguments: None
  • Description: Event that is loaded when allocating the actions of the chat tabs.

chat.onBindUserlist

  • Added in version: 1.1.1
  • Arguments: None
  • Description: Event that is loaded when assigning the actions of list of users.

chat.onConnect

  • Added in version: 1.1.1
  • Arguments: None
  • Description: Event that is loaded when the user connects to the chat.

chat.onDisconnect

  • Added in version: 1.1.1
  • Arguments: None
  • Description: Event that is loaded when the user disconnects from the chat.

chat.onInit

  • Added in version: 1.1.1
  • Arguments: None
  • Description: Event which is loaded when displaying the chat.

Eventos • Eventos de Plantillas


chat_body_after

  • Added in version: 1.1.1
  • Location: event\overall_footer_content_after.html
  • Description: Add content after the chat box.

chat_body_before

  • Added in version: 1.1.1
  • Location: event\overall_footer_content_after.html
  • Description: Add content before the chat box.

chat_bbcodebox_after

  • Added in version: 1.1.1
  • Location: event\overall_footer_content_after.html
  • Description: Add content to the end of the bbcodes box.

chat_smileybox_after

  • Added in version: 1.1.1
  • Location: event\overall_footer_content_after.html
  • Description: Add content to the end of the smilies box.
cron