Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REF] Cleanup uses of CRM_Utils_Array::value related to numbers #16778

Merged
merged 1 commit into from
Mar 16, 2020
Merged

[REF] Cleanup uses of CRM_Utils_Array::value related to numbers #16778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CRM/Activity/BAO/Activity.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,7 @@ public static function getActivities($params) {
];
$activities[$id]['activity_type_name'] = CRM_Core_PseudoConstant::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $activity['activity_type_id']);
$activities[$id]['activity_type'] = CRM_Core_PseudoConstant::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $activity['activity_type_id']);
$activities[$id]['target_contact_count'] = CRM_Utils_Array::value('target_contact_count', $activity, 0);
$activities[$id]['target_contact_count'] = $activity['target_contact_count'] ?? 0;
if (!empty($activity['target_contact_count'])) {
$displayedTarget = civicrm_api3('ActivityContact', 'get', [
'activity_id' => $id,
Expand Down Expand Up @@ -1356,7 +1356,7 @@ public static function sendSMS(
$smsProviderParams['To'] = '';
}

$doNotSms = CRM_Utils_Array::value('do_not_sms', $contact, 0);
$doNotSms = $contact['do_not_sms'] ?? 0;

if ($doNotSms) {
$errMsgs[] = PEAR::raiseError('Contact Does not accept SMS', NULL, PEAR_ERROR_RETURN);
Expand Down Expand Up @@ -2462,7 +2462,7 @@ protected static function getActivityParamsForDashboardFunctions($params) {
'activity_date_time' => $params['activity_date_time'] ?? NULL,
'check_permissions' => 1,
'options' => [
'offset' => CRM_Utils_Array::value('offset', $params, 0),
'offset' => $params['offset'] ?? 0,
],
];

Expand Down
2 changes: 1 addition & 1 deletion CRM/Admin/Page/AJAX.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ public static function recipientListing() {
* Used by jstree to incrementally load tags
*/
public static function getTagTree() {
$parent = CRM_Utils_Type::escape(CRM_Utils_Array::value('parent_id', $_GET, 0), 'Integer');
$parent = CRM_Utils_Type::escape(($_GET['parent_id'] ?? 0), 'Integer');
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before/after should work the same given that it's being passed into CRM_Utils_Type::escape()

$substring = CRM_Utils_Type::escape(CRM_Utils_Array::value('str', $_GET), 'String');
$result = [];

Expand Down
2 changes: 1 addition & 1 deletion CRM/Contact/Form/Search/Criteria.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ public static function location(&$form) {
'street_unit' => [ts('Apt/Unit/Suite'), $attributes['street_unit'], NULL, NULL],
];

$parseStreetAddress = CRM_Utils_Array::value('street_address_parsing', $addressOptions, 0);
$parseStreetAddress = $addressOptions['street_address_parsing'] ?? 0;
$form->assign('parseStreetAddress', $parseStreetAddress);
foreach ($elements as $name => $v) {
list($title, $attributes, $select, $multiSelect) = $v;
Expand Down
2 changes: 1 addition & 1 deletion CRM/Contact/Import/Form/DataSource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public function preProcess() {
$errorFiles = ['sqlImport.errors', 'sqlImport.conflicts', 'sqlImport.duplicates', 'sqlImport.mismatch'];

// check for post max size avoid when called twice
$snippet = CRM_Utils_Array::value('snippet', $_GET, 0);
$snippet = $_GET['snippet'] ?? 0;
if (empty($snippet)) {
CRM_Utils_Number::formatUnitSize(ini_get('post_max_size'), TRUE);
}
Expand Down
2 changes: 1 addition & 1 deletion CRM/Contribute/BAO/ContributionRecur.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ public static function getPaymentProcessorID($recurID) {
'id' => $recurID,
'return' => ['payment_processor_id'],
]);
return (int) CRM_Utils_Array::value('payment_processor_id', $recur, 0);
return (int) ($recur['payment_processor_id'] ?? 0);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion CRM/Core/BAO/Block.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ public static function handlePrimary(&$params, $class) {
}

// contact_id in params might be empty or the string 'null' so cast to integer
$contactId = (int) CRM_Utils_Array::value('contact_id', $params);
$contactId = (int) ($params['contact_id'] ?? 0);
// If id is set & we haven't been passed a contact_id, retrieve it
if (!empty($params['id']) && !isset($params['contact_id'])) {
$entity = new $class();
Expand Down
2 changes: 1 addition & 1 deletion CRM/Core/BAO/Dashboard.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ public static function addContactDashletToDashboard(&$params) {
foreach ($params as $dashboardIDs) {
$contactID = CRM_Utils_Array::value('contact_id', $dashboardIDs);
$dashboardID = CRM_Utils_Array::value('dashboard_id', $dashboardIDs);
$column = CRM_Utils_Array::value('column_no', $dashboardIDs, 0);
$column = $dashboardIDs['column_no'] ?? 0;
$columns[$column][$dashboardID] = 0;
}
self::saveDashletChanges($columns, $contactID);
Expand Down
1 change: 0 additions & 1 deletion CRM/Core/Menu.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,6 @@ public static function buildAdminLinks(&$menu) {
$values[$item['adminGroup']] = array();
$values[$item['adminGroup']]['fields'] = array();
}
$weight = CRM_Utils_Array::value('weight', $item, 0);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This variable was unused.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed

$values[$item['adminGroup']]['fields']["{weight}.{$item['title']}"] = $value;
$values[$item['adminGroup']]['component_id'] = $item['component_id'];
}
Expand Down
5 changes: 1 addition & 4 deletions CRM/Core/Smarty/plugins/function.crmKey.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,5 @@
* the generated key
*/
function smarty_function_crmKey($params, &$smarty) {
return CRM_Core_Key::get(
$params['name'],
CRM_Utils_Array::value('addSequence', $params, 0)
);
return CRM_Core_Key::get($params['name'], $params['addSequence'] ?? FALSE);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is better because CRM_Core_Key::get() expects a boolean not an int.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree

}
2 changes: 1 addition & 1 deletion CRM/Event/Form/Participant.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ public function preProcess() {

// when custom data is included in this page
if (!empty($_POST['hidden_custom'])) {
$eventId = (int) CRM_Utils_Array::value('event_id', $_POST);
$eventId = (int) ($_POST['event_id'] ?? 0);
// Custom data of type participant role
// Note: Some earlier commits imply $_POST['role_id'] could be a comma separated string,
// not sure if that ever really happens
Expand Down
2 changes: 1 addition & 1 deletion CRM/Utils/Chart.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ public static function chart($rows, $chart, $interval) {
}

// rotate the x labels.
$chartData['xLabelAngle'] = CRM_Utils_Array::value('xLabelAngle', $rows, 0);
$chartData['xLabelAngle'] = $rows['xLabelAngle'] ?? 0;
if (!empty($rows['tip'])) {
$chartData['tip'] = $rows['tip'];
}
Expand Down
2 changes: 1 addition & 1 deletion api/v3/Contact.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -858,7 +858,7 @@ function civicrm_api3_contact_getquick($params) {
}
$actualSelectElements = implode(', ', $actualSelectElements);
$from = implode(' ', $from);
$limit = (int) CRM_Utils_Array::value('limit', $params);
$limit = (int) ($params['limit'] ?? 0);
$limit = $limit > 0 ? $limit : Civi::settings()->get('search_autocomplete_count');

// add acl clause here
Expand Down
2 changes: 1 addition & 1 deletion api/v3/DashboardContact.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ function _civicrm_api3_dashboard_contact_create_spec(&$params) {
function _civicrm_api3_dashboard_contact_check_params(&$params) {
$dashboard_id = CRM_Utils_Array::value('dashboard_id', $params);
if ($dashboard_id) {
$allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, CRM_Utils_Array::value('check_permissions', $params, 0));
$allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, $params['check_permissions'] ?? FALSE);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better because CRM_Core_BAO_Dashboard::getDashlets() expects a boolean not an int.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed

if (!isset($allDashlets[$dashboard_id])) {
return civicrm_api3_create_error('Invalid or inaccessible dashboard ID');
}
Expand Down
2 changes: 1 addition & 1 deletion api/v3/Job.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ function civicrm_api3_job_group_rebuild($params) {
throw new API_Exception('Could not acquire lock, another GroupRebuild process is running');
}

$limit = CRM_Utils_Array::value('limit', $params, 0);
$limit = $params['limit'] ?? 0;

CRM_Contact_BAO_GroupContactCache::loadAll(NULL, $limit);
$lock->release();
Expand Down
22 changes: 8 additions & 14 deletions api/v3/utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -776,25 +776,21 @@ function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
function _civicrm_api3_get_options_from_params($params, $queryObject = FALSE, $entity = '', $action = '') {
$lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity);
$is_count = FALSE;
$sort = CRM_Utils_Array::value('sort', $params, 0);
$sort = CRM_Utils_Array::value('option.sort', $params, $sort);
$sort = CRM_Utils_Array::value('option_sort', $params, $sort);

$offset = CRM_Utils_Array::value('offset', $params, 0);
$offset = CRM_Utils_Array::value('option.offset', $params, $offset);
// dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
$offset = CRM_Utils_Array::value('option_offset', $params, $offset);
$sort = $params['option_sort'] ?? $params['option.sort'] ?? $params['sort'] ?? 0;
$offset = $params['option_offset'] ?? $params['option.offset'] ?? $params['offset'] ?? 0;

$limit = CRM_Utils_Array::value('rowCount', $params, 25);
$limit = CRM_Utils_Array::value('option.limit', $params, $limit);
$limit = CRM_Utils_Array::value('option_limit', $params, $limit);

if (is_array(CRM_Utils_Array::value('options', $params))) {
if (isset($params['options']) && is_array($params['options'])) {
// is count is set by generic getcount not user
$is_count = CRM_Utils_Array::value('is_count', $params['options']);
$offset = CRM_Utils_Array::value('offset', $params['options'], $offset);
$limit = CRM_Utils_Array::value('limit', $params['options'], $limit);
$sort = CRM_Utils_Array::value('sort', $params['options'], $sort);
$is_count = $params['options']['is_count'] ?? FALSE;
$offset = $params['options']['offset'] ?? $offset;
$limit = CRM_Utils_Array::value('limit', $params['options'], $limit);
$sort = $params['options']['sort'] ?? $sort;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left $limit alone here b/c there are more edge cases around a non-falsey default of 25. But defaulting to 0 is pretty simple with coalesce.

}

$returnProperties = [];
Expand Down Expand Up @@ -869,9 +865,7 @@ function _civicrm_api3_get_options_from_params($params, $queryObject = FALSE, $e
elseif ($n === 'id') {
$inputParams[$lowercase_entity . '_id'] = $v;
}
elseif (in_array($n, $otherVars)) {
}
else {
elseif (!in_array($n, $otherVars)) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was silly.

$inputParams[$n] = $v;
if ($v && !is_array($v) && stristr($v, 'SELECT')) {
throw new API_Exception('invalid string');
Expand Down
2 changes: 1 addition & 1 deletion tests/phpunit/api/v3/MembershipTypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ public function testEnableMembershipTypeOnContributionPage() {
$membetype = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($type);
$fieldParams['option_id'] = [1 => $priceFieldValue['id']];
$fieldParams['option_label'][$rowCount] = CRM_Utils_Array::value('name', $membetype);
$fieldParams['option_amount'][$rowCount] = CRM_Utils_Array::value('minimum_fee', $membetype, 0);
$fieldParams['option_amount'][$rowCount] = $membetype['minimum_fee'] ?? 0;
$fieldParams['option_weight'][$rowCount] = CRM_Utils_Array::value('weight', $membetype);
$fieldParams['option_description'][$rowCount] = CRM_Utils_Array::value('description', $membetype);
$fieldParams['option_financial_type_id'][$rowCount] = CRM_Utils_Array::value('financial_type_id', $membetype);
Expand Down