PHPackages systopia/de.systopia.remotetools - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. systopia/de.systopia.remotetools ActiveCivicrm-ext[Utility & Helpers](/categories/utility) systopia/de.systopia.remotetools ================================ Toolbox to integrate CiviCRM with remote systems 1.2.0(2mo ago)0602[6 issues](https://github.com/systopia/de.systopia.remotetools/issues)2AGPL-3.0-or-laterPHPPHP ^8.1CI passing Since Feb 28Pushed 1mo ago3 watchersCompare [ Source](https://github.com/systopia/de.systopia.remotetools)[ Packagist](https://packagist.org/packages/systopia/de.systopia.remotetools)[ RSS](/packages/systopia-desystopiaremotetools/feed)WikiDiscussions master Synced 1w ago READMEChangelog (10)Dependencies (11)Versions (15)Used By (2) SYSTOPIA's Remote Tools ======================= [](#systopias-remote-tools) This extension is meant to be a toolbox for integrating CiviCRM with other (potentially) remote systems. An example for this could be your website, and/or another database. Features -------- [](#features) - Create a secure link between a remote system's user (e.g. Drupal user) and a CivCRM contact. - Generate and validate customized/personalized secure tokens. - Get, create, update, and delete entities via a special remote API with user based permission check. - Forms with validation for create and update. - Different implementations for the same entity using profiles. - Remote entity fields can differ from the actual entity fields. Requirements ------------ [](#requirements) - PHP 8.1+ - CiviCRM 5.57+ Installation ------------ [](#installation) - Install the dependent extensions listed in `info.xml`: - [de.systopia.identitytracker](https://github.com/systopia/de.systopia.identitytracker) - [de.systopia.xcm](https://github.com/systopia/de.systopia.xcm) - Add the extension folder to your CiviCRM `ext` directory. - If your project uses composer: Add the requirements listed in `composer.json` to your composer project: - [symfony/html-sanitizer](https://github.com/symfony/html-sanitizer) - [systopia/expression-language-ext](https://github.com/systopia/expression-language-ext) - [systopia/opis-json-schema-ext](https://github.com/systopia/opis-json-schema-ext) - [webmozart/assert](https://github.com/webmozarts/assert) - Otherwise: Run `composer update` inside the `de.systopia.remotetools` folder. - Enable the extension. (Either via UI or `cv ext:enable de.systopia.remotetools`) For the frontend part you can use the [CiviRemote Drupal module](https://github.com/systopia/civiremote). Usage ----- [](#usage) You can use this extension via other extensions that rely on Remote Tools: - [Remote Events Extension](https://github.com/systopia/de.systopia.remoteevent) - [Remote Activity Extension](https://github.com/systopia/de.systopia.remoteactivity) ### Providing own remote entities [](#providing-own-remote-entities) If you want to provide an own remote entity that accesses the entity `MyEntity`, you can do the following: - Create the class `\Civi\Api4\RemoteMyEntity` (name can be freely chosen) that extends [`Civi\RemoteTools\Api4\AbstractRemoteEntity`](Civi/RemoteTools/Api4/AbstractRemoteEntity.php). - Implement the method `permissions()` to restrict access to your remote API user. (See [CiviCRM documentation](https://docs.civicrm.org/dev/en/latest/security/permissions/#apiv4).) - Create a class that extends [`\Civi\RemoteTools\EntityProfile\AbstractRemoteEntityProfile`](Civi/RemoteTools/EntityProfile/AbstractRemoteEntityProfile.php). (For read only entities use [`\Civi\RemoteTools\EntityProfile\AbstractReadOnlyRemoteEntityProfile`](Civi/RemoteTools/EntityProfile/AbstractReadOnlyRemoteEntityProfile.php) instead.) The various methods are documented in [`\Civi\RemoteTools\EntityProfile\RemoteEntityProfileInterface`](Civi/RemoteTools/EntityProfile/RemoteEntityProfileInterface.php). - Add the public constants `NAME` (set to e.g. `my-profile`, `default`, or also an empty string), `ENTITY_NAME` (set to `MyEntity`), `REMOTE_ENTITY_NAME` (set to `RemoteMyEntity`). - Use the trait [`\Civi\RemoteTools\EntityProfile\Traits\ConstProfileMetadataTrait`](Civi/RemoteTools/EntityProfile/Traits/ConstProfileMetadataTrait.php). - Register the class as service in the service container via [`hook_civicrm_container`](https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_container/) like this: ``` $container->autowire(MyRemoteEntityProfile::class) ->addTag(MyRemoteEntityProfile::SERVICE_TAG); ``` Now you should be able to access data via APIv4, e.g. ``` civicrm_api4('RemoteMyEntity', 'get', ['profile' => 'my-profile']); ``` (Use the APIv4 explorer to test.) Most methods in the profile class have a parameter named `$contactId`. This contains the remote contact ID resolved to a CiviCRM contact ID or `NULL` if no remote contact ID was given. If a given remote contact ID could not be resolved, access is denied. The resolving is done using the extension [de.systopia.identitytracker](https://github.com/systopia/de.systopia.identitytracker). You can find more information in the PHPDoc of the various classes, interfaces, and methods. All elements that can be safely used by third parties are marked with `@api`. Their behavior will be stable within minor updates. Breaking changes may only happen in major updates (semantic versioning). If a class or interface is marked with `@api` then this applies to all methods within it. If you'd like to use code that is not labeled as API, yet, please open an issue, so we can consider to add it to the API. Additionally, interfaces marked with `@apiService`, have a corresponding service in the DI container that can be safely used by third parties. Though in contrast to `@api` those interfaces should not be implemented. Services are private by default. If you need a service of this extension as public service, just make a public alias. #### Forms [](#forms) Forms for creation and update are specified in a [`\Civi\RemoteTools\Form\FormSpec\FormSpec`](Civi/RemoteTools/Form/FormSpec/FormSpec.php). This specification will be converted to [JSON Forms](https://jsonforms.io/). (Different output would be possible with a custom action handler.) The Drupal module [civiremote\_entity](https://github.com/systopia/civiremote) provides the corresponding part that accesses the remote entity API and renders the forms as Drupal forms. #### Contact Search Forms [](#contact-search-forms) Custom forms for contact searches can be inherited from class [CRM\_Remotetools\_RemoteContactProfile](CRM/Remotetools/RemoteContactProfile.php). Your profile class needs to implement the following methods: - `getProfileID()` - return the profile id, ie. `'my-profile'` - `getProfileName()` - return the human readable form of the profile id, .ie `'This is my profile'` - `getReturnFields()` - return an array of names for those fields that are part of the custom search form - `addFields($fields_collection)` - provides a type specification for those fields that are part of the custom search form - call `$fields_collection->setFieldSpec(...)` for specifying each field - field names should match the names that are being returned by `getReturnFields()` In addition, take a look and implement the following methods: - `applyRestrictions()` - restrict the custom search query - explore possible request parameters in api explorer - ie. `contact_type`, `limit`, `return` `sequential` - `filterResult()` - apply customization to the result of a search query - `isOwnDataProfile` - see method comments and either return `true` or `false` ##### Field specification [](#field-specification) **Define a field that holds array data** Such a field specification is of type `T_ENUM` and needs an `options` field in the data passed on to `setFieldSpec()` in `addFields()`: ``` $fields_collection->setFieldSpec( 'a_list', [ 'name' => 'a_list' 'type' => CRM_Utils_Type::T_ENUM, 'options': ["dummy"] ] ); ``` The `options` field is manadatory if data is supposed to be rendered in a Drupal View. Otherwise the settings menu of the field in the corresponding Drupal View won't show the menu entry *Multiple field settings*. The `options` field must at least hold a single array entry. an empty array is not sufficient. The option name can be arbitrary as the options are not used any further by the Drupal View. In order to show the array entries for that field in a Drupal View as a simple list without bullets or indices, do: - open the *Multiple field settings* of the field in the Drupal View - select *Simple Separator* as *Display type* - as *Separator* insert the html linebreak tag `` License ======= [](#license) The extension is licensed under [AGPL-3.0](LICENSE.txt). ### Health Score 47 — FairBetter than 93% of packages Maintenance90 Actively maintained with recent releases Popularity14 Limited adoption so far Community22 Small or concentrated contributor base Maturity58 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~66 days Recently: every ~41 days Total 13 Last Release 34d ago Major Versions 0.13.0 → 1.0.02025-08-01 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/5405481?v=4)[dontub](/maintainers/dontub)[@dontub](https://github.com/dontub) --- Top Contributors [![dontub](https://avatars.githubusercontent.com/u/5405481?v=4)](https://github.com/dontub "dontub (79 commits)")[![bjendres](https://avatars.githubusercontent.com/u/3448869?v=4)](https://github.com/bjendres "bjendres (58 commits)")[![jensschuppe](https://avatars.githubusercontent.com/u/29565644?v=4)](https://github.com/jensschuppe "jensschuppe (29 commits)")[![cowonacid](https://avatars.githubusercontent.com/u/9861586?v=4)](https://github.com/cowonacid "cowonacid (20 commits)")[![abugey](https://avatars.githubusercontent.com/u/74647508?v=4)](https://github.com/abugey "abugey (2 commits)")[![BrutalBirdie](https://avatars.githubusercontent.com/u/20840012?v=4)](https://github.com/BrutalBirdie "BrutalBirdie (1 commits)")[![jofranz](https://avatars.githubusercontent.com/u/12087462?v=4)](https://github.com/jofranz "jofranz (1 commits)")[![peth-systopia](https://avatars.githubusercontent.com/u/8555920?v=4)](https://github.com/peth-systopia "peth-systopia (1 commits)")[![svenow](https://avatars.githubusercontent.com/u/161302781?v=4)](https://github.com/svenow "svenow (1 commits)") ### Embed Badge ![Health badge](/badges/systopia-desystopiaremotetools/health.svg) ``` [![Health](https://phpackages.com/badges/systopia-desystopiaremotetools/health.svg)](https://phpackages.com/packages/systopia-desystopiaremotetools) ``` ### Alternatives [sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.4M195](/packages/sulu-sulu)[pimcore/pimcore Content & Product Management Framework (CMS/PIM/E-Commerce) 3.8k3.8M444](/packages/pimcore-pimcore)[symplify/monorepo-builder Not only Composer tools to build a Monorepo. 5235.7M110](/packages/symplify-monorepo-builder)[phpdocumentor/reflection Reflection library to do Static Analysis for PHP Projects 12624.8M137](/packages/phpdocumentor-reflection)[contao/core-bundle Contao Open Source CMS 1231.6M2.6k](/packages/contao-core-bundle)[open-dxp/opendxp Content & Product Management Framework (CMS/PIM) 9017.2k55](/packages/open-dxp-opendxp) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)