Home » Drupal Collection » My Modules » Site Documentation Module

D. Calling the Functions

Submitted on Wed, 11/07/2007 - 17:59.

Since the moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. is coded in PHPRecursive acronym for "PHP: Hypertext Preprocessor" - is a widely-used Open Source general-purpose scripting language that is especially suited for Web development and can be embedded into HTML., all of the functions are callable externally. This table lists those functions you may wish to call from your own code (whether in a moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP., page, or block).

Function Name Parameters Returns
sitedoc_drupal

Drupal

An open-source content management system that is used on this site and is taking over the world.		 Interval, in seconds, before deleting "cron_semaphore"; default is zero (0) to indicate no deletion. HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_databaseA collection of data related to an application._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.
 HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_get_modules Exclude disabled
  • TRUE - excludes disabled modules from the list
  • FALSE - includes all modules (default)
Sort order
  • 0 - by moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. (similar to core list)
  • 1 - by path
 HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_get_system
  • 'themeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look.' - get ThemeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look. list
  • 'themeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look._engine' - get ThemeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look. Engine list
HTMLHyperText Markup Language - the coding standard for a web page. 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)
 HTMLHyperText Markup Language - the coding standard for a web page. 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)
 HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_content_types None HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_get_vocabularies None HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_check_orphan_term_node Should only be used within the moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP., but is separately callable.
  • TRUE - delete the orphan term-node rows
  • FALSE - do not delete the orphan term-node rows (default)
 HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_sequences None HTMLHyperText Markup Language - the coding standard for a web page. 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
 HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_node_access None HTMLHyperText Markup Language - the coding standard for a web page. 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
 HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_get_variables None HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_get_contacts None HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_profile_fields string - limits the list to only this category HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_url_alias None HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_filters None HTMLHyperText Markup Language - the coding standard for a web page. 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"		 HTMLHyperText Markup Language - the coding standard for a web page. 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).
 HTMLHyperText Markup Language - the coding standard for a web page. string
sitedoc_show_table This is a generic databaseA collection of data related to an application. 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"		 HTMLHyperText Markup Language - the coding standard for a web page. string
‹ C. UsageupE. What About Other Modules? ›
»