Home » Site Building Guide » Site builders toolkit » Generating site documentation

D. Calling the Functions

Last modified: January 2, 2008 - 00:33

Since the module is coded in PHP, all of the functions are callable externally. This table lists those functions you may wish to call from your own code (whether in a module, page, or block).

Function Name Parameters Returns
sitedoc_drupal Interval, in seconds, before deleting "cron_semaphore"; default is zero (0) to indicate no deletion. HTML string
sitedoc_database_overview
  1. Release
    • TRUE - release overhead from a table that has it.
    • FALSE (default) - don't release overhead.
  2. Indexes
    • TRUE - show each table's indexes.
    • FALSE (default) - don't show indexes.
 HTML string
sitedoc_get_modules Exclude disabled
  • TRUE - excludes disabled modules from the list
  • FALSE - includes all modules (default)

Sort order

  • 0 - by module (similar to core list)
  • 1 - by path
 HTML string
sitedoc_get_system
  • 'theme' - get Theme list
  • 'theme_engine' - get Theme Engine list
HTML string
sitedoc_get_blocks
  1. Warn
    • TRUE - warning message if there are orphan blocks (default)
    • FALSE - no warning message
  2. Delete
    • TRUE - delete orphan blocks
    • FALSE - do not delete orphans (default)
 HTML string
sitedoc_get_boxes
  1. Warn
    • TRUE - warning message if there are orphan boxes (default)
    • FALSE - no warning message
  2. Delete
    • TRUE - delete orphan boxes
    • FALSE - do not delete orphans (default)
 HTML string
sitedoc_content_types None HTML string
sitedoc_get_vocabularies None HTML string
sitedoc_check_orphan_term_node Should only be used within the module, but is separately callable.
  • TRUE - delete the orphan term-node rows
  • FALSE - do not delete the orphan term-node rows (default)
 HTML string
sitedoc_sequences None HTML string
sitedoc_node_summary
  1. Comments
    • TRUE - include comments count
    • FALSE - do not include comments count (default)
  2. size (KB) to show nodes exceeding
  3. size (KB) to warn if nodes exceed
 HTML string
sitedoc_node_access None HTML string
sitedoc_get_roles
  1. Permissions
    • TRUE - permissions listed as unordered list
    • FALSE - permissions listed as stream (default)
  2. Users
    • TRUE - include users in roles (default)
    • FALSE - do not include users
 HTML string
sitedoc_get_variables None HTML string
sitedoc_get_contacts None HTML string
sitedoc_profile_fields string - limits the list to only this category HTML string
sitedoc_url_alias None HTML string
sitedoc_filters None HTML string
sitedoc_term_count_by_type
  • number - the vocabulary number to display usage by term and content type.

This can also be used as "http://www.example.com/sitedoc/vocabulary/xxx"

 HTML string
sitedoc_term_count_nodes This is an alternative to taxonomy_term_count_nodes that was implemented in response to postings detailing performance problems with the core function.
  • number - the vocabulary number to display usage by term and content type.
  • type - the node type to show (defaults to null, or all types).
 HTML string
sitedoc_show_table This is a generic database table display with sortable columns.
  • name - the name of the table to show.
  • rows per page - the number of rows to show on each page (defaults to 20).

This can also be used as "http://www.example.com/sitedoc/table/table_name/rows"

 HTML string
» Login or register to post comments
 
 

Drupal is a registered trademark of Dries Buytaert.