48
edits
Module ModuleBuilder: Difference between revisions
Jump to navigation
Jump to search
→Object:
| Line 47: | Line 47: | ||
[[File:Menus.png|center|frameless|1482x1482px]] | [[File:Menus.png|center|frameless|1482x1482px]] | ||
=== Object: === | ===Object:=== | ||
*To add an object, simply enter the name, choose an icon, and specify the name of an existing table, if nothing is specified, it creates a new table | |||
*The three check-boxes depend on your preference: one for enabling automatic numbering generation, the second for enabling PDF document creation, and the third to generate permissions for this object. | |||
<br /> | |||
[[File:AddObject.png|center|thumb|1301x1301px|'''Add Object''']] | |||
In the description of an object within a Dolibarr module developed using ModuleBuilder, several essential components and functionalities are outlined. These include: | |||
* '''PHP DAO CRUD Class''': This is the core PHP class that handles database operations such as create, read, update, and delete for the object, ensuring seamless data management. | |||
* '''Icon Representation''': An icon specified for visual representation of the object in the user interface, aiding in quick identification. | |||
* '''Module API''': Defines the application programming interface for the module, enabling external interactions and integrations. | |||
* '''Unit Testing''': A set of PHP unit tests designed to verify the functionality and reliability of the object, ensuring robust operation. | |||
* '''Library Files''': Comprise both a common library file for module-wide functions and an object-specific library file, which includes functions unique to the object's logic and operations. | |||
* '''SQL Scripts''': Include the main SQL script for creating the object's database table, along with additional scripts for keys, indexes, and extra fields, ensuring optimized database structure and performance. | |||
* '''User Interface Pages''': | |||
** A listing page for viewing all records of the object, | |||
** A detailed card page for creating, modifying, and displaying individual records, | |||
** Dedicated pages for managing related contacts, documents, notes, and events, each providing specialized functionalities within the object's context. | |||
'''The setup also features a button, facilitating the generation, modification, or deletion of these components as needed. This system offers a comprehensive framework for extending and customizing the object within the module, providing developers with a robust set of tools for module customization and functionality enhancement.''' | |||
<br /> | |||
[[File:DolObject.png|center|thumb|1503x1503px]] | |||
<br /> | <br /> | ||
==='''Property Addition''':=== | ==='''Property Addition''':=== | ||