phpDocumentor CoreAPI
BugGroupActionAPI
[ class tree: CoreAPI ] [ index: CoreAPI ] [ all elements ]

Procedural File: bug_group_action_api.php

Source Location: /core/bug_group_action_api.php

Page Details
Copyright:  Copyright (C) 2002 - 2009 MantisBT Team - mantisbt-dev@lists.sourceforge.net
Copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Link:  http://www.mantisbt.org
Functions
bug_group_action_print_action_fields  [line 96]

void bug_group_action_print_action_fields( $p_action $p_action  )

Prints the list of fields in the custom action form. These are the user inputs and the submit button. This ends up calling action_<action>_print_fields() from bug_actiongroup_<action>_inc.php

Parameters:
$p_action   $p_action:  The custom action name without the "EXT_" prefix.


[ Top ]
bug_group_action_print_bottom  [line 35]

void bug_group_action_print_bottom( )

Print the bottom part for the bug action group page.



[ Top ]
bug_group_action_print_bug_list  [line 44]

void bug_group_action_print_bug_list( $p_bug_ids_array $p_bug_ids_array  )

Print the list of selected issues and the legend for the status colors.

Parameters:
$p_bug_ids_array   $p_bug_ids_array:  An array of issue ids.


[ Top ]
bug_group_action_print_hidden_fields  [line 83]

void bug_group_action_print_hidden_fields( $p_bug_ids_array $p_bug_ids_array  )

Print the array of issue ids via hidden fields in the form to be passed on to the bug action group action page.

Parameters:
$p_bug_ids_array   $p_bug_ids_array:  An array of issue ids.


[ Top ]
bug_group_action_print_title  [line 108]

void bug_group_action_print_title( $p_action $p_action  )

Prints some title text for the custom action page. This ends up calling action_<action>_print_title() from bug_actiongroup_<action>_inc.php

Parameters:
$p_action   $p_action:  The custom action name without the "EXT_" prefix.


[ Top ]
bug_group_action_print_top  [line 28]

void bug_group_action_print_top( )

Print the top part for the bug action group page.



[ Top ]
bug_group_action_process  [line 138]

true|array bug_group_action_process( $p_action $p_action, $p_bug_id $p_bug_id  )

Executes an action on a bug. This ends up calling action_<action>_process() from bug_actiongroup_<action>_inc.php

Parameters:
$p_action   $p_action:  The custom action name without the "EXT_" prefix.
$p_bug_id   $p_bug_id:  The id of the bug to validate the action on.

API Tags:
Return:  Action can be applied., ( bug_id => reason for failure to process )


[ Top ]
bug_group_action_validate  [line 123]

true|array bug_group_action_validate( $p_action $p_action, $p_bug_id $p_bug_id  )

Validates the combination of an action and a bug. This ends up calling action_<action>_validate() from bug_actiongroup_<action>_inc.php

Parameters:
$p_action   $p_action:  The custom action name without the "EXT_" prefix.
$p_bug_id   $p_bug_id:  The id of the bug to validate the action on.

API Tags:
Return:  true if action can be applied or array of ( bug_id => reason for failure to validate )


[ Top ]


Documentation generated on Sun, 05 Apr 2009 23:00:58 +0100 by phpDocumentor 1.4.1