CRM: Fix companies API endpoint param mapping

projects/plugins/crm/.phan/baseline.php

@@ -102,7 +102,6 @@
     // PhanUnextractableAnnotation : 2 occurrences
     // PhanImpossibleTypeComparisonInLoop : 1 occurrence
     // PhanNoopVariable : 1 occurrence
-    // PhanParamTooMany : 1 occurrence
     // PhanPluginDuplicateArrayKey : 1 occurrence
     // PhanPluginDuplicateCatchStatementBody : 1 occurrence
     // PhanPluginUseReturnValueInternalKnown : 1 occurrence
@@ -162,7 +161,7 @@
         'admin/system/partials/title.block.php' => ['PhanUndeclaredGlobalVariable'],
         'admin/system/system-status.page.php' => ['PhanRedundantCondition', 'PhanTypePossiblyInvalidDimOffset'],
         'admin/tags/tag-manager.page.php' => ['PhanTypeMismatchArgument'],
-        'api/companies.php' => ['PhanParamTooMany', 'PhanPluginSimplifyExpressionBool'],
+        'api/companies.php' => ['PhanPluginSimplifyExpressionBool'],
         'api/create_company.php' => ['PhanImpossibleTypeComparisonInGlobalScope', 'PhanPossiblyUndeclaredGlobalVariable', 'PhanRedundantConditionInGlobalScope'],
         'api/create_customer.php' => ['PhanImpossibleTypeComparisonInGlobalScope', 'PhanPossiblyUndeclaredGlobalVariable', 'PhanRedundantConditionInGlobalScope', 'PhanTypePossiblyInvalidDimOffset'],
         'api/create_event.php' => ['PhanImpossibleTypeComparisonInGlobalScope'],

projects/plugins/crm/api/companies.php

@@ -1,26 +1,19 @@
 <?php
-/*
-!
+/**
  * Jetpack CRM
  * https://jetpackcrm.com
  * V3.0
  *
  * Copyright 2020 Automattic
  *
  * Date: 04/06/2019
+ *
+ * @package automattic/jetpack-crm
  */
 
-/*
-======================================================
-	Breaking Checks ( stops direct access )
-	====================================================== */
 if ( ! defined( 'ZEROBSCRM_PATH' ) ) {
 	exit( 0 );
 }
-/*
-======================================================
-	/ Breaking Checks
-	====================================================== */
 
 // Check the method
 // Ultimately this should be switched to GET, but the docs have it as POST, so best to wait for a rewrite
@@ -29,44 +22,53 @@
 $json_params    = file_get_contents( 'php://input' );
 $company_params = json_decode( $json_params, true );
 
-$perPage = 10;
+$items_per_page = 10;
 if ( isset( $company_params['perpage'] ) ) {
-	$perPage = sanitize_text_field( $company_params['perpage'] );
+	$items_per_page = sanitize_text_field( $company_params['perpage'] );
 }
-$page = 0;
+$page_num = 0;
 if ( isset( $company_params['page'] ) ) {
-	$page = sanitize_text_field( $company_params['page'] );
+	$page_num = sanitize_text_field( $company_params['page'] );
 }
-$withInvoices = -1;
+$with_invoices = -1;
 if ( isset( $company_params['invoices'] ) ) {
-	$withInvoices = sanitize_text_field( $company_params['invoices'] );
+	$with_invoices = sanitize_text_field( $company_params['invoices'] );
 }
-$withQuotes = -1;
+$with_quotes = -1;
 if ( isset( $company_params['quotes'] ) ) {
-	$withQuotes = sanitize_text_field( $company_params['quotes'] );
-}
-$searchPhrase = '';
-if ( isset( $company_params['search'] ) ) {
-	$searchPhrase = sanitize_text_field( $company_params['search'] );
+	$with_quotes = sanitize_text_field( $company_params['quotes'] );
 }
-$withTransactions = -1;
+$with_transactions = -1;
 if ( isset( $company_params['transactions'] ) ) {
-	$withTransactions = sanitize_text_field( $company_params['transactions'] );
+	$with_transactions = sanitize_text_field( $company_params['transactions'] );
 }
-$isOwned = -1;
+$search_phrase = '';
+if ( isset( $company_params['search'] ) ) {
+	$search_phrase = sanitize_text_field( $company_params['search'] );
+}
+$owned_by = -1;
 if ( isset( $company_params['owned'] ) ) {
-	$isOwned = (int) $company_params['owned'];
+	$owned_by = (int) $company_params['owned'];
 }
 
-// #FORMIKENOTES -
-// These should be Bools - see https://stackoverflow.com/questions/7336861/how-to-convert-string-to-boolean-php
 // ... this forces them from string of "true" or "false" into a bool
-$withInvoices     = $withInvoices === 'true' ? true : false;
-$withQuotes       = $withQuotes === 'true' ? true : false;
-$withTransactions = $withTransactions === 'true' ? true : false;
-$isAssigned       = false; // ??
+$with_invoices     = $with_invoices === 'true' ? true : false;
+$with_quotes       = $with_quotes === 'true' ? true : false;
+$with_transactions = $with_transactions === 'true' ? true : false;
+
+$args = array(
+	'perPage'          => $items_per_page,
+	'page'             => $page_num,
+	'searchPhrase'     => $search_phrase,
+	'ownedBy'          => $owned_by,
+	'withQuotes'       => $with_quotes,
+	'withInvoices'     => $with_invoices,
+	'withTransactions' => $with_transactions,
+	'sortByField'      => 'ID',
+	'sortOrder'        => 'DESC',
+);
 
-// needs moving to the $args version
-$companies = zeroBS_getCompanies( true, $perPage, $page, $withInvoices, $withQuotes, $searchPhrase, $withTransactions, false, false, '', '', false, false, false, 'ID', 'DESC', false, $isAssigned );
+global $zbs;
+$companies = $zbs->DAL->companies->getCompanies( $args ); // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable,WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
 
 wp_send_json( $companies );

projects/plugins/crm/changelog/fix-crm-company_api_endpoint_params

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fixed
+
+API: Fix `companies` endpoint param mapping.

tools/phpcs-excludelist.json

@@ -62,7 +62,6 @@
 	"projects/plugins/crm/admin/user-profile/main.page.php",
 	"projects/plugins/crm/admin/user-profile/reminders.page.php",
 	"projects/plugins/crm/admin/user-profile/user-profile.page.php",
-	"projects/plugins/crm/api/companies.php",
 	"projects/plugins/crm/api/create_company.php",
 	"projects/plugins/crm/api/create_customer.php",
 	"projects/plugins/crm/api/create_event.php",