function user_relationships_update_relationship in User Relationships 5.2

Same name and namespace in other branches

1. 5 user_relationships_api.inc \user_relationships_update_relationship()

Public API for updating a relationship.

Parameters

$relationship: object of the current relationship

$updated_relationship: object of the updated relationship

Return value

object of the updated relationship

3 calls to user_relationships_update_relationship()

user_relationships_pending_requested_submit in ./user_relationships_actions.inc

Approve, Disapprove, or Cancel a relationship request

user_relationship_implications_user_relationships in plugins/user_relationship_implications/user_relationship_implications.module

hook_user_relationships()

user_relationship_service_approve in plugins/user_relationship_service/user_relationship_service.module

File

./user_relationships_api.inc, line 157

Code

function user_relationships_update_relationship($current_relationship, &$updated_relationship, $reason = 'update') {
  if (is_numeric($current_relationship)) {
    $current_relationship = user_relationships_load($current_relationship);
  }

  // ensure data that shouldn't change doesn't
  $updated_relationship->rid = $current_relationship->rid;
  $updated_relationship->created_at = $current_relationship->created_at;
  if (_user_relationships_save_relationship($updated_relationship, $reason) === FALSE) {
    return FALSE;
  }
  return $updated_relationship;
}