CiviCRM Community Forums (archive)

Hi, all. I recently began setting up CiviCRM for a non-profit group. We hold an annual conference where speakers & sponsors receive free registrations.
I would like to be able to implement this http://civicrm.org/node/566, but I am having some trouble understanding it.

My first question (which is a big one) is if anyone has successfully implemented and willing to share their module.
Realizing that might be asking too much, is a more step-by-step instruction available for implementing CiviCRM hooks, or will Drupal's documentation on creating modules help me understand how to make this work?

I do have some PHP knowledge and I understand basically what that is saying. I'm just not clear on the details and am not in a position to hire a professional. (Which may mean I'm just out of luck, but I figured it was worth asking!)
Thanks!

Hi - were you able to get Discounts/Coupons working?

Any updates on your progress? I could really use this feature.

Thanks,
James

So...here's what I did, which is clearly wrong, but maybe somebody can guide me from here.

Created civicrm_civitest folder.
Created civicrm_civitest.info
name = Discount Coupon Support for CiviCRM
description = CiviTest Coupon Support for a specific Event
version = 3.1
dependencies[] = civicrm
package = CiviCRM
core = 6.x
php = 5.2
Created civicrm_civitest.module
<?php
  // $Id: civicrm_discount.module,v 1.0 2010/05/01 04:17:11 posco Exp $
  
function civitest_civicrm_buildForm( $formName, &$form ) {
    if ( $formName == 'CRM_Event_Form_Registration_Register' &&
         $form->getVar( '_eventId' ) == 3 ) { //use event id here
        $form->addElement( 'text', 'discountCode', ts( 'Discount Code' ) );

        // also assign to template
        $template =& CRM_Core_Smarty::singleton( );
        $beginHookFormElements = $template->get_template_vars( 'beginHookFormElements' );
        if ( ! $beginHookFormElements ) { $beginHookFormElements = array( ); }
        $beginHookFormElements[] = 'discountCode';
        $form->assign( 'beginHookFormElements', $beginHookFormElements );

        $discountCode = CRM_Utils_Request::retrieve( 'discountCode', 'String', $form, false, null, $_REQUEST );
        if ( $discountCode ) {
            $defaults = array( 'discountCode' => $discountCode );
            $form->setDefaults( $defaults );
        }
    }
}

function civitest_civicrm_buildAmount( $pageType, &$form, &$amount ) {
    $eventID = $form->getVar( '_eventId' );
    if ( $pageType != 'event' ||
         $eventID != 3 ) { // use event ID here
        return;
    }
    $discountCode = CRM_Utils_Request::retrieve( 'discountCode', 'String', $form, false, null, $_REQUEST );
    if ( ! $discountCode ) { return; }

    list( $discountID, $discountPercent, $discountNumber ) = _civitest_discountHelper( $eventID, $discountCode );
    if ( $discountNumber <= 0 ) { return; }

    foreach ( $amount as $amountId => $amountInfo ) {
        $amount[$amountId]['value'] = $amount[$amountId]['value'] -
            ceil($amount[$amountId]['value'] * $discountPercent / 100);
        $amount[$amountId]['label'] = $amount[$amountId]['label'] .
            "\t - with {$discountPercent}% discount";
    }
}

function civitest_civicrm_postProcess( $class, &$form ) {
    $eventID = $form->getVar( '_eventId' );
    if ( ! is_a($form, 'CRM_Event_Form_Registration_Confirm') || $eventID != 3 ) { return; }
        
    $discountCode = CRM_Utils_Request::retrieve( 'discountCode', 'String', $form, false, null, $_REQUEST );
    if ( ! $discountCode ) { return; }

    list( $discountID, $discountPercent, $discountNumber ) = _civitest_discountHelper( $eventID, $discountCode );
    if ( ! $discountID || $discountNumber <= 0 || $discountNumber == 123456789 ) { return; }

    $query = "UPDATE civicrm_option_value v SET v.weight = v.weight - 1 WHERE  v.id = %1 AND v.weight > 0";
    $params = array( 1 => array( $discountID, 'Integer' ) );
    CRM_Core_DAO::executeQuery( $query, $params );
}

INSERT INTO `civicrm_option_group` (`name`, `description`, `is_reserved`, `is_active`) 
VALUES ('event_discount_3', 'Event Discount', 0, 1); # 3 is the event ID here

SELECT @option_group_id_ed := max(id) from civicrm_option_group where name = 'event_discount_3';

INSERT INTO `civicrm_option_value` (`option_group_id`, `label`, `value`, `name`, `weight`, `is_active`) 
VALUES (@option_group_id_ed, 'Discount Code', 50, '1234XYZ5678', 2, 1);

function _civitest_discountHelper( $eventID, $discountCode ) {
    $sql = "
SELECT v.id as id, v.value as value, v.weight as weight
FROM   civicrm_option_value v,
       civicrm_option_group g
WHERE  v.option_group_id = g.id
AND    v.name = %1
AND    g.name = %2";

    $params = array( 1 => array( $discountCode              , 'String' ),
                     2 => array( "event_discount_{$eventID}", 'String' ) );
    $dao = CRM_Core_DAO::executeQuery( $sql, $params );
    if ( $dao->fetch( ) ) {
        // ensure discountPercent is a valid numeric number <= 100
        if ( $dao->value && is_numeric( $dao->value ) && $dao->value >= 0 &&
             $dao->value <= 100 && is_numeric( $dao->weight ) ) {
            return array( $dao->id, $dao->value, $dao->weight );
        }
    }
    return array( null, null, null );
}
Uploaded files into sites/all/modules/civicrm/drupal/modules
Like I said...clearly I'm missing something...

Thank you thank you!!!

I used those statements to update the database and now the module is okay when enabled.

However, I don't see how to actually apply the coupon code. Do I need to create a custom template where the registrant has a form field to enter the code or what?

Well, I think I understand it in theory, but obviously I'm not getting it in practice!

I've tried using the URL format mentioned to pass my discount code that way, but it doesn't change any behavior.

I wish I was in position to hire someone, but as I am not, do I have any other options?

Can anyone point out to me where I might be missing something or gone wrong?

I have a test event set up where I am trying to get this working: http://kipanet.org/index.php?q=civicrm/event/register&id=5&reset=1&discountCode=speaker

Here is what I have in my .module file:
<?php
  // $Id: civicrm_discount.module,v 1.0 2010/05/01 04:17:11 posco Exp $
  
function discount_civicrm_buildForm( $formName, &$form ) {
    if ( $formName == 'CRM_Event_Form_Registration_Register' &&
         $form->getVar( '_eventId' ) == 5 ) { //use event id here
        $form->addElement( 'text', 'discountCode', ts( 'Discount Code' ) );

        // also assign to template
        $template =& CRM_Core_Smarty::singleton( );
        $beginHookFormElements = $template->get_template_vars( 'beginHookFormElements' );
        if ( ! $beginHookFormElements ) { $beginHookFormElements = array( ); }
        $beginHookFormElements[] = 'discountCode';
        $form->assign( 'beginHookFormElements', $beginHookFormElements );

        $discountCode = CRM_Utils_Request::retrieve( 'discountCode', 'String', $form, false, null, $_REQUEST );
        if ( $discountCode ) {
            $defaults = array( 'discountCode' => $discountCode );
            $form->setDefaults( $defaults );
        }
    }
}

function discount_civicrm_buildAmount( $pageType, &$form, &$amount ) {
    $eventID = $form->getVar( '_eventId' );
    if ( $pageType != 'event' ||
         $eventID != 5 ) { // use event ID here
        return;
    }
    $discountCode = CRM_Utils_Request::retrieve( 'discountCode', 'String', $form, false, null, $_REQUEST );
    if ( ! $discountCode ) { return; }

    list( $discountID, $discountPercent, $discountNumber ) = _discount_discountHelper( $eventID, $discountCode );
    if ( $discountNumber <= 0 ) { return; }

    foreach ( $amount as $amountId => $amountInfo ) {
        $amount[$amountId]['value'] = $amount[$amountId]['value'] -
            ceil($amount[$amountId]['value'] * $discountPercent / 100);
        $amount[$amountId]['label'] = $amount[$amountId]['label'] .
            "\t - with {$discountPercent}% discount";
    }
}

function discount_civicrm_postProcess( $class, &$form ) {
    $eventID = $form->getVar( '_eventId' );
    if ( ! is_a($form, 'CRM_Event_Form_Registration_Confirm') || $eventID != 3 ) { return; }
        
    $discountCode = CRM_Utils_Request::retrieve( 'discountCode', 'String', $form, false, null, $_REQUEST );
    if ( ! $discountCode ) { return; }

    list( $discountID, $discountPercent, $discountNumber ) = _discount_discountHelper( $eventID, $discountCode );
    if ( ! $discountID || $discountNumber <= 0 || $discountNumber == 123456789 ) { return; }

    $query = "UPDATE civicrm_option_value v SET v.weight = v.weight - 1 WHERE  v.id = %1 AND v.weight > 0";
    $params = array( 1 => array( $discountID, 'Integer' ) );
    CRM_Core_DAO::executeQuery( $query, $params );
}

function _discount_discountHelper( $eventID, $discountCode ) {
    $sql = "
SELECT v.id as id, v.value as value, v.weight as weight
FROM   civicrm_option_value v,
       civicrm_option_group g
WHERE  v.option_group_id = g.id
AND    v.name = %1
AND    g.name = %2";

    $params = array( 1 => array( $discountCode              , 'String' ),
                     2 => array( "event_discount_{$eventID}", 'String' ) );
    $dao = CRM_Core_DAO::executeQuery( $sql, $params );
    if ( $dao->fetch( ) ) {
        // ensure discountPercent is a valid numeric number <= 100
        if ( $dao->value && is_numeric( $dao->value ) && $dao->value >= 0 &&
             $dao->value <= 100 && is_numeric( $dao->weight ) ) {
            return array( $dao->id, $dao->value, $dao->weight );
        }
    }
    return array( null, null, null );
}
I added the following field in civicrm_option_group:
id = 70
name = event_discount_5
label = NULL
description = Event Discount
is_reserved = 0
is_active = 1

And this is in civicrm_option_value:
option_group_id = 70
label = Discount Code
value = 100
name = speaker
weight = 200
is_active = 1

The module is enabled.

Congratulations! That's great news.

Can you offer any tips or tricks about how less technical folks (like me) can implement this module? It will be really helpful for some of the nonprofit orgs I am helping with event management.

Thank you,
James