[civicrm-core.git] / ext / afform / docs / crud.md

## Development: Form CRUD API

Now that we've defined a baseline form, it's possible for administrators and
GUI applications to inspect the form using the API:

```
$ cv api afform.getsingle name=helloworld
{
    "name": "helloworld",
    "requires": [
        "afformCore"
    ],
    "title": "",
    "description": "",
    "layout": {
        "#tag": "div",
        "#children": [
            "Hello {{routeParams.name}}"
        ]
    },
    "id": "helloworld"
}
```

Additionally, you can also update the forms:

```
$ cv api afform.create name=helloworld title="The Foo Bar Screen"
{
    "is_error": 0,
    "version": 3,
    "count": 2,
    "values": {
        "name": "helloworld",
        "title": "The Foo Bar Screen"
    }
}
```

A few important things to note about this:

* The changes made through the API are only applied on this site.
* Once you make a change with the CRUD API, there will be two copies of the form:
    * `[myextension]/afform/helloworld/` is the default, canonical version.
    * `[civicrm.files]/afform/helloworld/` is the local, custom version.
* The `layout` field is stored as an Angular-style HTML document (`layout.html`), so you can edit it on disk like
  normal Angular code. However, when CRUD'ing the `layout` through the API, it is presented in JSON-style.
Commit	Line	Data
8a0ffdf9 TO	1	## Development: Form CRUD API
	2
	3	Now that we've defined a baseline form, it's possible for administrators and
	4	GUI applications to inspect the form using the API:
	5
	6	```
	7	$ cv api afform.getsingle name=helloworld
	8	{
	9	"name": "helloworld",
	10	"requires": [
	11	"afformCore"
	12	],
	13	"title": "",
	14	"description": "",
	15	"layout": {
	16	"#tag": "div",
	17	"#children": [
	18	"Hello {{routeParams.name}}"
	19	]
	20	},
	21	"id": "helloworld"
	22	}
	23	```
	24
	25	Additionally, you can also update the forms:
	26
	27	```
	28	$ cv api afform.create name=helloworld title="The Foo Bar Screen"
	29	{
	30	"is_error": 0,
	31	"version": 3,
	32	"count": 2,
	33	"values": {
	34	"name": "helloworld",
	35	"title": "The Foo Bar Screen"
	36	}
	37	}
	38	```
	39
	40	A few important things to note about this:
	41
	42	* The changes made through the API are only applied on this site.
	43	* Once you make a change with the CRUD API, there will be two copies of the form:
	44	* `[myextension]/afform/helloworld/` is the default, canonical version.
	45	* `[civicrm.files]/afform/helloworld/` is the local, custom version.
	46	* The `layout` field is stored as an Angular-style HTML document (`layout.html`), so you can edit it on disk like
	47	normal Angular code. However, when CRUD'ing the `layout` through the API, it is presented in JSON-style.