<?php

/*
 +--------------------------------------------------------------------+
 | CiviCRM version 3.0                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2009                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007.                                       |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License along with this program; if not, contact CiviCRM LLC       |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2009
 * $Id$
 *
 */

require_once 'CRM/Core/DAO/PaymentProcessorType.php';


class CRM_Core_BAO_PaymentProcessorType extends CRM_Core_DAO_PaymentProcessorType {

    /**
     * static holder for the default payment processor
     */
    static $_defaultPaymentProcessorType = null;


    /**
     * class constructor
     */
    function __construct( ) {
        parent::__construct( );
    }

    /**
     * Takes a bunch of params that are needed to match certain criteria and
     * retrieves the relevant objects. Typically the valid params are only
     * contact_id. We'll tweak this function to be more full featured over a period
     * of time. This is the inverse function of create. It also stores all the retrieved
     * values in the default array
     *
     * @param array $params   (reference ) an assoc array of name/value pairs
     * @param array $defaults (reference ) an assoc array to hold the flattened values
     *
     * @return object CRM_Core_BAO_LocaationType object on success, null otherwise
     * @access public
     * @static
     */
    static function retrieve( &$params, &$defaults ) {
        $paymentProcessorType =& new CRM_Core_DAO_PaymentProcessorType( );
        $paymentProcessorType->copyValues( $params );
        if ( $paymentProcessorType->find( true ) ) {
            CRM_Core_DAO::storeValues( $paymentProcessorType, $defaults );
            return $paymentProcessorType;
        }
        return null;
    }
    
    /**
     * update the is_active flag in the db
     *
     * @param int      $id        id of the database record
     * @param boolean  $is_active value we want to set the is_active field
     *
     * @return Object             DAO object on sucess, null otherwise
     * 
     * @access public
     * @static
     */
    static function setIsActive( $id, $is_active ) {
        return CRM_Core_DAO::setFieldValue( 'CRM_Core_DAO_PaymentProcessorType', $id, 'is_active', $is_active );
    }
    
    /**
     * retrieve the default payment processor
     * 
     * @param NULL
     * 
     * @return object           The default payment processor object on success,
     *                          null otherwise
     * @static
     * @access public
     */
    static function &getDefault( ) {
        if (self::$_defaultPaymentProcessorType == null) {
            $params = array( 'is_default' => 1 );
            $defaults = array();
            self::$_defaultPaymentProcessorType = self::retrieve($params, $defaults);
        }
        return self::$_defaultPaymentProcessorType;
    }
    
    /**
     * Function to delete payment processor
     * 
     * @param  int  $paymentProcessorTypeId     ID of the processor to be deleted.
     * 
     * @access public
     * @static
     */
    static function del($paymentProcessorTypeId) 
    {
        $query = "SELECT pp.id processor_id  
                  FROM civicrm_payment_processor pp, civicrm_payment_processor_type ppt
                  WHERE pp.payment_processor_type = ppt.name AND ppt.id = %1";
        
        $params = array( 1 => array( $paymentProcessorTypeId, 'Integer' ) );
        $dao = CRM_Core_DAO::executeQuery( $query, $params);

        if ( $dao->fetch( ) ) {
            CRM_Core_Session::setStatus( ts('There is a Payment Processor associated with selected Payment Processor type, hence it can not be deleted.') );                
            return;
        }

        $paymentProcessorType = & new CRM_Core_DAO_PaymentProcessorType( );
        $paymentProcessorType->id = $paymentProcessorTypeId;
        $paymentProcessorType->delete();
        CRM_Core_Session::setStatus( ts('Selected Payment Processor type has been deleted.') );
    }
}

