<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultMembershipStatus = 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
+ * @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_Member_BAO_MembershipStatus object
- * @access public
+ * @return CRM_Member_BAO_MembershipStatus object
* @static
*/
- static function retrieve(&$params, &$defaults) {
+ public static function retrieve(&$params, &$defaults) {
$membershipStatus = new CRM_Member_DAO_MembershipStatus();
$membershipStatus->copyValues($params);
if ($membershipStatus->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
+ * @param int $id
+ * Id of the database record.
+ * @param bool $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_Member_DAO_MembershipStatus', $id, 'is_active', $is_active);
}
* Takes an associative array and creates a membership Status object
* See http://wiki.civicrm.org/confluence/display/CRM/Database+layer
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @throws Exception
- * @return object CRM_Member_BAO_MembershipStatus object
- * @access public
+ * @return CRM_Member_BAO_MembershipStatus object
* @static
*/
- static function create($params){
+ public static function create($params) {
$ids = array();
- if(!empty($params['id'])){
+ if (!empty($params['id'])) {
$ids['membershipStatus'] = $params['id'];
}
else{
return $membershipStatusBAO;
}
/**
- * function to add the membership types
+ * Add the membership types
*
- * @param array $params reference array contains the values submitted by the form
- * @param array $ids array contains the id - this param is deprecated
+ * @param array $params
+ * Reference array contains the values submitted by the form.
+ * @param array $ids
+ * Array contains the id - this param is deprecated.
*
- * @access public
* @static
*
* @return object
*/
- static function add(&$params, $ids = array()) {
+ public static function add(&$params, $ids = array()) {
$id = CRM_Utils_Array::value('id', $params, CRM_Utils_Array::value('membershipStatus', $ids));
if (!$id) {
CRM_Core_DAO::setCreateDefaults($params, self::getDefaults());
);
}
-
-
// action is taken depending upon the mode
$membershipStatus = new CRM_Member_DAO_MembershipStatus();
$membershipStatus->copyValues($params);
* Get defaults for new entity
* @return array
*/
- static function getDefaults() {
+ public static function getDefaults() {
return array(
'is_active' => FALSE,
'is_current_member' => FALSE,
}
/**
- * Function to get membership status
+ * Get membership status
*
* @param int $membershipStatusId
*
}
/**
- * Function to delete membership Types
+ * Delete membership Types
*
* @param int $membershipStatusId
*
* @throws CRM_Core_Exception
- * @internal param $
* @static
*/
- static function del($membershipStatusId) {
+ public static function del($membershipStatusId) {
//check dependencies
//checking if membership status is present in some other table
$check = FALSE;
}
/**
- * Function to find the membership status based on start date, end date, join date & status date.
+ * Find the membership status based on start date, end date, join date & status date.
*
- * @param string $startDate start date of the member whose membership status is to be calculated.
- * @param string $endDate end date of the member whose membership status is to be calculated.
- * @param string $joinDate join date of the member whose membership status is to be calculated.
+ * @param string $startDate
+ * Start date of the member whose membership status is to be calculated.
+ * @param string $endDate
+ * End date of the member whose membership status is to be calculated.
+ * @param string $joinDate
+ * Join date of the member whose membership status is to be calculated.
* @param \date|string $statusDate status date of the member whose membership status is to be calculated.
- * @param boolean $excludeIsAdmin exclude the statuses those having is_admin = 1
- * @param $membershipTypeID
- * @param array $membership membership params as available to calling function - passed to the hook
+ * @param bool $excludeIsAdminExclude the statuses those having is_admin = 1.
+ * Exclude the statuses those having is_admin = 1.
+ * @param int $membershipTypeID
+ * @param array $membership
+ * Membership params as available to calling function - passed to the hook.
*
- * @internal param int $membershipType membership type id - passed to the hook
* @return array
@static
*/
- static function getMembershipStatusByDate($startDate, $endDate, $joinDate,
+ static function getMembershipStatusByDate(
+ $startDate, $endDate, $joinDate,
$statusDate = 'today', $excludeIsAdmin = FALSE, $membershipTypeID, $membership = array()
) {
$membershipDetails = array();
if (!$statusDate || $statusDate == 'today') {
- $statusDate = getDate();
+ $statusDate = getdate();
$statusDate = date('Ymd',
mktime($statusDate['hours'],
$statusDate['minutes'],
${$dat . 'Month'} + $membershipStatus->{$eve . '_event_adjust_interval'},
${$dat . 'Day'},
${$dat . 'Year'}
- ));
+ ));
}
// add in days
if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'day') {
${$dat . 'Month'},
${$dat . 'Day'} + $membershipStatus->{$eve . '_event_adjust_interval'},
${$dat . 'Year'}
- ));
+ ));
}
// add in years
if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'year') {
${$dat . 'Month'},
${$dat . 'Day'},
${$dat . 'Year'} + $membershipStatus->{$eve . '_event_adjust_interval'}
- ));
+ ));
}
// if no interval and unit, present
}
return $statusIds;
}
}
-
projects / civicrm-core.git / blobdiff