/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultContributionType = null;
/**
- * class constructor
+ * Class constructor
*/
- function __construct( ) {
+ public 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
+ * 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
*
- * @return object CRM_Contribute_BAO_ContributionType object
- * @access public
+ * @return CRM_Contribute_BAO_ContributionType object
* @static
*/
- static function retrieve( &$params, &$defaults ) {
+ public static function retrieve( &$params, &$defaults ) {
$financialType = new CRM_Financial_DAO_FinancialType( );
$financialType->copyValues( $params );
if ($financialType->find(true)) {
}
/**
- * update the is_active flag in the db
+ * 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
* @static
*/
- static function setIsActive( $id, $is_active ) {
+ public static function setIsActive( $id, $is_active ) {
return CRM_Core_DAO::setFieldValue( 'CRM_Financial_DAO_FinancialType', $id, 'is_active', $is_active );
}
/**
- * function to add the financial types
+ * Add the financial types
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
*
- * @access public
* @static
* @return object
*/
- static function add(&$params, &$ids = array()) {
+ public static function add(&$params, &$ids = array()) {
if(empty($params['id'])) {
$params['is_active'] = CRM_Utils_Array::value('is_active', $params, false);
$params['is_deductible'] = CRM_Utils_Array::value('is_deductible', $params, false);
}
/**
- * Function to delete financial Types
+ * Delete financial Types
*
- * @param int $contributionTypeId
+ * @param int $financialTypeId
+ *
+ * @return array|bool
* @static
*/
- static function del($financialTypeId) {
+ public static function del($financialTypeId) {
$financialType = new CRM_Financial_DAO_FinancialType( );
$financialType->id = $financialTypeId;
$financialType->find(true);
}
/**
- * to fetch financial type having relationship as Income Account is
+ * To fetch financial type having relationship as Income Account is
*
*
* @return array all financial type with income account is relationship
* @static
*/
- static function getIncomeFinancialType() {
+ public static function getIncomeFinancialType() {
// Financial Type
$financialType = CRM_Contribute_PseudoConstant::financialType();
$revenueFinancialType = array();
return $financialType;
}
}
-