Documentation

CiviConnectProviders extends AutoService
in package
implements EventSubscriberInterface

OAuth providers that are tagged as `CiviConnect` should have some special behaviors, e.g.

  • Inspect the setting oauth_civi_connect_urls.
  • In the provider definition, replace {civi_connect_url} with a real URL.
  • If the settings have enabled "sandbox" or "local" options, then also use those.
Tags
service

oauth_client.civi_connect_providers

Table of Contents

Interfaces

EventSubscriberInterface

Methods

getSubscribedEvents()  : mixed
hook_civicrm_oauthProviders()  : mixed
pickDefaultPaymentInitiators()  : void
In "Edit Payment Processors", there are options for different initiators. If they have any of our tags ("CiviConnect", "CiviConnectSandbox", "CiviConnectLocal"), then use them to help pick our defaults.
filterTree()  : array<string|int, mixed>
Recursively apply a filter to all string-values in an array-tree.

Methods

pickDefaultPaymentInitiators()

In "Edit Payment Processors", there are options for different initiators. If they have any of our tags ("CiviConnect", "CiviConnectSandbox", "CiviConnectLocal"), then use them to help pick our defaults.

public pickDefaultPaymentInitiators(array<string|int, mixed> $context, array<string|int, mixed> &$available, mixed &$default) : void
  • Payment Processors have two variants -- live and testing.
  • CiviConnect providers can have two variants -- live and sandbox (and possibly local).
  • There's an affinity for live<=>live and testing<=>sandbox.
  • Or, if you've got local override, then that's generally preferred.
Parameters
$context : array<string|int, mixed>
$available : array<string|int, mixed>
$default : mixed
Tags
see
CRM_Utils_Hook::initiators()

filterTree()

Recursively apply a filter to all string-values in an array-tree.

protected filterTree(array<string|int, mixed> $array, callable $filter) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$filter : callable
Return values
array<string|int, mixed>

        
On this page

Search results