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

Procedural File: bug_revision_api.php

Source Location: /core/bug_revision_api.php



Page Details:

This API allows bugs to keep a read-only history of changes to longtext boxes.



Tags:

copyright:  Copyright (C) 2002 - 2010 Mantis Team - mantisbt-dev@lists.sourceforge.net
link:  http://www.mantisbt.org








bug_revision_add [line 36]

int bug_revision_add( int $p_bug_id, int $p_user_id, int $p_type, string $p_value, [int $p_bugnote_id = 0], [int $p_timestamp = null])

Add a new revision to a bug history.



Tags:

return:  Revision ID


Parameters

int   $p_bug_id   Bug ID
int   $p_user_id   User ID
int   $p_type   Revision Type
string   $p_value   Value
int   $p_bugnote_id   Bugnote ID
int   $p_timestamp   Timestamp(int)
[ Top ]



bug_revision_count [line 192]

array|null bug_revision_count( int $p_bug_id, [int $p_type = REV_ANY], [int $p_bugnote_id = 0])

Retrieve a count of revisions to the bug's information.



Tags:

return:  Array of Revision rows


Parameters

int   $p_bug_id   Bug ID
int   $p_type   Revision Type (optional)
int   $p_bugnote_id   Bugnote ID (optional)
[ Top ]



bug_revision_delete [line 222]

null bug_revision_delete( int $p_bug_id, [int $p_bugnote_id = 0])

Delete all revision history for a bug.



Parameters

int   $p_bug_id   Bug ID
int   $p_bugnote_id   Bugnote ID (optional)
[ Top ]



bug_revision_drop [line 150]

null bug_revision_drop( int $p_revision_id)

Remove one or more bug revisions from the bug history.



Parameters

int   $p_revision_id   Revision ID, or array of revision IDs
[ Top ]



bug_revision_exists [line 90]

bool bug_revision_exists( int $p_revision_id)

Check if a bug revision exists



Tags:

return:  Whether or not the bug revision exists


Parameters

int   $p_revision_id   Revision ID
[ Top ]



bug_revision_get [line 108]

array bug_revision_get( int $p_revision_id)

Get a row of data for a given revision ID.



Tags:

return:  Revision data row


Parameters

int   $p_revision_id   Revision ID
[ Top ]



bug_revision_get_type_name [line 126]

string bug_revision_get_type_name( $p_revision_type_id, int $p_revision_id)

Get the name of the type of a bug revision.



Tags:

return:  Name of the type of the bug revision


Parameters

int   $p_revision_id   Revision type ID (see constant_inc.php for possible values)
   $p_revision_type_id  
[ Top ]



bug_revision_last [line 241]

null|array bug_revision_last( int $p_bug_id, [int $p_type = REV_ANY], [int $p_bugnote_id = 0])

Retrieve the last change to the bug's information.



Tags:

return:  Revision row


Parameters

int   $p_bug_id   Bug ID
int   $p_type   Revision Type (optional)
int   $p_bugnote_id   Bugnote ID (optional)
[ Top ]



bug_revision_like [line 313]

array|null bug_revision_like( int $p_rev_id)

Retrieve a list of changes to a bug of the same type as the given revision ID.



Tags:

return:  Array of Revision rows


Parameters

int   $p_rev_id   Revision ID
[ Top ]



bug_revision_list [line 277]

array/null bug_revision_list( int $p_bug_id, [int $p_type = REV_ANY], [int $p_bugnote_id = 0])

Retrieve a full list of changes to the bug's information.



Tags:

return:  Array of Revision rows


Parameters

int   $p_bug_id   Bug ID
int   $p_type   Revision Type
int   $p_bugnote_id   Bugnote ID
[ Top ]



Documentation generated on Sun, 12 Dec 2010 23:50:12 +0900 by phpDocumentor 1.4.3
inserted by FC2 system