|
dolibarr 25.0.0-alpha
|
Set of function for modulebuilder management. More...
Go to the source code of this file.
Functions | |
| dolModuleBuilderSqlIdentifier (string $prefix, string $module, string $table, string $key) | |
| Build the name of an index or of a foreign key constraint for a table generated by the module builder. | |
| rebuildObjectClass ($destdir, $module, $objectname, $newmask, $readdir='', $addfieldentry=array(), $delfieldentry='') | |
| Regenerate files .class.php. | |
| rebuildObjectSql ($destdir, $module, $objectname, $newmask, $readdir='', $object=null, $moduletype='external') | |
| Save data into a memory area shared by all users, all sessions on server. | |
| dolGetListOfObjectClasses ($destdir) | |
| Get list of existing objects from a directory. | |
| checkExistComment ($file, $number) | |
| Function to check if comment BEGIN and END exists in modMyModule class. | |
| deletePerms ($file) | |
| Delete all permissions declared in the permissions section of a module descriptor. | |
| reWriteAllPermissions ($file, $permissions, $key, $right, $objectname, $module, $action) | |
| Rewriting all permissions after any actions. | |
| parsePropertyString ($string) | |
| Converts a formatted properties string into an associative array. | |
| writePropsInAsciiDoc ($file, $objectname, $destfile) | |
| Write all properties of the object in AsciiDoc format. | |
| deletePropsAndPermsFromDoc ($file, $objectname) | |
| Delete property and permissions from documentation ascii file if we delete an object. | |
| getFromFile ($file, $start, $end, $excludestart='', $includese=0) | |
| Search a string and return all lines needed from file. | |
| writePermsInAsciiDoc ($file, $destfile) | |
| Write all permissions of each object in AsciiDoc format. | |
| addObjectsToApiFile ($srcfile, $file, $objects, $modulename) | |
| Add Object in ModuleApi File. | |
| removeObjectFromApiFile ($file, $objects, $objectname) | |
| Remove Object variables and methods from API_Module File. | |
| reWriteAllMenus ($file, $menus, $menuWantTo, $key, $action) | |
| updateDictionaryInFile ($module, $file, $dicts) | |
| Updates a dictionary in a module descriptor file. | |
| createNewDictionnary ($modulename, $file, $namedic, $dictionnaires=null) | |
| Create a new dictionary table. | |
| writeApiUrlsInDoc ($file_api, $file_doc) | |
| Generate Urls and add them to documentation module. | |
| countItemsInDirectory ($path, $type=1) | |
| count directories or files in modulebuilder folder | |
| getModuleBuilderObjectTabs () | |
| Return the map of optional tabs that can be generated for a ModuleBuilder object. | |
| getModuleBuilderObjectCardActions () | |
| Return the map of optional action buttons that can be generated on the card page of a ModuleBuilder object. | |
| getModuleBuilderDefaultEnabledKeys ($map) | |
| Return the keys enabled by default in a ModuleBuilder generation map. | |
| getModuleBuilderCardActionBlockPattern ($marker) | |
| Build the regular expression matching every block of a card action in the object card template. | |
| getModuleBuilderCardActionUncommentPatterns ($marker) | |
| Build the regular expressions removing the comment fence of a card action generated in 'activate' mode. | |
| getModuleBuilderLinesBlockPattern () | |
| Return the regular expression matching a block of object lines code in the templates, used when the user asks not to manage lines on the generated object. | |
| filterEnabledKeys ($requested, $map) | |
| Filter a list of requested keys against a known map of generable elements. | |
| filterEnabledTabs ($requested, $map) | |
| Filter a list of requested tab keys against the known optional tabs map. | |
| dolReplaceInFilePreservingModuleBuilderMarkers ($file, $arrayreplacement) | |
| Apply substitutions to a module descriptor file while preserving the MODULEBUILDER comment markers. | |
| getModuleBuilderAccessPolicyPages () | |
| Return the object pages whose read access is driven by the access policy defined in ModuleBuilder. | |
| getModuleBuilderAccessPolicyBlockPattern () | |
| Return the regular expression matching the ACCESSPOLICY block of a template. | |
| renderModuleBuilderAccessPolicyBlock (AccessPolicyConfig $policy) | |
| Render the block that computes $permissiontoread from an access policy in a generated page. | |
| renderModuleBuilderAccessPolicyProperty (AccessPolicyConfig $policy) | |
| Render the property of the generated object class that keeps the serialized access policy. | |
| getModuleBuilderAccessPolicyFromClassFile (string $file) | |
| Load the access policy stored in a generated object class by renderModuleBuilderAccessPolicyProperty(). | |
| resolveModuleBuilderAccessPolicyBlock (string $file, ?string $replacement) | |
| Resolve the ACCESSPOLICY block of a generated file. | |
| applyModuleBuilderAccessPolicyToPage (string $file, ?AccessPolicyConfig $policy) | |
| Apply an access policy to a generated object page. | |
| applyModuleBuilderAccessPolicyToClass (string $file, ?AccessPolicyConfig $policy) | |
| Store an access policy in the generated object class. | |
Set of function for modulebuilder management.
Definition in file modulebuilder.lib.php.
| addObjectsToApiFile | ( | $srcfile, | |
| $file, | |||
| $objects, | |||
| $modulename ) |
Add Object in ModuleApi File.
| string | $srcfile | Source file to use as example |
| string | $file | Path of modified file |
| string[] | $objects | Array of objects in the module |
| string | $modulename | Name of module |
Definition at line 976 of file modulebuilder.lib.php.
References dol_now(), dol_print_date(), dol_strtolower(), dol_strtoupper(), dol_syslog(), dolChmod(), dolReplaceInFile(), and getFromFile().
| applyModuleBuilderAccessPolicyToClass | ( | string | $file, |
| ?AccessPolicyConfig | $policy ) |
Store an access policy in the generated object class.
Without policy the class keeps the code of the template.
| string | $file | Path of the generated class |
| AccessPolicyConfig | null | $policy | Access policy of the object, null when none is defined |
Definition at line 1780 of file modulebuilder.lib.php.
References renderModuleBuilderAccessPolicyProperty(), and resolveModuleBuilderAccessPolicyBlock().
| applyModuleBuilderAccessPolicyToPage | ( | string | $file, |
| ?AccessPolicyConfig | $policy ) |
Apply an access policy to a generated object page.
Without policy the page keeps the code of the template.
| string | $file | Path of the generated page |
| AccessPolicyConfig | null | $policy | Access policy of the object, null when none is defined |
Definition at line 1767 of file modulebuilder.lib.php.
References renderModuleBuilderAccessPolicyBlock(), and resolveModuleBuilderAccessPolicyBlock().
| checkExistComment | ( | $file, | |
| $number ) |
Function to check if comment BEGIN and END exists in modMyModule class.
| string | $file | Filename or path |
| int<0,2> | $number 0 = For Menus, 1 = For permissions, 2 = For Dictionaries |
Definition at line 524 of file modulebuilder.lib.php.
| countItemsInDirectory | ( | $path, | |
| $type = 1 ) |
count directories or files in modulebuilder folder
| string | $path | path of directory |
| int<1,2> | $type type of file 1= file,2=directory |
Definition at line 1424 of file modulebuilder.lib.php.
References dol_is_dir(), and dol_is_file().
| createNewDictionnary | ( | $modulename, | |
| $file, | |||
| $namedic, | |||
| $dictionnaires = null ) |
Create a new dictionary table.
It generates the necessary SQL code to define the table structure, including columns such as 'rowid', 'code', 'label', 'position', 'use_default', 'active', etc. The table name is constructed based on the provided $namedic parameter.
| string | $modulename | The lowercase name of the module for which the dictionary table is being created. |
| string | $file | The file path to the Dolibarr module builder file where the dictionaries are defined. |
| string | $namedic | The name of the dictionary, which will also be used as the base for the table name. |
| ?array{langs:string,tabname:string[],tablib:string[],tabsql:string[],tabsqlsort:string[],tabfield:string[],tabfieldvalue:string[],tabfieldinsert:string[],tabrowid:string[],tabcond:array<string|bool|int>,tabhelp:array<array{code:string,field2:string}>} | $dictionnaires An optional array containing pre-existing dictionary data, including tabname, tablib, tabsql, etc. |
Definition at line 1286 of file modulebuilder.lib.php.
References dol_strtolower(), dol_substr(), dol_ucfirst(), isModEnabled(), and updateDictionaryInFile().
| deletePerms | ( | $file | ) |
Delete all permissions declared in the permissions section of a module descriptor.
| string | $file | file with path |
Definition at line 568 of file modulebuilder.lib.php.
References dol_syslog(), and PermissionsBlock\fromFile().
| deletePropsAndPermsFromDoc | ( | $file, | |
| $objectname ) |
Delete property and permissions from documentation ascii file if we delete an object.
| string | $file | file or path |
| string | $objectname | name of object wants to deleted |
Definition at line 815 of file modulebuilder.lib.php.
References dol_is_file(), and dolChmod().
| dolGetListOfObjectClasses | ( | $destdir | ) |
Get list of existing objects from a directory.
| string | $destdir | Directory |
Definition at line 491 of file modulebuilder.lib.php.
References dol_dir_list().
| dolModuleBuilderSqlIdentifier | ( | string | $prefix, |
| string | $module, | ||
| string | $table, | ||
| string | $key ) |
Build the name of an index or of a foreign key constraint for a table generated by the module builder.
The identifier must not exceed the 64-character limit of MySQL/MariaDB, and must stay predictable: a migration script has to be able to name an existing index without scanning the database. So it is never hashed. It is returned untouched as long as it fits, and only truncated beyond the limit, by parts: 30 characters for the module, 20 for the table, and the remaining budget for the key.
| string | $prefix | Prefix of the identifier ('idx_', 'uk_' or 'llx_') |
| string | $module | Name of the module |
| string | $table | Name of the table (without its 'llx_<module>_' prefix) |
| string | $key | Name of the field the index or the constraint is built on |
Definition at line 44 of file modulebuilder.lib.php.
References $module, dol_strlen(), dol_strtolower(), and dol_substr().
Referenced by rebuildObjectSql().
| dolReplaceInFilePreservingModuleBuilderMarkers | ( | $file, | |
| $arrayreplacement ) |
Apply substitutions to a module descriptor file while preserving the MODULEBUILDER comment markers.
Markers such as "BEGIN MODULEBUILDER LEFTMENU MYOBJECT" must keep their MYOBJECT/MYMODULE placeholder so that generating subsequent objects can still locate them (see checkExistComment()). A blanket substitution would rewrite them to the first object name and break the generation of further objects.
| string | $file | Path to the module descriptor file |
| array<string,string> | $arrayreplacement Substitution map (search => replace), applied as literal strings |
Definition at line 1593 of file modulebuilder.lib.php.
| filterEnabledKeys | ( | $requested, | |
| $map ) |
Filter a list of requested keys against a known map of generable elements.
Protects against injection of unknown keys, removes duplicates, normalizes order.
| string[] | string | $requested | Raw keys requested by the user (e.g. from GETPOST array) |
| array<string,array<string,mixed>> | $map Map of known elements, keyed by element key |
Definition at line 1556 of file modulebuilder.lib.php.
Referenced by filterEnabledTabs().
| filterEnabledTabs | ( | $requested, | |
| $map ) |
Filter a list of requested tab keys against the known optional tabs map.
Protects against injection of unknown keys, removes duplicates, normalizes order.
| string[] | string | $requested | Raw tab keys requested by the user (e.g. from GETPOST array) |
| array<string,array{file:string,var:string,marker:string,label:string}> | $map Map from getModuleBuilderObjectTabs() |
Definition at line 1578 of file modulebuilder.lib.php.
References filterEnabledKeys().
| getFromFile | ( | $file, | |
| $start, | |||
| $end, | |||
| $excludestart = '', | |||
| $includese = 0 ) |
Search a string and return all lines needed from file.
Does not include line $start nor $end
| string | $file | file for searching |
| string | $start | start line if it exists |
| string | $end | end line if it exists |
| string | $excludestart | Ignore if start line is $excludestart |
| int<0,1> | $includese Include start and end line |
Definition at line 849 of file modulebuilder.lib.php.
References dol_osencode().
Referenced by addObjectsToApiFile(), removeObjectFromApiFile(), reWriteAllMenus(), updateDictionaryInFile(), writeApiUrlsInDoc(), and writePermsInAsciiDoc().
| getModuleBuilderAccessPolicyBlockPattern | ( | ) |
Return the regular expression matching the ACCESSPOLICY block of a template.
Group 1 is the content between the two markers.
Definition at line 1646 of file modulebuilder.lib.php.
Referenced by resolveModuleBuilderAccessPolicyBlock().
| getModuleBuilderAccessPolicyFromClassFile | ( | string | $file | ) |
Load the access policy stored in a generated object class by renderModuleBuilderAccessPolicyProperty().
| string | $file | Path of the generated class |
InvalidArgumentException When the class cannot be read or stores an invalid policy
Definition at line 1700 of file modulebuilder.lib.php.
References AccessPolicyConfig\fromJson().
| getModuleBuilderAccessPolicyPages | ( | ) |
Return the object pages whose read access is driven by the access policy defined in ModuleBuilder.
Definition at line 1631 of file modulebuilder.lib.php.
References getModuleBuilderObjectTabs().
| getModuleBuilderCardActionBlockPattern | ( | $marker | ) |
Build the regular expression matching every block of a card action in the object card template.
A marker can anchor several non-contiguous blocks: the pattern is non greedy and is meant to be used with removePatternFromFile(), which replaces all the occurrences at once.
| string | $marker | Marker of the action, from getModuleBuilderObjectCardActions() |
Definition at line 1511 of file modulebuilder.lib.php.
| getModuleBuilderCardActionUncommentPatterns | ( | $marker | ) |
Build the regular expressions removing the comment fence of a card action generated in 'activate' mode.
Removing both sentinel lines turns the commented block into live code.
| string | $marker | Marker of the action, from getModuleBuilderObjectCardActions() |
Definition at line 1525 of file modulebuilder.lib.php.
| getModuleBuilderDefaultEnabledKeys | ( | $map | ) |
Return the keys enabled by default in a ModuleBuilder generation map.
An entry without a 'default' index is considered enabled.
| array<string,array<string,mixed>> | $map Map of known elements, keyed by element key |
Definition at line 1492 of file modulebuilder.lib.php.
| getModuleBuilderLinesBlockPattern | ( | ) |
Return the regular expression matching a block of object lines code in the templates, used when the user asks not to manage lines on the generated object.
The pattern is non greedy, so the BEGIN/END markers of a file must be balanced and never nested: a nested pair makes the outer BEGIN match the inner END and cuts an unbalanced fragment.
Definition at line 1543 of file modulebuilder.lib.php.
| getModuleBuilderObjectCardActions | ( | ) |
Return the map of optional action buttons that can be generated on the card page of a ModuleBuilder object.
The "Modify" button is not listed on purpose: a generated card without it could not be edited any more.
'mode' drives the generation: 'remove' means the block is present in the template and is dropped when the action is not selected, 'activate' means the block ships commented out in the template and is uncommented when the action is selected.
Definition at line 1473 of file modulebuilder.lib.php.
| getModuleBuilderObjectTabs | ( | ) |
Return the map of optional tabs that can be generated for a ModuleBuilder object.
The CARD tab is always generated and is therefore not listed here. HISTORY is an alias of AGENDA (object event history is the agenda tab in Dolibarr).
Definition at line 1452 of file modulebuilder.lib.php.
Referenced by getModuleBuilderAccessPolicyPages().
| parsePropertyString | ( | $string | ) |
Converts a formatted properties string into an associative array.
| string | $string | The formatted properties string. |
Definition at line 670 of file modulebuilder.lib.php.
References dol_substr(), and parsePropertyString().
Referenced by parsePropertyString(), and writePropsInAsciiDoc().
| rebuildObjectClass | ( | $destdir, | |
| $module, | |||
| $objectname, | |||
| $newmask, | |||
| $readdir = '', | |||
| $addfieldentry = array(), | |||
| $delfieldentry = '' ) |
Regenerate files .class.php.
| string | $destdir | Directory |
| string | $module | Module name |
| string | $objectname | Name of object |
| string | $newmask | New mask |
| string | $readdir | Directory source (use $destdir when not defined) |
| array{}|array{name:string,key:string,type:string,label:string,picot?:string,enabled:int<0,1>,notnull:int<0,1>,position:int,visible:int,noteditable?:int<0,1>,alwayseditable?:int<0,1>,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int<0,1>,css?:string,cssview?:string,csslist?:string,help?:string,showoncombobox?:int<0,1>,disabled?:int<0,1>,autofocusoncreate?:int<0,1>,arrayofkeyval?:array<string,string>,validate?:int<0,1>,comment?:string} | $addfieldentry Array of 1 field entry to add | |
| string | $delfieldentry | Id of field to remove |
Definition at line 77 of file modulebuilder.lib.php.
References $object, dol_copy(), dol_escape_php(), dol_is_file(), dol_mkdir(), dol_osencode(), dol_sort_array(), dol_strtolower(), and dolChmod().
| rebuildObjectSql | ( | $destdir, | |
| $module, | |||
| $objectname, | |||
| $newmask, | |||
| $readdir = '', | |||
| $object = null, | |||
| $moduletype = 'external' ) |
Save data into a memory area shared by all users, all sessions on server.
| string | $destdir | Directory |
| string | $module | Module name |
| string | $objectname | Name of object |
| string | $newmask | New mask |
| string | $readdir | Directory source (use $destdir when not defined) |
| Object | $object | If object was already loaded/known, it is pass to avoid another include and new. |
| string | $moduletype | 'external' or 'internal' |
Definition at line 305 of file modulebuilder.lib.php.
References $module, $object, dol_copy(), dol_is_file(), dol_mkdir(), dol_osencode(), dol_strtolower(), dolChmod(), and dolModuleBuilderSqlIdentifier().
| removeObjectFromApiFile | ( | $file, | |
| $objects, | |||
| $objectname ) |
Remove Object variables and methods from API_Module File.
| string | $file | File api module |
| string[] | $objects | Array of objects in the module |
| string | $objectname | Name of object want to remove |
Definition at line 1057 of file modulebuilder.lib.php.
References dolChmod(), dolReplaceInFile(), and getFromFile().
| renderModuleBuilderAccessPolicyBlock | ( | AccessPolicyConfig | $policy | ) |
Render the block that computes $permissiontoread from an access policy in a generated page.
A failure while evaluating the policy denies the access and is logged.
| AccessPolicyConfig | $policy | Access policy of the object |
Definition at line 1659 of file modulebuilder.lib.php.
References AccessPolicyConfig\getMessage().
Referenced by applyModuleBuilderAccessPolicyToPage().
| renderModuleBuilderAccessPolicyProperty | ( | AccessPolicyConfig | $policy | ) |
Render the property of the generated object class that keeps the serialized access policy.
| AccessPolicyConfig | $policy | Access policy of the object |
Definition at line 1683 of file modulebuilder.lib.php.
References AccessPolicyConfig\toJson().
Referenced by applyModuleBuilderAccessPolicyToClass().
| resolveModuleBuilderAccessPolicyBlock | ( | string | $file, |
| ?string | $replacement ) |
Resolve the ACCESSPOLICY block of a generated file.
| string | $file | Path of the generated file |
| string | null | $replacement | Code replacing the whole block, null to drop the markers and keep the template content |
| string[] | $matches | Block, then content between the markers |
Definition at line 1726 of file modulebuilder.lib.php.
References dol_syslog(), and getModuleBuilderAccessPolicyBlockPattern().
Referenced by applyModuleBuilderAccessPolicyToClass(), and applyModuleBuilderAccessPolicyToPage().
| reWriteAllMenus | ( | $file, | |
| $menus, | |||
| $menuWantTo, | |||
| $key, | |||
| $action ) |
| string | $file | path of filename |
| array<int,array{commentgroup?:string,fk_menu:string,type:string,titre:string,mainmenu:string,leftmenu:string,url:string,langs:string,position:int|string,enabled:int|string,perms:string,target:string,user:int}> | $menus all menus for module | |
| null|string|array{commentgroup?:string,fk_menu:string,type:string,titre:string,mainmenu:string,leftmenu:string,url:string,langs:string,position:int|string,enabled:int|string,perms:string,target:string,user:int} | $menuWantTo menu get for do actions | |
| ?int | $key | key for the concerned menu |
| int<-1,2> | $action for specify what action (0 = delete perm, 1 = add perm, 2 = update perm, -1 = when we delete object) |
Definition at line 1108 of file modulebuilder.lib.php.
References dol_strtolower(), dol_strtoupper(), dolReplaceInFile(), and getFromFile().
| reWriteAllPermissions | ( | $file, | |
| $permissions, | |||
| $key, | |||
| $right, | |||
| $objectname, | |||
| $module, | |||
| $action ) |
Rewriting all permissions after any actions.
Kept for backward compatibility: this is a public core function that external modules may call. The signature and the 1/-1 contract are unchanged, the body delegates to DescriptorRightsSyncService.
| string | $file | filename or path |
| array<int,string[]> | $permissions permissions existing in file | |
| ?int | $key | key for permission needed |
| ?array<int,string> | $right $right to update or add | |
| string | $objectname | name of object |
| string | $module | name of module |
| int<-2,2> | $action 0 for delete, 1 for add, 2 for update, -1 when delete object completely, -2 for generate rights after add |
Definition at line 598 of file modulebuilder.lib.php.
References $module, dol_syslog(), RightsSyncCommand\forObjectCreation(), RightsSyncCommand\forObjectDeletion(), RightsSyncCommand\forRightAddition(), RightsSyncCommand\forRightDeletion(), and RightsSyncCommand\forRightUpdate().
| updateDictionaryInFile | ( | $module, | |
| $file, | |||
| $dicts ) |
Updates a dictionary in a module descriptor file.
| string | $module | The name of the module. |
| string | $file | The path to the module descriptor file. |
| array{langs:string,tabname:string[],tablib:string[],tabsql:string[],tabsqlsort:string[],tabfield:string[],tabfieldvalue:string[],tabfieldinsert:string[],tabrowid:string[],tabcond:array<string|bool|int>,tabhelp:array<array{code:string,field2:string}>} | $dicts The dictionary data to be updated. |
| bool | string | int | $val |
| string | $val |
Definition at line 1213 of file modulebuilder.lib.php.
References $module, dol_strtolower(), dolReplaceInFile(), and getFromFile().
Referenced by createNewDictionnary().
| writeApiUrlsInDoc | ( | $file_api, | |
| $file_doc ) |
Generate Urls and add them to documentation module.
| string | $file_api | filename or path of api |
| string | $file_doc | filename or path of documentation |
Definition at line 1367 of file modulebuilder.lib.php.
References dol_is_file(), dol_strlen(), dol_substr(), dolReplaceInFile(), and getFromFile().
| writePermsInAsciiDoc | ( | $file, | |
| $destfile ) |
Write all permissions of each object in AsciiDoc format.
| string | $file | path of the class |
| string | $destfile | file where write table of permissions |
Definition at line 889 of file modulebuilder.lib.php.
References dol_substr(), dolReplaceInFile(), and getFromFile().
| writePropsInAsciiDoc | ( | $file, | |
| $objectname, | |||
| $destfile ) |
Write all properties of the object in AsciiDoc format.
| string | $file | path of the class |
| string | $objectname | name of the objectClass |
| string | $destfile | file where write table of properties |
Definition at line 716 of file modulebuilder.lib.php.
References dolReplaceInFile(), and parsePropertyString().