Documentation :: cBB QuickMod


Quick Guide • Requirements

cBB QuickMod needs very few requirements to function correctly.

The basic requirements are:
  1. A previously installed phpBB forum, whose version is 3.1.3 or higher (3.2.0 is the recommended).
  2. The browser must support Javascript in order to use and manage the extension.

Quick Guide • Install

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

  1. Unzip the cBB QuickMod 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 QuickMod 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 • Uninstall

cBB QuickMod can be uninstalled in a few steps:

  1. Using your web browser, visit the Administration Panel and go to Customise >> Manage Extensions
  2. Find cBB QuickMod and click in the Disable option.
  3. When the extension is disabled, if you want to delete completly, click in Delete data and remove the directory /ext/canidev/quickmod from your server.

Main Functions • Mark Topics

Apart from being able to mark each topic manually, there is a speed dial menu to facilitate the moderation of several topics simultaneously.

  1. Mark All: This option mark all the topics in the list.
  2. Unmark All: Unmark all the topics in the list.
  3. Mark Locked Topics: Mark only the locked topics in the list.
  4. Mark Unlocked Topics: Mark only the unlocked topics in the list.
  5. Mark Moved Topics: Mark only the shadow topics in the list.
  6. Mark Normal Topics: Mark only the normal topics.
  7. Marl Stucky Topics: Mark only the topics set as Sticky.
  8. Mark Announcements: Mark only the topics set as Announcements.
  9. Mark Global Topics: Mark only the topics set as Global.

Main Functions • Quick Functions

The quick functions are actions that can be applied to one topic individually, directly with one click.

The available quick functions are:
  1. Approve.
  2. Change author.
  3. Change publish date.
  4. Change icon.
  5. Lock.
  6. Unlock.
  7. Delete.
  8. Restore.
  9. Delete permanently.
  10. Change to Normal.
  11. Change to Sticky.
  12. Change to Announcement.
  13. Change to Global.
  14. Move.
  15. Rename.

Main Functions • Full Functions

The complete functions are actions that can be supplied for more topics at same time.

The available full functions are:
  1. Approve.
  2. Change author.
  3. Change publish date.
  4. Change icon.
  5. Lock.
  6. Unlock.
  7. Delete.
  8. Restore.
  9. Delete permanently.
  10. Change to Normal.
  11. Change to Sticky.
  12. Change to Announcement.
  13. Change to Global.
  14. Move.

Use • Use from PC


Passing the mouse over a topic will appear the icons of the quick actions (if we have configured them as icons) and also, we will see a checkbox that will serve to select that topic in question (and to be able to perform an action on more than one topic at a time).

If we have configured that the quick actions appear as a context menu, we will have to right click on the topic to see the menu with the options.

Use • Use from Mobile


The use from the mobile is something other than the pc, as we do not have right click or mouse to go over the topics.

In mobile, all actions are executed from the icon of each topic.
  1. A simple touch selects that topic.
  2. A long touch shows a menu with quick actions

Manage • General Options

Browsing to ACP >> Extensions >> QuickMod you can manage al the extension options.

The available options in this version are:
  1. Require confirmation: Set if you need to confirm the quick actions with a confirm box.
  2. Icon display: Allow you to select the aspect of the Quick Actions buttons.
  3. Manage Buttons: From here you can establish what quick actions will be shown and in what order they will.
    Apart from what is established here, the appearance or not of each quick action will depend on the permissions that the user has.

Manage • Permissions

cBB QuickMod no needs aditional permissions.
This extension use the standard moderation permissions to run.

Events • Core Events


quickmod.acp_config_vars

  • Added in version: 1.1.0
  • Location: acp\main_module.php
  • Arguments: display_vars, submit, all_actions
  • Description: Event used to add / modify options in the extension.

quickmod.setup

  • Added in version: 1.1.0
  • Location: quickmod.php
  • Arguments: actions, active
  • Description: Event used to set additional configuration when the extension load.

quickmod.display

  • Added in version: 1.1.0
  • Location: quickmod.php
  • Arguments: mark_options
  • Description: Event used to modify the extension's variables in the style.

quickmod.before_ajax_action

  • Added in version: 1.1.0
  • Location: quickmod.php
  • Arguments: action, topic_ids
  • Description: Event used to modify the data sent in the AJAX request before processing.

quickmod.after_ajax_action

  • Added in version: 1.1.0
  • Location: quickmod.php
  • Arguments: action, topic_ids, message
  • Description: Event used to add new functions to the AJAX request.

quickmod.row_content

  • Added in version: 1.1.0
  • Location: quickmod.php
  • Arguments: qm_content, selected_actions, forum_id, topic_id, topic_type, topic_status, topic_visibility
  • Description: Event used to add content to each row (topic) in the style.

Events • Javascript Events


quickmod.onInit

  • Added in version: 1.1.0
  • Arguments: Ninguno
  • Description: Event that loads when the extension start.

quickmod.beforeSubmit

  • Added in version: 1.1.0
  • Arguments: send_data
  • Description: Event that loads before sending the AJAX request to the server.