Documentation :: cBB QuickMod v1.1.1


Quick Guide • Requirements

cBB QuickMod needs very few requirements to run correctly.

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

Quick Guide • Install

  1. Unzip the cBB QuickMod zip file in a local folder on your computer.
  2. Upload all the files contained in the upload folder of that file (maintaining the directory structure) to the ext directory located in the root directory of your forum.
    The final route for the extension files should be: /ext/canidev/quickmod/
  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.

Quick Guide • Update

  1. Using your web browser, navigate to the Administration Panel and go to Customize >> Extensions, Find cBB QuickMod and click in the Disable option.
  2. Delete the folder quickmod which is within the directory /ext/canidev/ in the server.
  3. Download and unzip the cBB QuickMod 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 QuickMod and click in the Enable option.

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

Events • Core


quickmod.acp_config_vars

  • Added in version: 1.1.0
  • Location: controller/admin_controller_config.php
  • Arguments: display_vars, submit, all_actions

quickmod.setup

  • Added in version: 1.1.0
  • Location: libraries/quickmod.php
  • Arguments: actions, active

quickmod.display

  • Added in version: 1.1.0
  • Location: libraries/quickmod.php
  • Arguments: mark_options, quick_options

quickmod.before_ajax_action

  • Added in version: 1.1.0
  • Location: libraries/quickmod.php
  • Arguments: action, topic_ids

quickmod.after_ajax_action

  • Added in version: 1.1.0
  • Location: libraries/quickmod.php
  • Arguments: action, topic_ids, message

quickmod.row_content

  • Added in version: 1.1.0
  • Location: libraries/quickmod.php
  • Arguments: qm_content, selected_actions, forum_id, topic_id, topic_type, topic_status, topic_visibility

Events • Javascript


quickmod.beforeInit

  • Added in version: 1.1.1
  • Arguments: service

quickmod.afterInit

  • Added in version: 1.1.1
  • Arguments: service

quickmod.onRename

  • Added in version: 1.1.1
  • Arguments: object [service, state]

quickmod.beforeDispatch

  • Added in version: 1.1.1
  • Arguments: event [service, sendData]

quickmod.beforeSubmit

  • Added in version: 1.1.1
  • Arguments: event [service, sendData]

quickmod.afterSubmit

  • Added in version: 1.1.1
  • Arguments: event [service, sendData, result]
cron