[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/sites/all/modules/module_builder/includes/ -> generate.inc (summary)

(no description)

File Size: 465 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 classes

ModuleBuilderGeneratorCode:: (3 methods):
  __construct()
  code_body()
  code_footer()

ModuleBuilderGeneratorInfo:: (3 methods):
  file_header()
  code_header()
  code_body()

ModuleBuilderGeneratorInfo5:: (1 method):
  code_body()

ModuleBuilderGeneratorInfo6:: (1 method):
  code_body()

ModuleBuilderGeneratorInfo7:: (4 methods):
  code_body()
  module_builder_generate_module()
  module_builder_code_hook_doxy()
  module_builder_get_templates()

Defines 4 functions

  module_builder_generate_info_oo()
  module_builder_get_class()
  __construct()
  build()
  file_header()
  code_header()
  code_footer()

Class: ModuleBuilderGeneratorCode  - X-Ref

Generator class for module code files.

__construct($module_data)   X-Ref
No description

code_body()   X-Ref
No description

code_footer()   X-Ref
Return a file footer.


Class: ModuleBuilderGeneratorInfo  - X-Ref

Generator base class for module info file.

file_header()   X-Ref
Override as info files have no header.


code_header($filename = NULL)   X-Ref
Override as info files have no header.


code_body()   X-Ref
No description

Class: ModuleBuilderGeneratorInfo5  - X-Ref

Generator class for module info file for Drupal 5.

code_body()   X-Ref
No description

Class: ModuleBuilderGeneratorInfo6  - X-Ref

Generator class for module info file for Drupal 6.

code_body()   X-Ref
No description

Class: ModuleBuilderGeneratorInfo7  - X-Ref

Generator class for module info file for Drupal 7.

code_body()   X-Ref
No description

module_builder_generate_module(&$module_data, $bare = FALSE)   X-Ref
Generate module code.

param: $module_data
param: $bare
return:

module_builder_code_hook_doxy($hook_name)   X-Ref
Get the doxygen header for a given hook.
This does not return with an initial newline so the doc block may be inserted into existing code.

param:

module_builder_get_templates($module_data)   X-Ref
Helper function for module_builder_generate_module

Returns an array of hook data and templates for the requested hooks.
This is handled live rather than in process.inc to allow the user to alter
their custom hook templates.

return:

Functions
Functions that are not part of a class:

module_builder_generate_info_oo($module_data)   X-Ref
Generate info code. New OO version!


module_builder_get_class($type)   X-Ref
Helper function to get the desired class.

param: $type
return:

__construct($module_data)   X-Ref
Base class for code generators.

TODO: much more of the code generation could be moved to OO code:
- pass all hook data to one code generator object, representing the .module
file, which then instantiates further objects for the other files needed.
This would probably entail a controller object which can hold the list of
current generators.
- templates.

build()   X-Ref
The main code building function.


file_header()   X-Ref
Return the PHP file header line.


code_header()   X-Ref
Return the file doxygen header and any custom header code.


code_footer()   X-Ref
Return a file footer.




Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7