module_builder.module
Version
1.35 (checked in on 2007/11/05 at 20:44:47 by robloach)
Description
TODO: Enter file description here.
Constants
Name | Description |
|---|---|
| MODULE_BUILDER_CSS_PATH | Path from module base to the module builder css file. |
| MODULE_BUILDER_CUSTOM_HOOK_GROUPS_TEMPLATE_PATH | Path from module base to the custom hook groups template. Only used if it exists, otherwise MODULE_BUILDER_HOOK_GROUPS_TEMPLATE_PATH is used. |
| MODULE_BUILDER_CVS_URL | Base URL for accessing Drupal CVS. |
| MODULE_BUILDER_DETAIL_DEFAULT | |
| MODULE_BUILDER_DOWNLOAD_DEFAULT | |
| MODULE_BUILDER_DOWNLOAD_VARIABLE | |
| MODULE_BUILDER_EXTRACT_HOOK_PATTERN | Pattern that captures 3 things about a hook from one of the hook files: Description, Declaraion and Name (in that order). |
| MODULE_BUILDER_FILE_DIRECTORY_PATH_DEFAULT | |
| MODULE_BUILDER_FILE_DIRECTORY_PATH_VARIABLE | |
| MODULE_BUILDER_FILE_PATTERN | After finding a hook file URL with MODULE_BUILDER_URL_PATTERN, this captures the path and filename. |
| MODULE_BUILDER_FOOTER_DEFAULT | |
| MODULE_BUILDER_FOOTER_VARIABLE | |
| MODULE_BUILDER_FULL_ID_PATTERN | In case we have an expanded CVS Id, this matches that, and captures the version number (although we don't use that). This is then replaced with MODULE_BUILDER_ID_COMMENT. |
| MODULE_BUILDER_FUNCTION_PATTERN | Took this regex from the PHP manual page on Functions |
| MODULE_BUILDER_HEADER_DEFAULT | |
| MODULE_BUILDER_HEADER_VARIABLE | |
| MODULE_BUILDER_HOOKS_DIRECTORY_DEFAULT | |
| MODULE_BUILDER_HOOKS_DIRECTORY_VARIABLE | |
| MODULE_BUILDER_HOOKS_URL | URL for retreiving the hook description files. |
| MODULE_BUILDER_HOOK_DECLARATIONS | Index into MODULE_BUILDER_EXTRACT_HOOK_PATTERN capture list that returns the hook declaration from the hook files. |
| MODULE_BUILDER_HOOK_DESCRIPTIONS | Index into MODULE_BUILDER_EXTRACT_HOOK_PATTERN capture list that returns the hook description from the hook files. |
| MODULE_BUILDER_HOOK_GROUPS_TEMPLATE_PATH | Path from module base to the normal hook groups template. MODULE_BUILDER_CUSTOM_HOOK_GROUPS_TEMPLATE_PATH used if it exists. |
| MODULE_BUILDER_HOOK_NAMES | Index into MODULE_BUILDER_EXTRACT_HOOK_PATTERN capture list that returns the hook name from the hook files. |
| MODULE_BUILDER_ID_COMMENT | |
| MODULE_BUILDER_INFO_ID_COMMENT | |
| MODULE_BUILDER_INFO_PATTERN | Used to strip INFO messages out of generated file for advanced users. |
| MODULE_BUILDER_JS_PATH | Path from module base to the module builder java script file. |
| MODULE_BUILDER_LAST_UPDATE_DEFAULT | |
| MODULE_BUILDER_LAST_UPDATE_VARIABLE | |
| MODULE_BUILDER_TEMPLATE_PATTERN | Captures a template name and body from a template file. |
| MODULE_BUILDER_URL_PATTERN | Pattern for finding the hook file URLs from the MODULE_BUILDER_HOOKS_URL page. |
| MODULE_BUILDER_VERSION | Version of hook info to retrieve |
Functions
| Name | Description |
|---|---|
| generate_info | |
| generate_module | |
| module_builder_admin_settings | Implementation of hook_settings(). |
| module_builder_admin_settings_submit | Implementation of submit handler for settings page. |
| module_builder_extract_hook_data | Extracts hook information based on type parameter. |
| module_builder_get_doc_files | Retrieve list of documentation files containing hook definitions. |
| module_builder_get_hook_data | Retrieves hook data of given type |
| module_builder_menu | Implementation of hook_menu(). |
| module_builder_page | Displays module builder interface via a multi-step form. The steps are: |
| module_builder_page_download | |
| module_builder_page_input | |
| module_builder_page_module | |
| module_builder_page_validate | Makes sure that valid values have been provided to the Module Builder. |
| module_builder_parse_template | Parse a module_builder template file. |
| module_builder_perm | Implementation of hook_perm(). |
| module_builder_update_documentation | Initiates documentation upate routine. |
| _module_builder_check_settings | Create a directory to store hook files if it does not exist. |
| _module_builder_save_old_form_values | This still needs some work. Set a bunch of check boxes, forward, back, uncheck the boxes, forward and back and the boxes get turned back on for some reason. Otherwise this seems pretty good. |