CiviCRM Community Forums (archive)

that seems to be a good way to go about doing things

lobo

Hi Father Shawn,

This is the code for a module we wrote to change the current employer relationship created on sign-up. The form is fired on the Drupal create user form & changes the relationship with the current employer (that is created anyway) to be one whereby the employer has permission to edit the new user. There is also a membership tweak that is probably redundant by version 3.1.x

We have also tweaked the code so that if a user (e.g. an secretary) has permission over an Organisation and that organisation has permission over another user the first user inherits the companies permissions over the second user. We have only implemented this for current employer but arguably this is the only way giving an org permission over an individual makes sense.


<?php

function fuzion_relationships_help( $section ) {
switch ($section) { 
case 'admin/help#fuzion_relationships':
        return t( ' This function changes the current employer relationship created on sign-up
 to be one where the employer has permission to edit the contact. Combined with 
  an edit to permissions.php this allows the company administrator (who has
  permissions over the company) to edit the employees of the company.
  Also there is a tweak for ensuring inherited memberships are created (
  which may not happen automatically depending on the CiviCRM version and who has permissions
  to access CiviMember ' );

    case 'admin/modules#description':
        return t( 'fuzion_relationships module v0.01' );

    }
}
/*
/**
 * This function changes the current employer relationship created on sign-up
 * to be one where the employer has permission to edit the contact. Combined with 
 * an edit to permissions.php this allows the company administrator (who has
 * permissions over the company) to edit the employees of the company.
 * Also there is a tweak for ensuring inherited memberships are created (
 * which may not happen automatically depending on the CiviCRM version and who has permissions
 * to access CiviMember
 *
 */
function fuzion_relationships_civicrm_postProcess( $formName, &$form ) {

if ( $formName == 'CRM_Profile_Form_Dynamic' ) {
civicrm_initialize( true );
$data = get_object_vars($form);
$mode = $form->getVar('_mode');
require_once('api/v2/Relationship.php');
//ie. this contactID is the person submitting the form
                $contactID = $form->getVar( '_id' );
                $employer = $data['_submitValues']['current_employer'];
                // get the employer contactID
                $params = array(
                    'return' => 'id',
                    'sort_name' => $employer, 
                    'contact_type'=> 'Organization'
);
//translate employer name into employer ID as Id doesn't seem to be 
//passed in
require_once('api/v2/Contact.php');
                $apiSearch=(array_values( civicrm_contact_search(&$params)));
                $employerID = (($apiSearch[0]['contact_id']));
                
                // we are updating the relationship that has already been created
                // so that the company will have edit permissions over the employee
                // we need the relationship ID to do this but we haven't been given it 
                // in the form so we need to get it
                $relationshipParams['contact_id'] = $contactID;
                $relationshipParamsb['contact_id'] = $employerID;
                $outputParams =   civicrm_contact_relationship_get($relationshipParams , $relationshipParamsb); 
                $relationshipID = implode(array_keys($outputParams['result']));

                foreach ($outputParams['result'] as $relationshipID -> $value)   {    
             $params = array('contact_id_a' => $contactID,
                     'contact_id_b' => $employerID,
                 'relationship_type_id' => 4,
                 'is_permission_b_a' => 1,
                                 'is_active' => 1,          
                              'id' =>  $relationshipID);
                }
// this is where the relationship is updated
           $newrels = civicrm_relationship_create($params);
   /* here we are forcing the relationship based membership to be updated
   * the membership is not based automatically on sign-up as anonymous
   * user doesn' have permission to do that.
   * this is likely to be fixed soon
   * http://issues.civicrm.org/jira/browse/CRM-5551
    */
   
           $ids['contactTarget'] = $employerID ;
           require_once('CRM/Contact/BAO/Relationship.php');
       CRM_Contact_BAO_Relationship::relatedMemberships( $contactID, $params, $ids,CRM_Core_Action::ADD  );
           
        return;
}

   
}


NOTE the reason this is useful for us is we have tweaked Contact_BAO_Contact_Permission.php to allow 'transitive permissions' - here is the revised function


    static function relationship ( $selectedContactID, $contactID = null )
    {
   
        $session   =& CRM_Core_Session::singleton( );
        if ( ! $contactID ) {
            $contactID =  $session->get( 'userID' );
            if ( ! $contactID ) {
                return false;
            }
        }
        if (  $contactID == $selectedContactID ) {
            return true;
        } else {
         
          //get relationships between given contact IDs where $contactID
          // has permission over the $selectedContactID
         $query = "
SELECT id
FROM   civicrm_relationship
WHERE  ( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR
       ( contact_id_a = %2 AND contact_id_b = %1 AND is_permission_b_a = 1 )
 
";
            $params = array( 1 => array( $contactID        , 'Integer' ),
                             2 => array( $selectedContactID, 'Integer' ) );
            //Fuzion edit starts
            //if contact has edit permission over related contact return true             
            $result =  CRM_Core_DAO::singleValueQuery( $query, $params );

            if ($result){
            return $result;
                   
            }else{
                /* otherwise check for a transitive relationship - i.e. one where they
                * have edit over the employer & the employer has edit over another
                * contact. NB it is difficult to see how else you would apply an
                * employer having permission as they don't log on.
                */

                $contactIds = array($contactID);
require_once('CRM/Contact/BAO/Relationship.php');
            $employer = CRM_Contact_BAO_Relationship::getCurrentEmployer($contactIds);
if($employer[$contactID ][org_id] ){
                $params = array( 1 => array( $contactID        , 'Integer' ),
                                  2 => array( $employer[$contactID ][org_id] , 'Integer' ) );
                                                         
                //does contact have permission to edit their own employer? If not return false   
                // if so proceed to next check             
                $result =  CRM_Core_DAO::singleValueQuery( $query, $params );
}

                if (!$result){
                return $result;
                       
                }else{
               
                     //does contact's employer have permission to edit the secondary contact?
                    //if not return false
                    $params = array( 1 => array( $employer[$contactID ][org_id]       , 'Integer' ),
                                 2 => array( $selectedContactID, 'Integer' ) );
                    $result =  CRM_Core_DAO::singleValueQuery( $query, $params );
   
                    return $result;
             
                }
            }
           
           
            }
        }
   


Thanks, Eileen.  Very thoughtful.

I've actually written my first little Drupal module to inject the proper code into two custom CCK fieldgroups so that they work with Vertical Tabs module. 

I'm really grateful for your code example for the API usage

Is there documentation on the data structure for profile submissions?

the data structure for most civicrm objects corresponds to the schema of that object. so check the DB schema for more details


lobo

IT WORKS!

Contact sub-types inherit fields from their parent, so switching first name and such fields from individual to applicant in the field definitions did the trick and the code that should work, actually does!

Very useful indeed, we will use it for a profile where a person can enter a household, with all the individuals. Once I get to it (probably in about 3 weeks) I will post the result here!

Father Shawn, thanks so much for your work on this module. I, too, haven't written any code in years and years, and am just learning PHP. This is an amazing jump-start into doing exactly what I want to do for my school website. When people apply for jobs and internships, they can list their references, and when prospective students apply, they can tell us who their parents are as well as who will be providing letters of recommendation!  One extension I'll need to add to this module is the automatic creation of activities: so that when a person applies online, an "applied online" activity will be created for them.  Another extension would be to automatically send an email to an applicant's references giving them a link to an appropriate webform.  I'll try to work on those myself, but any advice would be welcome!