====== Customizing Issue Relationships ======

**Author:** Victor Boctor


===== Introduction =====

Starting Mantis 1.1.0a4, it is possible to add your own custom relationships.  In this example, we will add "origin of" and "originates from" relationships.  These relationships will be supported the same way as native relationships: i.e. in View Issue page, relationship graphs, filters and email notifications.

===== Customization Steps =====

==== Define Constants ====

Create custom_constants_inc.php in Mantis config folder and add the following code to it:

<code php>
<?php
	define( 'BUG_CUSTOM_RELATIONSHIP_ORIGIN_OF',       99 );
	define( 'BUG_CUSTOM_RELATIONSHIP_ORIGINATES_FROM', 98 );
</code>

==== Define Relationship Metadata ====

Create custom_relationships_inc.php in Mantis config folder and add the following code to it:

<code php>
<?php
	$g_relationships[ BUG_CUSTOM_RELATIONSHIP_ORIGIN_OF ] = array(
		'#forward' => true,
		'#complementary' => BUG_CUSTOM_RELATIONSHIP_ORIGINATES_FROM,
		'#description' => 'rel_origin_of',
		'#notify_added' => 'email_notification_title_for_action_origin_of_relationship_added',
		'#notify_deleted' => 'email_notification_title_for_action_origin_of_relationship_deleted',
		'#edge_style' => array ( 'style' => 'dashed', 'color' => '808080' ),
	);

	$g_relationships[ BUG_CUSTOM_RELATIONSHIP_ORIGINATES_FROM ] = array(
		'#forward' => false,
		'#complementary' => BUG_CUSTOM_RELATIONSHIP_ORIGIN_OF,
		'#description' => 'rel_originates_from',
		'#notify_added' => 'email_notification_title_for_action_originates_from_relationship_added',
		'#notify_deleted' => 'email_notification_title_for_action_originates_from_relationship_deleted',
		'#edge_style' => array ( 'style' => 'dashed', 'color' => '808080' ),
	);
</code>

Following is the documentation for the metadata structure:
  * The array index is the relationship type ID that you define for your custom relationships.
  * '#forward' is a boolean that specifies the conceptual direction of the relationship: is it forward from this bug to the one specified, or backward from the one specified to this one?
  * '#complementary' specifies the ID of the complementary relationship: for 'parent', it's 'child', etc. Some relationships are their own complementary; in this case just use the same type ID as the array index.
  * '#description' is the localization string is defined in custom_strings_inc.php
  * '#notify_added' and '#notify_deleted' are the string names for email messages when this relationship is modified in a bug.
  * '#edge_style' is the Graphviz edge style to be used for this relationship type.

==== Define Custom Strings ====

Create custom_strings_inc.php in Mantis config folder and add the following code to it:

<code php>
<?php
	$s_rel_origin_of = 'origin of';
	$s_rel_originates_from = 'originates from';

	$s_email_notification_title_for_action_origin_of_relationship_added = 'Origin-Of Relationship Added';
	$s_email_notification_title_for_action_origin_of_relationship_deleted = 'Origin-Of Relationship Deleted';
	$s_email_notification_title_for_action_originates_from_relationship_added = 'Originates-From Relationship Added';
	$s_email_notification_title_for_action_originates_from_relationship_deleted = 'Originates-From Relationship Deleted';
</code>

===== Problems =====

The legend below the graphs does not contain customized relationships (see issue [[http://www.mantisbt.org/bugs/view.php?id=13203|13203]]).

===== Acknowledgement =====

This feature was contributed by kratib ([[http://www.mantisbt.org/bugs/view.php?id=8130|8130]]).