-
-
Notifications
You must be signed in to change notification settings - Fork 825
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix dev/core#4104 - APIv4 autocomplete for contributions
- Loading branch information
Showing
1 changed file
with
83 additions
and
0 deletions.
There are no files selected for viewing
83 changes: 83 additions & 0 deletions
83
Civi/Api4/Service/Autocomplete/ContributionAutocompleteProvider.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
<?php | ||
|
||
/* | ||
+--------------------------------------------------------------------+ | ||
| Copyright CiviCRM LLC. All rights reserved. | | ||
| | | ||
| This work is published under the GNU AGPLv3 license with some | | ||
| permitted exceptions and without any warranty. For full license | | ||
| and copyright information, see https://civicrm.org/licensing | | ||
+--------------------------------------------------------------------+ | ||
*/ | ||
|
||
namespace Civi\Api4\Service\Autocomplete; | ||
|
||
use Civi\Core\Event\GenericHookEvent; | ||
use Civi\Core\HookInterface; | ||
|
||
/** | ||
* @service | ||
* @internal | ||
*/ | ||
class ContributionAutocompleteProvider extends \Civi\Core\Service\AutoService implements HookInterface { | ||
|
||
/** | ||
* Provide default SavedSearch for Contribution autocompletes | ||
* | ||
* @param \Civi\Core\Event\GenericHookEvent $e | ||
*/ | ||
public static function on_civi_search_autocompleteDefault(GenericHookEvent $e) { | ||
if (!is_array($e->savedSearch) || $e->savedSearch['api_entity'] !== 'Contribution') { | ||
return; | ||
} | ||
$e->savedSearch['api_params'] = [ | ||
'version' => 4, | ||
'select' => [ | ||
'id', | ||
'contact_id.display_name', | ||
'total_amount', | ||
'receive_date', | ||
'financial_type_id:label', | ||
], | ||
'orderBy' => [], | ||
'where' => [], | ||
'groupBy' => [], | ||
'join' => [], | ||
'having' => [], | ||
]; | ||
} | ||
|
||
/** | ||
* Provide default SearchDisplay for Contribution autocompletes | ||
* | ||
* @param \Civi\Core\Event\GenericHookEvent $e | ||
*/ | ||
public static function on_civi_search_defaultDisplay(GenericHookEvent $e) { | ||
if ($e->display['settings'] || $e->display['type'] !== 'autocomplete' || $e->savedSearch['api_entity'] !== 'Contribution') { | ||
return; | ||
} | ||
$e->display['settings'] = [ | ||
'sort' => [ | ||
['contact_id.sort_name', 'ASC'], | ||
['total_amount', 'ASC'], | ||
['receive_date', 'DESC'], | ||
], | ||
'columns' => [ | ||
[ | ||
'type' => 'field', | ||
'key' => 'contact_id.display_name', | ||
'rewrite' => '[contact_id.display_name] - [total_amount]', | ||
], | ||
[ | ||
'type' => 'field', | ||
'key' => 'financial_type_id:label', | ||
], | ||
[ | ||
'type' => 'field', | ||
'key' => 'receive_date', | ||
], | ||
], | ||
]; | ||
} | ||
|
||
} |