| 1 |
|
|---|
| 2 | IMPORTANT: For the latest and extended version of this manual go to http://www.boonex.com/trac/dolphin/wiki/DolModDev
|
|---|
| 3 |
|
|---|
| 4 | The main feature of Dolphin 7 for developers in new modules structure and a lot of ready tools which help wring new modules more quickly. Modules are located in modules/{Vendor}/{Module Name} directory. See BoonEx modules for live examples.
|
|---|
| 5 |
|
|---|
| 6 | This is a quick overview of the features developer can use, for exact description of each feature see appropriate class or file. The following features are available for modules, all these can be done without modifying any single line in base package:
|
|---|
| 7 |
|
|---|
| 8 | * Privacy – your content can have privacy settings, which member set for any content, see BxDolPrivacy class.
|
|---|
| 9 |
|
|---|
| 10 | * Alerts – Dolphin rise alerts (events) for different actions, modules can catch these alerts and receive notifications about these updates. Not only Dolphin rise alerts, but modules too, so it is possible to receive notifications about modules alerts. For more information see BxDolAlerts class.
|
|---|
| 11 |
|
|---|
| 12 | * Forms – unified forms across the script, with automatic checking and saving to database, see BxDolForm class.
|
|---|
| 13 |
|
|---|
| 14 | * Page builders – you can design you pages to use page builder, so admin will be able to reorganize blocks on this page, see BxDolPageView class.
|
|---|
| 15 |
|
|---|
| 16 | * Cron – dolphin supports cron system, now modules can install own scripts to run every defined period of time, without needing to install it manually in SSH or cPanel, see BxDolCron?.
|
|---|
| 17 |
|
|---|
| 18 | * Tags – automatically parse and manage tags for any content, see BxDolTags class.
|
|---|
| 19 |
|
|---|
| 20 | * Categories – automatically parse and manage categories for any content, see BxDolCategories class.
|
|---|
| 21 |
|
|---|
| 22 | * Albums – automatically parse and manage albums for any content, see BxDolAlbums class.
|
|---|
| 23 |
|
|---|
| 24 | * ACL (the old name is Memberships) – admin can set access to different sections of the site for different members roles. See checkAction function in membership_levels.inc.php file for more information.
|
|---|
| 25 |
|
|---|
| 26 | * Comments – add section with comments to your module, see BxDolCmts class for more information.
|
|---|
| 27 |
|
|---|
| 28 | * Voting – add voting section to your module, see BxDolVoting class for more information.
|
|---|
| 29 |
|
|---|
| 30 | * Calendar – displays calendar with your custom content to your module, see BxDolCalendar class for more information.
|
|---|
| 31 |
|
|---|
| 32 | * Member Menu – customizable member menu. It is possible to add new items to member’s menu with custom submenus and notifications, see BxDolMemberMenu class for more information.
|
|---|
| 33 |
|
|---|
| 34 | * Top Menu – main site menu can be customizable via sys_menu_top table.
|
|---|
| 35 |
|
|---|
| 36 | * Admin menu – admin menu can be customizable via sys_menu_admin table. It is better to add own links to Modules menu item only.
|
|---|
| 37 |
|
|---|
| 38 | * Admin Top Menu – admin top menu can be customizable via sys_menu_admin_top table but please keep in mind that this menu contains outer links.
|
|---|
| 39 |
|
|---|
| 40 | * Admin Dashboard – customizable admin dashboard page via sys_admin_dashboard table, see BxDolAdminDashboard class.
|
|---|
| 41 |
|
|---|
| 42 | * Bottom Menu – bottom menu can be customizable via sys_menu_bottom table.
|
|---|
| 43 |
|
|---|
| 44 | * Email templates – every module can have email templates which can be managed via admin panel, see BxDolEmailTemplates.
|
|---|
| 45 |
|
|---|
| 46 | * Paginate – use ready paginate class to implement unified interface for your content paginate, see BxDolPaginate.
|
|---|
| 47 |
|
|---|
| 48 | * Admin Settings Form – display and automatically save admin settings for your content, see BxDolAdminSettings class.
|
|---|
| 49 |
|
|---|
| 50 | * Permalinks – it is good practice to use friendly looking permalinks in URLs, see BxDolPermalinks class.
|
|---|
| 51 |
|
|---|
| 52 | * Continuous ratings – like Hot or Not for any content, see BxDolRate class.
|
|---|
| 53 |
|
|---|
| 54 | * RSS – generate RSS XML for any content, see BxDolRssFactory class.
|
|---|
| 55 |
|
|---|
| 56 | * Site Search – it is possible to search through all content on the site, but module must support this function, see BxDolSearch class.
|
|---|
| 57 |
|
|---|
| 58 | * Services – services are used for inner communication between modules, see BxDolService class.
|
|---|
| 59 |
|
|---|
| 60 | * Subscriptions – it is possible to subscribe to any content, and receive email notifications about any changes, see BxDolSubscription class.
|
|---|
| 61 |
|
|---|
| 62 | * Views – it is possible to track any object views automatically, see BxDolViews class.
|
|---|
| 63 |
|
|---|
| 64 | * Images resizing – to resize image in your module use BxDolImageResize class.
|
|---|
| 65 |
|
|---|
| 66 | * Action buttons – it is easy to display action buttons for your content in separate block or in title zone, see BxBaseFunctions::genObjectsActions, BxBaseMenu::setCustomSubActions and sys_objects_actions table.
|
|---|
| 67 |
|
|---|
| 68 | * Authentication types – by default standard and Facebook Connect (as separate module) authentication types are supported, it is possible to add you own, see sys_objects_auths table.
|
|---|
| 69 |
|
|---|
| 70 | * Injections – you can insert you code to different places on the page, see BxDolTemplate class.
|
|---|
| 71 |
|
|---|
| 72 | * Site stat – display site statistics, see sys_stat_member table.
|
|---|
| 73 |
|
|---|
| 74 | * User stat – display user statistic, see sys_stat_site table.
|
|---|
| 75 |
|
|---|
| 76 | Also many modules provide service functions to work with them, for example you can use photos module to store photos for your content, see main module class for list of service functions the module provide.
|
|---|
| 77 |
|
|---|
| 78 | It is better to install Profiler module, to help in developing modules and check your script execution time.
|
|---|
| 79 |
|
|---|
| 80 | PACKAGING THE MODULE
|
|---|
| 81 |
|
|---|
| 82 | When you finished with your module you need to create distribution package. Archive your module's main folder using ZIP archiver. For example, if your module is located in modulesyour_name/module_name folder you need to archive module_name folder with all files.
|
|---|
| 83 |
|
|---|
| 84 |
|
|---|
| 85 |
|
|---|
