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

3
4
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
5
6
7

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

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

jaapjansma's avatar
jaapjansma committed
10
11
12
## Requirements

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

## 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>
jaapjansma's avatar
jaapjansma committed
26
cv dl action-provider@https://lab.civicrm.org/extensions/action-provider/repository/master/archive.zip
jaapjansma's avatar
jaapjansma committed
27
28
29
30
31
32
33
34
```

## 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
jaapjansma's avatar
jaapjansma committed
35
git clone https://lab.civicrm.org/extensions/action-provider.git
jaapjansma's avatar
jaapjansma committed
36
37
38
cv en action_provider
```

jaapjansma's avatar
jaapjansma committed
39
40
41
42
43
## Developer documentation

* [How to create an action](docs/howto_create_an_action.md)
* How to use the action provider in your extension (not yet written)
* How to use the batch functionality in your extension (not yet written)
jaapjansma's avatar
jaapjansma committed
44

jaapjansma's avatar
jaapjansma committed
45
46

## Roadmap