| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* $Id$
*
*/
-
class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn {
/**
* Class constructor
*
- * @access public
* @return \CRM_Financial_DAO_FinancialTrxn
*/
/**
- *
*/
- function __construct() {
+ public function __construct() {
parent::__construct();
}
/**
* Takes an associative array and creates a financial transaction object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
- * @param string $trxnEntityTable entity_table
+ * @param string $trxnEntityTable
+ * Entity_table.
*
- * @return CRM_Core_BAO_FinancialTrxn object
- * @access public
- * @static
+ * @return CRM_Core_BAO_FinancialTrxn
*/
- static function create(&$params, $trxnEntityTable = null ) {
+ public static function create(&$params, $trxnEntityTable = NULL) {
$trxn = new CRM_Financial_DAO_FinancialTrxn();
$trxn->copyValues($params);
$fids = array();
$trxn->save();
// save to entity_financial_trxn table
- $entityFinancialTrxnParams =
- array(
+ $entityFinancialTrxnParams
+ = array(
'entity_table' => "civicrm_contribution",
'financial_trxn_id' => $trxn->id,
'amount' => $params['total_amount'],
if (!empty($trxnEntityTable)) {
$entityFinancialTrxnParams['entity_table'] = $trxnEntityTable['entity_table'];
- $entityFinancialTrxnParams['entity_id'] = $trxnEntityTable['entity_id'];
+ $entityFinancialTrxnParams['entity_id'] = $trxnEntityTable['entity_id'];
}
else {
- $entityFinancialTrxnParams['entity_id'] = $params['contribution_id'];
+ $entityFinancialTrxnParams['entity_id'] = $params['contribution_id'];
}
$entityTrxn = new CRM_Financial_DAO_EntityFinancialTrxn();
*
* @return array
*/
- static function getBalanceTrxnAmt($contributionId, $contributionFinancialTypeId = NULL) {
+ public static function getBalanceTrxnAmt($contributionId, $contributionFinancialTypeId = NULL) {
if (!$contributionFinancialTypeId) {
$contributionFinancialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'financial_type_id');
}
$balanceAmtDAO = CRM_Core_DAO::executeQuery($q, $p);
$ret = array();
- while($balanceAmtDAO->fetch()) {
+ while ($balanceAmtDAO->fetch()) {
$ret['trxn_id'] = $balanceAmtDAO->id;
$ret['total_amount'] = $balanceAmtDAO->total_amount;
}
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contribute_BAO_ContributionType object
- * @access public
- * @static
+ * @return CRM_Contribute_BAO_ContributionType
*/
- static function retrieve( &$params, &$defaults ) {
- $financialItem = new CRM_Financial_DAO_FinancialTrxn( );
+ public static function retrieve(&$params, &$defaults) {
+ $financialItem = new CRM_Financial_DAO_FinancialTrxn();
$financialItem->copyValues($params);
- if ($financialItem->find(true)) {
- CRM_Core_DAO::storeValues( $financialItem, $defaults );
+ if ($financialItem->find(TRUE)) {
+ CRM_Core_DAO::storeValues($financialItem, $defaults);
return $financialItem;
}
- return null;
+ return NULL;
}
/**
* Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record.
* NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object.
*
- * @param $entity_id id of the entity usually the contactID.
- * @param string $orderBy to get single trxn id for a entity table i.e last or first.
+ * @param $entity_id
+ * Id of the entity usually the contactID.
+ * @param string $orderBy
+ * To get single trxn id for a entity table i.e last or first.
* @param bool $newTrxn
*
- * @return array $tag array of category id's the contact belongs to.
+ * @return array
+ * array of category id's the contact belongs to.
*
- * @access public
- * @static
*/
- static function getFinancialTrxnId($entity_id, $orderBy = 'ASC', $newTrxn = FALSE) {
+ public static function getFinancialTrxnId($entity_id, $orderBy = 'ASC', $newTrxn = FALSE) {
$ids = array('entityFinancialTrxnId' => NULL, 'financialTrxnId' => NULL);
$condition = "";
* Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record.
* @todo This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object.
*
- * @param int $entity_id id of the entity usually the contactID.
+ * @param int $entity_id
+ * Id of the entity usually the contactID.
*
- * @return array $tag array of catagory id's the contact belongs to.
+ * @return array
+ * array of catagory id's the contact belongs to.
*
- * @access public
- * @static
*/
- static function getFinancialTrxnTotal($entity_id) {
+ public static function getFinancialTrxnTotal($entity_id) {
$query = "
SELECT (ft.amount+SUM(ceft.amount)) AS total FROM civicrm_entity_financial_trxn AS ft
LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.financial_trxn_id = ceft.entity_id
";
$sqlParams = array(1 => array($entity_id, 'Integer'));
- return CRM_Core_DAO::singleValueQuery($query, $sqlParams);
+ return CRM_Core_DAO::singleValueQuery($query, $sqlParams);
}
/**
* Given an financial_trxn_id check for previous entity_financial_trxn.
*
- * @param $financial_trxn_id id of the latest payment.
+ * @param $financial_trxn_id
+ * Id of the latest payment.
*
*
- * @return array $payment array of previous payments
+ * @return array
+ * array of previous payments
*
- * @access public
- * @static
*/
- static function getPayments($financial_trxn_id) {
+ public static function getPayments($financial_trxn_id) {
$query = "
SELECT ef1.financial_trxn_id, sum(ef1.amount) amount
FROM civicrm_entity_financial_trxn ef1
* Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record.
* NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object.
*
- * @param $entity_id id of the entity usually the contactID.
- * @param string $entity_table name of the entity table usually 'civicrm_contact'
+ * @param $entity_id
+ * Id of the entity usually the contactID.
+ * @param string $entity_table
+ * Name of the entity table usually 'civicrm_contact'.
*
- * @return array $tag array of catagory id's the contact belongs to.
+ * @return array
+ * array of catagory id's the contact belongs to.
*
- * @access public
- * @static
*/
- static function getFinancialTrxnLineTotal($entity_id, $entity_table = 'civicrm_contribution') {
+ public static function getFinancialTrxnLineTotal($entity_id, $entity_table = 'civicrm_contribution') {
$query = "SELECT lt.price_field_value_id AS id, ft.financial_trxn_id,ft.amount AS amount FROM civicrm_entity_financial_trxn AS ft
LEFT JOIN civicrm_financial_item AS fi ON fi.id = ft.entity_id AND fi.entity_table = 'civicrm_line_item' AND ft.entity_table = 'civicrm_financial_item'
LEFT JOIN civicrm_line_item AS lt ON lt.id = fi.entity_id AND lt.entity_table = %2
WHERE lt.entity_id = %1 ";
$sqlParams = array(1 => array($entity_id, 'Integer'), 2 => array($entity_table, 'String'));
- $dao = CRM_Core_DAO::executeQuery($query, $sqlParams);
- while($dao->fetch()){
+ $dao = CRM_Core_DAO::executeQuery($query, $sqlParams);
+ while ($dao->fetch()) {
$result[$dao->financial_trxn_id][$dao->id] = $dao->amount;
}
if (!empty($result)) {
return $result;
}
else {
- return null;
+ return NULL;
}
}
* Delete financial transaction
*
* @param int $entity_id
- * @return true on success, false otherwise
- * @access public
- * @static
+ * @return bool
+ * TRUE on success, FALSE otherwise.
*/
- static function deleteFinancialTrxn($entity_id) {
+ public static function deleteFinancialTrxn($entity_id) {
$query = "DELETE ceft1, cfi, ceft, cft FROM `civicrm_financial_trxn` cft
LEFT JOIN civicrm_entity_financial_trxn ceft
ON ceft.financial_trxn_id = cft.id AND ceft.entity_table = 'civicrm_contribution'
/**
* Create financial transaction for premium
*
- * @access public
- * @static
*/
- static function createPremiumTrxn($params) {
+ public static function createPremiumTrxn($params) {
if ((empty($params['financial_type_id']) || empty($params['contributionId'])) && empty($params['oldPremium'])) {
return;
}
$financialAccountType = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id']);
$accountRelationship = CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND label IN ('Premiums Inventory Account is', 'Cost of Sales Account is')");
$toFinancialAccount = !empty($params['isDeleted']) ? 'Premiums Inventory Account is' : 'Cost of Sales Account is';
- $fromFinancialAccount = !empty($params['isDeleted']) ? 'Cost of Sales Account is': 'Premiums Inventory Account is';
+ $fromFinancialAccount = !empty($params['isDeleted']) ? 'Cost of Sales Account is' : 'Premiums Inventory Account is';
$accountRelationship = array_flip($accountRelationship);
$financialtrxn = array(
'to_financial_account_id' => $financialAccountType[$accountRelationship[$toFinancialAccount]],
'trxn_date' => date('YmdHis'),
'total_amount' => CRM_Utils_Array::value('cost', $params) ? $params['cost'] : 0,
'currency' => CRM_Utils_Array::value('currency', $params),
- 'status_id' => array_search('Completed', $contributionStatuses)
+ 'status_id' => array_search('Completed', $contributionStatuses),
);
$trxnEntityTable['entity_table'] = 'civicrm_contribution';
$trxnEntityTable['entity_id'] = $params['contributionId'];
if (!empty($params['oldPremium'])) {
$premiumParams = array(
- 'id' => $params['oldPremium']['product_id']
+ 'id' => $params['oldPremium']['product_id'],
);
$productDetails = array();
CRM_Contribute_BAO_ManagePremiums::retrieve($premiumParams, $productDetails);
'currency' => CRM_Utils_Array::value('currency', $productDetails),
'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $productDetails),
'contributionId' => $params['oldPremium']['contribution_id'],
- 'isDeleted' => TRUE
+ 'isDeleted' => TRUE,
);
CRM_Core_BAO_FinancialTrxn::createPremiumTrxn($params);
}
/**
* Create financial trxn and items when fee is charged
*
- * @param array $params to create trxn entries
+ * @param array $params
+ * To create trxn entries.
*
- * @access public
- * @static
*/
- static function recordFees($params) {
+ public static function recordFees($params) {
$expenseTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Expense Account is' "));
$domainId = CRM_Core_Config::domainID();
$amount = 0;
$params['trxnParams']['from_financial_account_id'] = $params['to_financial_account_id'];
$params['trxnParams']['to_financial_account_id'] = $financialAccount;
$params['trxnParams']['total_amount'] = $amount;
- $params['trxnParams']['fee_amount'] =
- $params['trxnParams']['net_amount'] = 0;
- $params['trxnParams']['status_id'] = CRM_Core_OptionGroup::getValue('contribution_status','Completed','name');
+ $params['trxnParams']['fee_amount'] = $params['trxnParams']['net_amount'] = 0;
+ $params['trxnParams']['status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
$params['trxnParams']['contribution_id'] = $contributionId;
$trxn = self::create($params['trxnParams']);
if (empty($params['entity_id'])) {
$financialTrxnID = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['trxnParams']['contribution_id'], 'DESC');
$params['entity_id'] = $financialTrxnID['financialTrxnId'];
}
- $fItemParams =
- array(
+ $fItemParams
+ = array(
'financial_account_id' => $financialAccount,
'contact_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', $domainId, 'contact_id'),
'created_date' => date('YmdHis'),
'transaction_date' => date('YmdHis'),
'amount' => $amount,
'description' => 'Fee',
- 'status_id' => CRM_Core_OptionGroup::getValue('financial_item_status','Paid','name'),
+ 'status_id' => CRM_Core_OptionGroup::getValue('financial_item_status', 'Paid', 'name'),
'entity_table' => 'civicrm_financial_trxn',
'entity_id' => $params['entity_id'],
'currency' => $params['trxnParams']['currency'],
$financialItem = CRM_Financial_BAO_FinancialItem::create($fItemParams, NULL, $trxnIDS);
}
- /*
- * get partial payment amount and type of it
- * return @array : payment type => amount
- * payment type : 'amount_owed' or 'refund_due'
- */
/**
+ * get partial payment amount and type of it
+ *
* @param int $entityId
* @param string $entityName
* @param bool $returnType
- * @param null $lineItemTotal
+ * @param int $lineItemTotal
*
- * @return array|int|null|string
+ * @return array|int|NULL|string
+ * [payment type => amount]
+ * payment type: 'amount_owed' or 'refund_due'
*/
- static function getPartialPaymentWithType($entityId, $entityName = 'participant', $returnType = TRUE, $lineItemTotal = NULL) {
+ public static function getPartialPaymentWithType($entityId, $entityName = 'participant', $returnType = TRUE, $lineItemTotal = NULL) {
$value = NULL;
if (empty($entityName)) {
return $value;
if ($returnType) {
$value = array();
if ($paymentVal < 0) {
- $value['refund_due'] = $paymentVal;
+ $value['refund_due'] = $paymentVal;
}
elseif ($paymentVal > 0) {
$value['amount_owed'] = $paymentVal;
}
return $value;
}
+
}
projects / civicrm-core.git / blobdiff