[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/ -> history_api.php (summary)

History API

Copyright: Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright: Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
File Size: 605 lines (22 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions

  history_log_event_direct()
  history_log_event()
  history_log_event_special()
  history_get_events_array()
  history_get_raw_events_array()
  history_localize_item()
  history_delete()

Functions
Functions that are not part of a class:

history_log_event_direct( $p_bug_id, $p_field_name, $p_old_value, $p_new_value, $p_user_id = null, $p_type = 0 )   X-Ref
log the changes (old / new value are supplied to reduce db access)
events should be logged *after* the modification

param: int $p_bug_id
param: string $p_field_name
param: string $p_old_value
param: string $p_new_value
param: int $p_user_id
param: int $p_type

history_log_event( $p_bug_id, $p_field_name, $p_old_value )   X-Ref
log the changes
events should be logged *after* the modification

param: int $p_bug_id
param: string $p_field_name
param: string $p_old_value
return: null

history_log_event_special( $p_bug_id, $p_type, $p_optional = '', $p_optional2 = '' )   X-Ref
log the changes
events should be logged *after* the modification
These are special case logs (new bug, deleted bugnote, etc.)

param: int $p_bug_id
param: int $p_type
param: string $p_optional
param: string $p_optional2
return: null

history_get_events_array( $p_bug_id, $p_user_id = null )   X-Ref
Retrieves the history events for the specified bug id and returns it in an array
The array is indexed from 0 to N-1.  The second dimension is: 'date', 'username',
'note', 'change'.

param: int $p_bug_id
param: int $p_user_id
return: array

history_get_raw_events_array( $p_bug_id, $p_user_id = null )   X-Ref
Retrieves the raw history events for the specified bug id and returns it in an array
The array is indexed from 0 to N-1.  The second dimension is: 'date', 'userid', 'username',
'field','type','old_value','new_value'

param: int $p_bug_id
param: int $p_user_id
return: array

history_localize_item( $p_field_name, $p_type, $p_old_value, $p_new_value, $p_linkify=true )   X-Ref
Localizes one raw history item specified by set the next parameters: $p_field_name, $p_type, $p_old_value, $p_new_value
Returns array with two elements indexed as 'note' and 'change'

param: string $p_field_name
param: int $p_type
param: string $p_old_value
param: string $p_new_value
param: bool $p_linkify
return: array

history_delete( $p_bug_id )   X-Ref
delete all history associated with a bug

param: int $p_bug_id
return: true



Generated: Thu Jul 28 15:48:31 2011 Cross-referenced by PHPXref 0.7