[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/sites/default/files/hooks/ -> signup.signup.api.php (summary)

(no description)

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

Defines 11 functions

  hook_signup_pane_info()
  hook_signup_data_alter()
  hook_signup_cancel()
  hook_signup_insert()
  hook_signup_update()
  hook_signup_sign_up()
  hook_signup_open()
  hook_signup_close()
  hook_signup_suppress()
  hook_signup_menu_access()
  hook_signup_form_data_display_alter()

Functions
Functions that are not part of a class:

hook_signup_pane_info($node = NULL)   X-Ref
Hook to define panes available to insert into the signup form.

Panes should be provided by callback functions as a FormAPI array.
The callback should have the following signature:
function my_callback(&$signup_form, &$form_state, $node, $signup, $pane_id, $signup_type = 'auth')
See signup_basic_form_form for an example.
The values submitted to the form elements defined by this form will be
serialized and stored in the {signup_log} table as 'form_data'.

param: $node
return:

hook_signup_data_alter(&$signup, $form_values)   X-Ref
Hook to alter signup data before a signup is inserted or updated.

param: $signup
param: $form_values

hook_signup_cancel($signup, $node)   X-Ref
Hook invoked when a signup is being canceled.

At the time this hook is invoked the record about the signup in the
{signup_log} table still exists, but the node has already had its signup
total decremented.

param: $node
param: $signup
return:

hook_signup_insert($signup)   X-Ref
Hook invoked after a signup has been inserted.

param: $signup

hook_signup_update($signup)   X-Ref
Hook invoked after a signup has been updated.

param: $signup

hook_signup_sign_up($node, $account)   X-Ref
Hook invoked when a signup is being created to gather other signup data.

This hook allows other modules to inject information into the custom signup
data for each signup.  The array is merged with the values of any custom
fields from hook_signup_pane_info(), serialized, and stored in the
{signup_log} database table.

param: $node
param: $account
return:

hook_signup_open($node)   X-Ref
Hook invoked whenever a node is reopened for signups.

A node with signups closed could be reopened in two main cases: 1) someone
cancels a signup and the signup limit is no longer reached; 2) a signup
administrator manually re-opens signups.

param: $node
return:

hook_signup_close($node)   X-Ref
Hook invoked whenever a node is closed for signups.

Signups are closed in 3 main cases: 1) it is a time-based node and the
close-in-advance time has been reached (auto-close via cron); 2) the node
has a signup limit and the limit is reached; 3) a signup administrator
manually closes signups.

param: $node
return:

hook_signup_suppress($node)   X-Ref
Hook invoked to see if signup information should be printed for a node.

This hook is invoked whenever someone is viewing a signup-enabled node and
allows modules to suppress any signup-related output.  If any module's
implementation of this hook returns TRUE, no signup information will be
printed for that node.

param: $node
return:

hook_signup_menu_access($node, $menu_type)   X-Ref
Hook invoked to control access to signup menu items.

This hook is invoked to check access for signup menu items, in particular,
the signup-related tabs on signup-enabled nodes. If no value is returned
(NULL), the hook is ignored and the usual access logic is enforced via the
Signup module. If multiple modules return a value, the logical OR is used,
so if anyone returns TRUE, access is granted. If everyone returns FALSE,
access is denied (even if the Signup module would normally grant access).

param: $node
param: $menu_type
return:

hook_signup_form_data_display_alter(&$form_data, $nid, $sid, $uid, $type = 'list')   X-Ref
Implementation of hook_signup_form_data_display_alter().

Allow modules to alter signup form data prior to displaying signup records
in, for example, a node's list of signups at node/N/signups/admin.

This allows modules that implement signup panes for format or even inject
their own data.

param: $form_data
param: $nid
param: $sid
param: $uid
param: $type



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