[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/modules/book/ -> book.module (summary)

(no description)

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

Defines 38 functions

  book_theme()
  book_perm()
  book_link()
  book_menu()
  _book_outline_access()
  _book_outline_remove_access()
  book_init()
  book_block()
  theme_book_title_link()
  book_get_books()
  book_form_alter()
  _book_parent_select()
  _book_add_form_elements()
  _book_update_outline()
  book_update_bid()
  book_get_flat_menu()
  _book_flatten_menu()
  book_prev()
  book_next()
  book_children()
  book_menu_name()
  book_build_active_trail()
  book_nodeapi()
  _book_parent_depth_limit()
  book_form_node_delete_confirm_alter()
  _book_link_defaults()
  template_preprocess_book_navigation()
  _book_toc_recurse()
  book_toc()
  template_preprocess_book_export_html()
  book_export_traverse()
  book_node_export()
  template_preprocess_book_node_export_html()
  book_type_is_allowed()
  book_node_type()
  book_help()
  book_link_load()
  book_menu_subtree_data()

Functions
Functions that are not part of a class:

book_theme()   X-Ref
Implementation of hook_theme()


book_perm()   X-Ref
Implementation of hook_perm().


book_link($type, $node = NULL, $teaser = FALSE)   X-Ref
Implementation of hook_link().


book_menu()   X-Ref
Implementation of hook_menu().


_book_outline_access($node)   X-Ref
Menu item access callback - determine if the outline tab is accessible.


_book_outline_remove_access($node)   X-Ref
Menu item access callback - determine if the user can remove nodes from the outline.


book_init()   X-Ref
Implementation of hook_init(). Add's the book module's CSS.


book_block($op = 'list', $delta = 0, $edit = array()   X-Ref
Implementation of hook_block().

Displays the book table of contents in a block when the current page is a
single-node view of a book node.

theme_book_title_link($link)   X-Ref
Generate the HTML output for a link to a book title when used as a block title.


book_get_books()   X-Ref
Returns an array of all books.

This list may be used for generating a list of all the books, or for building
the options for a form select.

book_form_alter(&$form, $form_state, $form_id)   X-Ref
Implementation of hook_form_alter(). Adds the book fieldset to the node form.


_book_parent_select($book_link)   X-Ref
Build the parent selection form element for the node form or outline tab

This function is also called when generating a new set of options during the
AJAX callback, so an array is returned that can be used to replace an existing
form element.

_book_add_form_elements(&$form, $node)   X-Ref
Build the common elements of the book form for the node and outline forms.


_book_update_outline(&$node)   X-Ref
Common helper function to handles additions and updates to the book outline.

Performs all additions and updates to the book outline through node addition,
node editing, node deletion, or the outline tab.

book_update_bid($book_link)   X-Ref
Update the bid for a page and its children when it is moved to a new book.

param: $book_link

book_get_flat_menu($book_link)   X-Ref
Get the book menu tree for a page, and return it as a linear array.

param: $book_link
return:

_book_flatten_menu($tree, &$flat)   X-Ref
Recursive helper function for book_get_flat_menu().


book_prev($book_link)   X-Ref
Fetches the menu link for the previous page of the book.


book_next($book_link)   X-Ref
Fetches the menu link for the next page of the book.


book_children($book_link)   X-Ref
Format the menu links for the child pages of the current page.


book_menu_name($bid)   X-Ref
Generate the corresponding menu name from a book ID.


book_build_active_trail($book_link)   X-Ref
Build an active trail to show in the breadcrumb.


book_nodeapi(&$node, $op, $teaser = NULL, $page = NULL)   X-Ref
Implementation of hook_nodeapi().

Appends book navigation to all nodes in the book, and handles book outline
insertions and updates via the node form.

_book_parent_depth_limit($book_link)   X-Ref
Find the depth limit for items in the parent select.


book_form_node_delete_confirm_alter(&$form, $form_state)   X-Ref
Form altering function for the confirm form for a single node deletion.


_book_link_defaults($nid)   X-Ref
Return an array with default values for a book link.


template_preprocess_book_navigation(&$variables)   X-Ref
Process variables for book-navigation.tpl.php.

The $variables array contains the following arguments:
- $book_link


_book_toc_recurse($tree, $indent, &$toc, $exclude, $depth_limit)   X-Ref
A recursive helper function for book_toc().


book_toc($bid, $exclude = array()   X-Ref
Returns an array of book pages in table of contents order.

param: $bid
param: $exclude
param: $depth_limit
return:

template_preprocess_book_export_html(&$variables)   X-Ref
Process variables for book-export-html.tpl.php.

The $variables array contains the following arguments:
- $title
- $contents
- $depth


book_export_traverse($tree, $visit_func)   X-Ref
Traverse the book tree to build printable or exportable output.

During the traversal, the $visit_func() callback is applied to each
node, and is called recursively for each child of the node (in weight,
title order).

param: $tree
param: $visit_func
return:

book_node_export($node, $children = '')   X-Ref
Generates printer-friendly HTML for a node.

param: $node
param: $children
return:

template_preprocess_book_node_export_html(&$variables)   X-Ref
Process variables for book-node-export-html.tpl.php.

The $variables array contains the following arguments:
- $node
- $children


book_type_is_allowed($type)   X-Ref
Determine if a given node type is in the list of types allowed for books.


book_node_type($op, $type)   X-Ref
Implementation of hook_node_type().

Update book module's persistent variables if the machine-readable name of a
node type is changed.

book_help($path, $arg)   X-Ref
Implementation of hook_help().


book_link_load($mlid)   X-Ref
Like menu_link_load(), but adds additional data from the {book} table.

Do not call when loading a node, since this function may call node_load().

book_menu_subtree_data($item)   X-Ref
Get the data representing a subtree of the book hierarchy.

The root of the subtree will be the link passed as a parameter, so the
returned tree will contain this item and all its descendents in the menu tree.

param: $item
return:



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