README.md 1.4 KB
Newer Older
jaapjansma's avatar
jaapjansma committed
1 2
# action-provider

3
**This extension is in an prototype stage**
jaapjansma's avatar
jaapjansma committed
4

5 6
This extension provides a base class for actions. An action is something other extensions could reuse and which is executable.
At its own this extension does not do something but it might be used by other extensions.
jaapjansma's avatar
jaapjansma committed
7 8 9

The extension is licensed under [AGPL-3.0](LICENSE.txt).

totten's avatar
totten committed
10 11
See also: [CiviCRM Form-Action-Integration Architecture](https://docs.google.com/presentation/d/1Zs6UQDXBXe4K3zV5xrt8HK2R5nxttw2sGslZ82hM9us/edit?usp=sharing)

jaapjansma's avatar
jaapjansma committed
12 13 14
## Requirements

* PHP v5.4+
15
* CiviCRM > 4.7
jaapjansma's avatar
jaapjansma committed
16 17 18 19 20 21 22 23 24 25 26 27

## Installation (Web UI)

This extension has not yet been published for installation via the web UI.

## Installation (CLI, Zip)

Sysadmins and developers may download the `.zip` file for this extension and
install it with the command-line tool [cv](https://github.com/civicrm/cv).

```bash
cd <extension-dir>
28
cv dl action-provider@https://lab.civicrm.org/jaapjansma/action-provider/repository/master/archive.zip
jaapjansma's avatar
jaapjansma committed
29 30 31 32 33 34 35 36
```

## Installation (CLI, Git)

Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
install it with the command-line tool [cv](https://github.com/civicrm/cv).

```bash
37
git clone https://lab.civicrm.org/jaapjansma/action-provider.git
jaapjansma's avatar
jaapjansma committed
38 39 40
cv en action_provider
```

41
## Roadmap
jaapjansma's avatar
jaapjansma committed
42

43 44
1. Implement an interface and implement the interface in the form-processor extension.
2. Add a set of action which could be reused to this extension