[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

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

(no description)

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

Defines 85 functions

  node_help()
  node_theme()
  node_cron()
  node_title_list()
  theme_node_list()
  node_tag_new()
  node_last_viewed()
  node_mark()
  node_teaser_js()
  node_teaser_include_verify()
  node_teaser()
  node_get_types()
  node_types_rebuild()
  node_type_save()
  node_type_delete()
  node_type_update_nodes()
  _node_types_build()
  _node_type_set_defaults()
  node_hook()
  node_invoke()
  node_invoke_nodeapi()
  node_load()
  node_validate()
  node_submit()
  node_save()
  _node_save_revision()
  node_delete()
  node_view()
  node_prepare()
  node_build_content()
  node_show()
  theme_node_log_message()
  node_perm()
  node_search()
  node_user()
  theme_node_search_admin()
  node_comment_mode()
  node_link()
  _node_revision_access()
  _node_add_access()
  node_menu()
  node_page_title()
  node_init()
  node_last_changed()
  node_revision_list()
  node_block()
  node_feed()
  node_page_default()
  node_page_view()
  node_update_index()
  _node_index_node()
  node_form_alter()
  node_search_validate()
  node_access()
  _node_access_join_sql()
  _node_access_where_sql()
  node_access_grants()
  node_access_view_all_nodes()
  node_db_rewrite_sql()
  node_access_acquire_grants()
  node_access_write_grants()
  node_access_needs_rebuild()
  node_access_rebuild()
  _node_access_rebuild_batch_operation()
  _node_access_rebuild_batch_finished()
  node_content_access()
  node_content_form()
  node_forms()
  theme_node_submitted()
  node_hook_info()
  node_action_info()
  node_publish_action()
  node_unpublish_action()
  node_make_sticky_action()
  node_make_unsticky_action()
  node_promote_action()
  node_unpromote_action()
  node_save_action()
  node_assign_owner_action()
  node_assign_owner_action_form()
  node_assign_owner_action_validate()
  node_assign_owner_action_submit()
  node_unpublish_by_keyword_action_form()
  node_unpublish_by_keyword_action_submit()
  node_unpublish_by_keyword_action()

Functions
Functions that are not part of a class:

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


node_theme()   X-Ref
Implementation of hook_theme()


node_cron()   X-Ref
Implementation of hook_cron().


node_title_list($result, $title = NULL)   X-Ref
Gather a listing of links to nodes.

param: $result
param: $title
return:

theme_node_list($items, $title = NULL)   X-Ref
Format a listing of links to nodes.


node_tag_new($nid)   X-Ref
Update the 'last viewed' timestamp of the specified node for current user.


node_last_viewed($nid)   X-Ref
Retrieves the timestamp at which the current user last viewed the
specified node.


node_mark($nid, $timestamp)   X-Ref
Decide on the type of marker to be displayed for a given node.

param: $nid
param: $timestamp
return:

node_teaser_js(&$form, &$form_state)   X-Ref
See if the user used JS to submit a teaser.


node_teaser_include_verify(&$form, &$form_state)   X-Ref
Ensure value of "teaser_include" checkbox is consistent with other form data.

This handles two situations in which an unchecked checkbox is rejected:

1. The user defines a teaser (summary) but it is empty;
2. The user does not define a teaser (summary) (in this case an
unchecked checkbox would cause the body to be empty, or missing
the auto-generated teaser).

If JavaScript is active then it is used to force the checkbox to be
checked when hidden, and so the second case will not arise.

In either case a warning message is output.

node_teaser($body, $format = NULL, $size = NULL)   X-Ref
Generate a teaser for a node body.

If the end of the teaser is not indicated using the <!--break--> delimiter
then we generate the teaser automatically, trying to end it at a sensible
place such as the end of a paragraph, a line break, or the end of a
sentence (in that order of preference).

param: $body
param: $format
param: $size
return:

node_get_types($op = 'types', $node = NULL, $reset = FALSE)   X-Ref
Builds a list of available node types, and returns all of part of this list
in the specified format.

param: $op
param: $node
param: $reset
return:

node_types_rebuild()   X-Ref
Resets the database cache of node types, and saves all new or non-modified
module-defined node types to the database.


node_type_save($info)   X-Ref
Saves a node type to the database.

param: $info
return:

node_type_delete($type)   X-Ref
Deletes a node type from the database.

param: $type

node_type_update_nodes($old_type, $type)   X-Ref
Updates all nodes of one type to be of another type.

param: $old_type
param: $type
return:

_node_types_build()   X-Ref
Builds and returns the list of available node types.

The list of types is built by querying hook_node_info() in all modules, and
by comparing this information with the node types in the {node_type} table.


_node_type_set_defaults($info)   X-Ref
Set default values for a node type defined through hook_node_info().


node_hook(&$node, $hook)   X-Ref
Determine whether a node hook exists.

param: &$node
param: $hook
return:

node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL)   X-Ref
Invoke a node hook.

param: &$node
param: $hook
param: $a2, $a3, $a4
return:

node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL)   X-Ref
Invoke a hook_nodeapi() operation in all modules.

param: &$node
param: $op
param: $a3, $a4
return:

node_load($param = array()   X-Ref
Load a node object from the database.

param: $param
param: $revision
param: $reset
return:

node_validate($node, $form = array()   X-Ref
Perform validation checks on the given node.


node_submit($node)   X-Ref
Prepares a node for saving by populating teaser, author, and creation date.

param: object|array $node
return:

node_save(&$node)   X-Ref
Save a node object into the database.


_node_save_revision(&$node, $uid, $update = NULL)   X-Ref
Helper function to save a revision with the uid of the current user.

Node is taken by reference, becuse drupal_write_record() updates the
$node with the revision id, and we need to pass that back to the caller.

node_delete($nid)   X-Ref
Delete a node.


node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE)   X-Ref
Generate a display of the given node.

param: $node
param: $teaser
param: $page
param: $links
return:

node_prepare($node, $teaser = FALSE)   X-Ref
Apply filters and build the node's standard elements.


node_build_content($node, $teaser = FALSE, $page = FALSE)   X-Ref
Builds a structured array representing the node's content.

param: $node
param: $teaser
param: $page
return:

node_show($node, $cid, $message = FALSE)   X-Ref
Generate a page displaying a single node, along with its comments.


theme_node_log_message($log)   X-Ref
Theme a log message.


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


node_search($op = 'search', $keys = NULL)   X-Ref
Implementation of hook_search().


node_user($op, &$edit, &$user)   X-Ref
Implementation of hook_user().


theme_node_search_admin($form)   X-Ref
Theme the content ranking part of the search settings admin page.


node_comment_mode($nid)   X-Ref
Retrieve the comment mode for the given node ID (none, read, or read/write).


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


_node_revision_access($node, $op = 'view')   X-Ref
No description

_node_add_access()   X-Ref
No description

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


node_page_title($node)   X-Ref
Title callback.


node_init()   X-Ref
Implementation of hook_init().


node_last_changed($nid)   X-Ref
No description

node_revision_list($node)   X-Ref
Return a list of all the existing revision numbers.


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


node_feed($nids = FALSE, $channel = array()   X-Ref
A generic function for generating RSS feeds from a set of nodes.

param: $nids
param: $channel

node_page_default()   X-Ref
Menu callback; Generate a listing of promoted nodes.


node_page_view($node, $cid = NULL)   X-Ref
Menu callback; view a single node.


node_update_index()   X-Ref
Implementation of hook_update_index().


_node_index_node($node)   X-Ref
Index a single node.

param: $node

node_form_alter(&$form, $form_state, $form_id)   X-Ref
Implementation of hook_form_alter().


node_search_validate($form, &$form_state)   X-Ref
Form API callback for the search form. Registered in node_form_alter().


node_access($op, $node, $account = NULL)   X-Ref
Determine whether the current user may perform the given operation on the
specified node.

param: $op
param: $node
param: $account
return:

_node_access_join_sql($node_alias = 'n', $node_access_alias = 'na')   X-Ref
Generate an SQL join clause for use in fetching a node listing.

param: $node_alias
param: $node_access_alias
return:

_node_access_where_sql($op = 'view', $node_access_alias = 'na', $account = NULL)   X-Ref
Generate an SQL where clause for use in fetching a node listing.

param: $op
param: $node_access_alias
param: $account
return:

node_access_grants($op, $account = NULL)   X-Ref
Fetch an array of permission IDs granted to the given user ID.

The implementation here provides only the universal "all" grant. A node
access module should implement hook_node_grants() to provide a grant
list for the user.

param: $op
param: $account
return:

node_access_view_all_nodes()   X-Ref
Determine whether the user has a global viewing grant for all nodes.


node_db_rewrite_sql($query, $primary_table, $primary_field)   X-Ref
Implementation of hook_db_rewrite_sql


node_access_acquire_grants($node)   X-Ref
Gets the list of node access grants and writes them to the database.

This function is called when a node is saved, and can also be called by
modules if something other than a node save causes node access permissions
to change. It collects all node access grants for the node from
hook_node_access_records() implementations and saves the collected
grants to the database.

param: $node

node_access_write_grants($node, $grants, $realm = NULL, $delete = TRUE)   X-Ref
Writes a list of grants to the database, deleting any previously saved ones.

If a realm is provided, it will only delete grants from that realm, but it
will always delete a grant from the 'all' realm. Modules that utilize
node_access can use this function when doing mass updates due to widespread
permission changes.

param: $node
param: $grants
param: $realm
param: $delete

node_access_needs_rebuild($rebuild = NULL)   X-Ref
Flag / unflag the node access grants for rebuilding, or read the current
value of the flag.

When the flag is set, a message is displayed to users with 'access
administration pages' permission, pointing to the 'rebuild' confirm form.
This can be used as an alternative to direct node_access_rebuild calls,
allowing administrators to decide when they want to perform the actual
(possibly time consuming) rebuild.
When unsure the current user is an adminisrator, node_access_rebuild
should be used instead.

param: $rebuild
return:

node_access_rebuild($batch_mode = FALSE)   X-Ref
Rebuild the node access database. This is occasionally needed by modules
that make system-wide changes to access levels.

When the rebuild is required by an admin-triggered action (e.g module
settings form), calling node_access_needs_rebuild(TRUE) instead of
node_access_rebuild() lets the user perform his changes and actually
rebuild only once he is done.

Note : As of Drupal 6, node access modules are not required to (and actually
should not) call node_access_rebuild() in hook_enable/disable anymore.

param: $batch_mode

_node_access_rebuild_batch_operation(&$context)   X-Ref
Batch operation for node_access_rebuild_batch.

This is a mutlistep operation : we go through all nodes by packs of 20.
The batch processing engine interrupts processing and sends progress
feedback after 1 second execution time.

_node_access_rebuild_batch_finished($success, $results, $operations)   X-Ref
Post-processing for node_access_rebuild_batch.


node_content_access($op, $node, $account)   X-Ref
Implementation of hook_access().

Named so as not to conflict with node_access()

node_content_form($node, $form_state)   X-Ref
Implementation of hook_form().


node_forms()   X-Ref
Implementation of hook_forms(). All node forms share the same form handler


theme_node_submitted($node)   X-Ref
Format the "Submitted by username on date/time" for each node


node_hook_info()   X-Ref
Implementation of hook_hook_info().


node_action_info()   X-Ref
Implementation of hook_action_info().


node_publish_action(&$node, $context = array()   X-Ref
Implementation of a Drupal action.
Sets the status of a node to 1, meaning published.


node_unpublish_action(&$node, $context = array()   X-Ref
Implementation of a Drupal action.
Sets the status of a node to 0, meaning unpublished.


node_make_sticky_action(&$node, $context = array()   X-Ref
Implementation of a Drupal action.
Sets the sticky-at-top-of-list property of a node to 1.


node_make_unsticky_action(&$node, $context = array()   X-Ref
Implementation of a Drupal action.
Sets the sticky-at-top-of-list property of a node to 0.


node_promote_action(&$node, $context = array()   X-Ref
Implementation of a Drupal action.
Sets the promote property of a node to 1.


node_unpromote_action(&$node, $context = array()   X-Ref
Implementation of a Drupal action.
Sets the promote property of a node to 0.


node_save_action($node)   X-Ref
Implementation of a Drupal action.
Saves a node.


node_assign_owner_action(&$node, $context)   X-Ref
Implementation of a configurable Drupal action.
Assigns ownership of a node to a user.


node_assign_owner_action_form($context)   X-Ref
No description

node_assign_owner_action_validate($form, $form_state)   X-Ref
No description

node_assign_owner_action_submit($form, $form_state)   X-Ref
No description

node_unpublish_by_keyword_action_form($context)   X-Ref
No description

node_unpublish_by_keyword_action_submit($form, $form_state)   X-Ref
No description

node_unpublish_by_keyword_action($node, $context)   X-Ref
Implementation of a configurable Drupal action.
Unpublish a node if it contains a certain string.

param: $context
param: $comment



Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7