| [ Index ] |
PHP Cross Reference of MantisBT |
[Source view] [Print] [Project Stats]
Relationship API RELATIONSHIP DEFINITIONS * Child/parent relationship: the child bug is generated by the parent bug or is directly linked with the parent with the following meaning the child bug has to be resolved before resolving the parent bug (the child bug "blocks" the parent bug) example: bug A is child bug of bug B. It means: A blocks B and B is blocked by A * General relationship: two bugs related each other without any hierarchy dependance bugs A and B are related * Duplicates: it's used to mark a bug as duplicate of an other bug already stored in the database bug A is marked as duplicate of B. It means: A duplicates B, B has duplicates
| Author: | Marcello Scata' |
| Copyright: | Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org |
| Copyright: | Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net |
| File Size: | 896 lines (34 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
BugRelationshipData:: (23 methods):
relationship_get_complementary_type()
relationship_add()
relationship_update()
relationship_delete()
relationship_delete_all()
relationship_copy_all()
relationship_get()
relationship_get_all_src()
relationship_get_all_dest()
relationship_get_all()
relationship_exists()
relationship_same_type_exists()
relationship_get_linked_bug_id()
relationship_get_description_src_side()
relationship_get_description_dest_side()
relationship_get_description_for_history()
relationship_can_resolve_bug()
relationship_get_details()
relationship_get_summary_html()
relationship_get_summary_html_preview()
relationship_get_summary_text()
relationship_list_box()
relationship_view_box()
Class: BugRelationshipData - X-Ref
RelationshipData Structure Definition| relationship_get_complementary_type( $p_relationship_type ) X-Ref |
| Return the complementary type of the provided relationship param: int $p_relationship_type Relationship type return: int Complementary type |
| relationship_add( $p_src_bug_id, $p_dest_bug_id, $p_relationship_type ) X-Ref |
| Add a new relationship param: int $p_src_bug_id Source Bug Id param: int $p_dest_bug_id Destination Bug Id param: int $p_relationship_type Relationship type return: BugRelationshipData Bug Relationship |
| relationship_update( $p_relationship_id, $p_src_bug_id, $p_dest_bug_id, $p_relationship_type ) X-Ref |
| Update a relationship param: int $p_relationship_id Relationship Id to update param: int $p_src_bug_id Source Bug Id param: int $p_dest_bug_id Destination Bug Id param: int $p_relationship_type Relationship type return: BugRelationshipData Bug Relationship |
| relationship_delete( $p_relationship_id ) X-Ref |
| Delete a relationship param: int $p_relationship_id Relationship Id to update |
| relationship_delete_all( $p_bug_id ) X-Ref |
| Deletes all the relationships related to a specific bug (both source and destination) param: int $p_bug_id Bug Id |
| relationship_copy_all( $p_bug_id, $p_new_bug_id ) X-Ref |
| copy all the relationships related to a specific bug to a new bug param: int $p_bug_id Source Bug Id param: int $p_new_bug_id Destination Bug Id |
| relationship_get( $p_relationship_id ) X-Ref |
| get a relationship from id param: int $p_relationship_id Relationship ID return: null|BugRelationshipData BugRelationshipData object |
| relationship_get_all_src( $p_src_bug_id ) X-Ref |
| get all relationships with the given bug as source param: int $p_src_bug_id Source Bug id return: array Array of BugRelationshipData objects |
| relationship_get_all_dest( $p_dest_bug_id ) X-Ref |
| get all relationships with the given bug as destination param: int $p_dest_bug_id Destination Bug id return: array Array of BugRelationshipData objects |
| relationship_get_all( $p_bug_id, &$p_is_different_projects ) X-Ref |
| get all relationships associated with the given bug param: int $p_bug_id Bug id param: bool &$p_is_different_projects Returned Boolean value indicating if some relationships cross project boundaries return: array Array of BugRelationshipData objects |
| relationship_exists( $p_src_bug_id, $p_dest_bug_id ) X-Ref |
| check if there is a relationship between two bugs return id if found 0 otherwise param: int $p_src_bug_id Source Bug Id param: int $p_dest_bug_id Destination Bug Id return: int Relationship ID |
| relationship_same_type_exists( $p_src_bug_id, $p_dest_bug_id, $p_rel_type ) X-Ref |
| check if there is a relationship between two bugs return: 0 if the relationship is not found -1 if the relationship is found and it's of the same type $p_rel_type id if the relationship is found and it's of a different time (this means it can be replaced with the new type $p_rel_type param: int $p_src_bug_id Source Bug Id param: int $p_dest_bug_id Destination Bug Id param: int $p_rel_type Relationship Type return: int 0, -1 or id |
| relationship_get_linked_bug_id( $p_relationship_id, $p_bug_id ) X-Ref |
| retrieve the linked bug id of the relationship: provide src -> return dest; provide dest -> return src param: int $p_relationship_id Relationship id param: int $p_bug_id Bug Id return: int Complementary bug id |
| relationship_get_description_src_side( $p_relationship_type ) X-Ref |
| get class description of a relationship (source side) param: int $p_relationship_type Relationship type return: string Relationship description |
| relationship_get_description_dest_side( $p_relationship_type ) X-Ref |
| get class description of a relationship (destination side) param: int $p_relationship_type Relationship type return: string Relationship description |
| relationship_get_description_for_history( $p_relationship_code ) X-Ref |
| get class description of a relationship as it's stored in the history param: int $p_relationship_code Relationship Type return: string Relationship description |
| relationship_can_resolve_bug( $p_bug_id ) X-Ref |
| return false if there are child bugs not resolved/closed N.B. we don't check if the parent bug is read-only. This is because the answer of this function is indepedent from the state of the parent bug itself. param: int $p_bug_id Bug id return: bool |
| relationship_get_details( $p_bug_id, $p_relationship, $p_html = false, $p_html_preview = false, $p_show_project = false ) X-Ref |
| return formatted string with all the details on the requested relationship param: int $p_bug_id Bug id param: BugRelationshipData $p_relationship Relationsip object param: bool $p_html Generate html param: bool $p_html_preview ???? generate printable version??? param: bool $p_show_project Show Project details return: string |
| relationship_get_summary_html( $p_bug_id ) X-Ref |
| print ALL the RELATIONSHIPS OF A SPECIFIC BUG param: int $p_bug_id Bug id return: string |
| relationship_get_summary_html_preview( $p_bug_id ) X-Ref |
| print ALL the RELATIONSHIPS OF A SPECIFIC BUG param: int $p_bug_id Bug id return: string |
| relationship_get_summary_text( $p_bug_id ) X-Ref |
| print ALL the RELATIONSHIPS OF A SPECIFIC BUG in text format (used by email_api.php param: int $p_bug_id Bug id return: string |
| relationship_list_box( $p_default_rel_type = -1, $p_select_name = "rel_type", $p_include_any = false, $p_include_none = false ) X-Ref |
| print HTML relationship listbox param: int $p_default_rel_type Relationship Type (default -1) param: string $p_select_name List box name (default "rel_type") param: bool $p_include_any Include an ANY option in list box (default false) param: bool $p_include_none Include a NONE option in list box (default false) param: int $p_bug_id Bug id return: null |
| relationship_view_box( $p_bug_id ) X-Ref |
| print HTML relationship form param: int $p_bug_id Bug id return: null |
| Generated: Thu Jul 28 15:48:31 2011 | Cross-referenced by PHPXref 0.7 |