CiviCRM Community Forums (archive)

I think there must be something fundamental I just haven't twigged onto.

I want to write a hook to do some relationship 'stuff'. So I went to the api Relationship.php to see what fields I would need to pass in to create a relationship. What I see is:
/**
 * Add or update a relationship
 *
 * @param  array   $params   (reference ) input parameters
 *
 * @return array (reference) id of created or updated record
 * @static void
 * @access public
 */
function civicrm_relationship_create( &$params )
So, what I was hoping to see is what parameters I would need / could pass in in order to create a relationship but at the moment I'm no wiser. I'm sure other people have a clever way to figure it out because all I can think of doing is trawling through the code to find an example to copy. (in this case I'll look at Lobo's blog code) but there must be a more intelligent way.

Thanks.

I'm wondering - Lobo didn't use the API for his schools module - he just re-wrote the sql. I kind of thought the point of the API was to not have to write sql directly for these sorts of functions. Have I got it wrong?