Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colorfield/civicrm_tools
CiviCRM API wrapper and helpers for Drupal 8
https://github.com/colorfield/civicrm_tools
civicrm civicrm-api-wrapper drupal drupal-8
Last synced: about 1 month ago
JSON representation
CiviCRM API wrapper and helpers for Drupal 8
- Host: GitHub
- URL: https://github.com/colorfield/civicrm_tools
- Owner: colorfield
- Created: 2018-04-23T15:26:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-12T08:13:45.000Z (over 4 years ago)
- Last Synced: 2024-11-08T01:12:19.132Z (3 months ago)
- Topics: civicrm, civicrm-api-wrapper, drupal, drupal-8
- Language: PHP
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CiviCRM Tools
CiviCRM API wrapper for Drupal 8.
The wrapper is currently being extended by syntactic sugar and REST helpers.
The API code is originally extracted from the
[CiviCRM Entity](http://drupal.org/project/civicrm_entity) module.
It has started as a separation of concern and is subject to evolve by
- implementing other methods like _clone_, _getTokens_, _getSingle_, ...
- defining API version (currently v3)
- providing pagination helpers
- providing syntactic sugar over the API for complex relations
- providing default exception handlers.
## Dependencies
[CiviCRM Core](https://github.com/civicrm/civicrm-core/tree/5.6)
and [CiviCRM Drupal 8](https://github.com/civicrm/civicrm-drupal-8/tree/5.7) module.
Due to the current development of CiviCRM for Drupal, these packages are
not currently required by Composer so you have to install them manually with your
preferred setup.
Here is [one possible setup](https://colorfield.be/blog/install-civicrm-56x-drupal-86x)
that has been used during the development of this module.
## API Documentation
The API is available as a Drupal service.
```
// Prefer dependency injection.
$civiCrmApi = \Drupal::service('civicrm_tools.api');
```
### Get
```
$params = [
'email' => '[email protected]',
];
$result = $civiCrmApi->get('Contact', $params);
```
### Create
```
$params = [
'first_name' => 'Elijah',
'last_name' => 'Baley',
'contact_type' => 'Individual',
]
$result = $civiCrmApi->create('Contact', $params);
```
### Delete
```
$params = [
'id' => 42,
];
$result = $civiCrmApi->delete('Contact', $params);
```
## Syntactic sugar
Some other services are on their way.
### Contact
```
// Prefer dependency injection.
$civiCrmContact = \Drupal::service('civicrm_tools.contact');
// Smart group id and optinal parameters
$civiCrmContact->getFromSmartGroup(42, []);
$civiCrmContact->getFromGroups([1,2]);
// User id and domain id
$civiCrmContact->getFromUserId(1, 1);
// Domain id
$civiCrmContact->getFromLoggedInUser(1);
// Contact id and domain id
$civiCrmContact->getUserFromContactId(1, 1);
```
### Group
```
// Prefer dependency injection.
$civiCrmGroup = \Drupal::service('civicrm_tools.group');
// Contact id, load: get the full group array or only the group id
$civiCrmGroup->getGroupsFromContact(1, TRUE);
```
### Database
Prerequisite: add the CiviCRM database reference in your Drupal _settings.php_
```
$databases['civicrm']['default'] = array (
'database' => 'civicrm_db_name',
'username' => 'civicrm_db_user',
'password' => 'civicrm_db_password',
'prefix' => '',
'host' => '127.0.0.1',
'port' => '3306',
'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql',
'driver' => 'mysql',
);
```
Then
```
// Prefer dependency injection.
$civiCrmDatabase = \Drupal::service('civicrm_tools.database');
$query = 'SELECT * FROM {civicrm_log}';
$result = $civiCrmDatabase->execute($query);
```
Or
```
// Switch to a custom CiviCRM database.
Database::setActiveConnection('civicrm');
$db = Database::getConnection();
$query = $db->query("SELECT group_id FROM {civicrm_group_contact} WHERE contact_id = :contact_id AND status = :status", [
':contact_id' => $contact_id,
':status' => 'Added',
]);
$queryResult = $query->fetchAll();
// Switch back to the default database (Drupal).
Database::setActiveConnection();
```
## Expose CiviCRM and Drupal related entities via REST
The _CiviCRM Tools REST_ sub module aims to provide several endpoints for
CiviCRM and Drupal entities.
It could also make use of entity Normalizer, ... to provide fields for JSON API, and core REST.
Currently, the only available endpoint gets Drupal users by CiviCRM group.
Possible use cases:
- a callback for a Single Sign On application, that provides a set of permissions based on the CiviCRM Group.
- a decoupled application
- ...
### Get Drupal users by CiviCRM group
**/api/civicrm_tools/users/group/{group_id}**
Authenticate with BasicAuth.
The authenticated user needs the permission to view user profiles.
Usage
```
curl --include --request GET --user admin:admin --header 'Content-type: application/json' http://example.com/api/civicrm_tools/users/group/42
```