CiviCRM Community Forums (archive)

Hello, I saw the post [url href="http://wiki.civicrm.org/confluence/display/CRMDOC22/Enhance+Organizational+Membership+Functionality"]here[/url] and liked the idea of extending the On Behalf Of to include some custom fields. That particular wiki page is outdated and so I attempted to do some of this on my own. I am a little stuck however and could use some help to point me in the right direction. For the purpose of this I am wanting to add a field that has the value of custom_1 (id1)  in the database and is named category. I have managed to get it to appear correctly on the frontend but am losing the value somewhere in the processing. Here is where I am at:

Step 1:
I created a custom version (custom PHP directory) of CRM/Contact/BAO/Contact/Utils.php

To this I added the following code inside the buildOnBehalfForm() function at line 511:
CRM_Core_BAO_CustomField::addQuickFormElement($form ,'custom_1',1,false,true,false,ts('Category'));

Step 2:
I created a custom version (custom PHP directory) of CRM/Contribute/Form/ContributionBase.php

To this I added the following code inside the assignToTemplate() function at line 617 (within the is_for_organization if statement)
$this->assign('onBehalfCustom1',   $this->_params['onbehalf_custom']['custom_1']);

Step 3:
I created a custom template at templates/CRM/Contribute/Form/Contribution/3/Main.tpl (3 is ID of the contribution page I am overriding) that duplicates the normal template except the following

In this file I changed the if statement for on behalf of to the following:
{if $is_for_organization}
        {include file=CRM/Contact/Form/3/OnBehalfOf.tpl}
{/if}

Step 4:
I created a custom template at templates/CRM/Contact/Form/3/OnBehalfOf.tpl (3 is ID of the contribution page I am overriding) that duplicates the normal template except the following

At line 123 I added the following:
<div class="section {$form.custom_1.}-section">
            <div class="label">{$form.custom_1.label}</div>
            <div class="content">{$form.custom_1.html}</div>
            <div class="clear"></div>
</div> 

Step 5:
I created a custom version (custom PHP directory) of CRM/Contribute/Form/Contribution/Confirm.php

In the postProcess() function I added the following at line 461
if ( array_key_exists( 'onbehalf_custom', $params ) && is_array( $params['onbehalf_custom'] ) ) {
                foreach ( $params['onbehalf_custom'] as $key => $value ) {
                    $behalfOrganization[$key] = $value;
                }               
                unset($params['onbehalf_custom']);
 }

I also added the following in the processOnBehalfOrganization() function at line 1156
require_once 'CRM/Core/BAO/CustomField.php';
$customFields = CRM_Core_BAO_CustomField::getFields( 'Organization', false, true );
$behalfOrganization['custom'] = CRM_Core_BAO_CustomField::postProcess( $behalfOrganization,
                                                                               $customFields,
                                                                               CRM_Utils_Array::value('organization_id', $behalfOrganization),
                                                                               'Organization', true );

I believe that I am close to having this work but am just a little bit off. The correct HTML for the custom field is displaying in the correct place (it is a multiselect). It just seems for some reason the values aren't getting set in the database. I am hoping a fresh set of eyes could take a look. Thanks!

Great, perhaps we can help each other out! I have already found a better way to do a portion of this so perhaps we can build some documentation together. Below is my revised findings. Basically I figured out that rather then make custom PHP files I can simply use the civi hooks. I still don't have it so it processes the records but I am getting closer! A lot of var dumping and logging haha.

Step 1: Getting the Initial Form to Display Custom Fields
It turns out this is actually very easy. In this example I am adding 2 custom fields to my "On Behalf of" Section. The fields are custom_1 (category) and custom_3 (description) which correspond to custom data setup in the backend. Category is a multi-select and description is a textbox.

First, you must implement the civiCRM hooks. I did this as a Joomla plugin with the same idea as http://forum.civicrm.org/index.php?topic=10725.0. Once that is done you must first make the html/info for the fields available to the SMARTY template. I did this within the buildForm hook by adding the following code:

$id = $form->getVar( '_id' );      
      
if($formName == 'CRM_Contribute_Form_Contribution_Main' && $id == 3){         
         
   CRM_Core_BAO_CustomField::addQuickFormElement($form ,'custom_1',1,false,true,false,ts('Category'));
   CRM_Core_BAO_CustomField::addQuickFormElement($form ,'custom_3',3,false,true,false,ts('Description'));
}   

Please note that 3 is the id of the contribution page I am wishing to override.   

Once the code is available to the template it is a matter of creating overrides of those templates.

To templates/CRM/Contribute/Form/Contribution/3/Main.tpl I replaced:
{if $is_for_organization}
        {include file=CRM/Contact/Form/OnBehalfOf.tpl}
{/if}

With:
{if $is_for_organization}
        {include file=CRM/Contact/Form/3/OnBehalfOf.tpl}
{/if}

To templates/CRM/Contact/Form/3/OnBehalfOf.tpl I added:

<div class="section {$form.custom_1}-section">
         <div class="label">{$form.custom_1.label}</div>
         <div class="content">{$form.custom_1.html}</div>
         <div class="clear"></div>
</div> 
           
<div class="section {$form.custom_3}-section">
          <div class="label">{$form.custom_3.label}</div>
          <div class="content">{$form.custom_3.html}</div>
          <div class="clear"></div>
</div> 

This was added the place I wanted it to show up on the form.

That's as far as I've gotten at this point but I thing that using the validate and postProcess hooks I should be able to figure out how to get this working all the way through.

hey john:

please ping us on IRC if you need any help or assistance. Your new approach is significanly better IMO and seems like u r on the right track

lobo

Here is an Update:

Step 1: Getting the Initial Form to Display Custom Fields
It turns out this is actually very easy. In this example I am adding 2 custom fields to my "On Behalf of" Section. The fields are custom_1 (category) and custom_3 (description) which correspond to custom data setup in the backend. Category is a multi-select and description is a textbox.

First, you must implement the civiCRM hooks. I did this as a Joomla plugin with the same idea as http://forum.civicrm.org/index.php?topic=10725.0. Once that is done you must first make the html/info for the fields available to the SMARTY template. I did this within the buildForm hook by adding the following code:

$id = $form->getVar( '_id' );     
     
if($formName == 'CRM_Contribute_Form_Contribution_Main' && $id == 3){         
         
   CRM_Core_BAO_CustomField::addQuickFormElement($form ,'custom_1',1,false,true,false,ts('Category'));
   CRM_Core_BAO_CustomField::addQuickFormElement($form ,'custom_3',3,false,true,false,ts('Description'));
}   

Please note that 3 is the id of the contribution page I am wishing to override.   

Once the code is available to the template it is a matter of creating overrides of those templates.

To templates/CRM/Contribute/Form/Contribution/3/Main.tpl I replaced:
{if $is_for_organization}
        {include file=CRM/Contact/Form/OnBehalfOf.tpl}
{/if}

With:
{if $is_for_organization}
        {include file=CRM/Contact/Form/3/OnBehalfOf.tpl}
{/if}

To templates/CRM/Contact/Form/3/OnBehalfOf.tpl I added:

<div class="section {$form.custom_1}-section">
         <div class="label">{$form.custom_1.label}</div>
         <div class="content">{$form.custom_1.html}</div>
         <div class="clear"></div>
</div>
           
<div class="section {$form.custom_3}-section">
          <div class="label">{$form.custom_3.label}</div>
          <div class="content">{$form.custom_3.html}</div>
          <div class="clear"></div>
</div>

This was added the place I wanted it to show up on the form.

Step 2: Showing the Custom Fields on the Confirm Screen
To the buildForm hook, next we need to add the following code:

if($formName == 'CRM_Contribute_Form_Contribution_Confirm' && $id == 3){
         $params = $form->getVar('_params');         
         $form->assign('onBehalfCustom_1', $params['custom_1']);
         $form->assign('onBehalfCustom_3', $params['custom_3']);
}

Then we need to create a custom version of /templates/CRM/Contribute/Form/Contribution/3/Contribute.tpl and add the following to the On Behalf of Section (around line 162)

<div class="display-block">
        {section name=category loop=$onBehalfCustom_1}
         {$onBehalfCustom_1[category]}<br/>
        {/section}           
</div>
<div class="display-block">
            {$onBehalfCustom_3}
</div>

Keep in mind my "custom_1" is a multiselect.

Next to work on processing and saving in the database! The biggest obstacle I can see at this point is getting the new organization id. Hopefully I (or someone) can get that figured out soon!

Here's a very hackish solution:

$MODULENAME_CREATED = array()

function modulename_civicrm_post($op, $objectName, $objectId, &$objectRef) {
  global $MODULENAME_CREATED;
  /*_dbg('post called'); */
  if ($op == 'create') {
    _dbg(array($objectName, $objectId));
    $MODULENAME_CREATED[] = array($objectName, $objectId);
    _dbg($_SESSION);
  }
}

then in

function moduelname_civicrm_postProcess($formName, &$form)

You can handle the form changes set up in buildForm, pulling the newly created id from $MODULENAME_CREATED

I did get this mostly working using the APIs to create the data. I did not completely finish though so have not posted. I still need to prepopulate (renwals). Sadly, I have been working on another project recently and the client that wanted this did not want to pursue this any further. When I have some free time I will finish it up and post.

Jimmyjam,

I got your PM and responded.  The long and short of it is that I don't think anyone has the budget to sponsor a general solution for ~$3,000 right now.

BUT, if you can hire WebAccess (my recommendation) to make a Drupal module that will "use hooks" extend a particular Contribution Form to include Organizational Custom data in the Behalf Of section and save that data in the database, I'll co-sponsor the work with $250 of my own $.  I would like copy of the Drupal module code that I could then modify for my own purposes/sites.  If more $ is required, let me know, I'll consider it.

Thanks, Peter. This will help a lot. Stoob and I have enough to cover adding custom fields to the confirmation form, but not to the confirmation page and email receipt. Hopefully, your extra $250 will be enough to complete the project.

I'll check with Claudian and Web Access and let you know.

Best regards,
James