Skip to content
Snippets Groups Projects
Commit 0e4a83c9 authored by Sean Madsen's avatar Sean Madsen
Browse files

civix entity - clarify civibuild needs

Two recent SE questions have made me think that readers are missing this
key set of installing CiviCRM with civibuild (instead of with the normal
installation steps). I've added clarification here which I hope will
prevent future users from stumbling on this step.

ref:

https://civicrm.stackexchange.com/questions/19294/how-to-create-entity-in-civicrm
https://civicrm.stackexchange.com/questions/19194/unable-to-locate-folder-xml-under-the-civicrm-root-directory
parent 671ab913
No related branches found
No related tags found
No related merge requests found
......@@ -195,7 +195,14 @@ to create a new entity. For this, you can use the command `civix generate:entity
1. Generate a [DAO file](/core/architecture.md#dao) and SQL to create your table. *(For now, civix does not handle this part. Hopefully these steps will become easier at some point in the future.)*
1. Begin with a development installation of CiviCRM core (e.g. as installed with buildkit) which has a clean git status. We will henceforth refer to the CiviCRM root directory within this installation as `<civiroot>`. This core installation can actually be any installation, not necessarily the one you're using to develop your extension. We're basically just temporarily hijacking its environment to generate DAO and SQL.
1. Begin with a *development* installation of CiviCRM core.
!!! caution
A "development installation" is not a normal installation. To obtain a *development* installation, you must install CiviCRM with the [`civibuild` command](/tools/civibuild.md) included within [buildkit](/tools/buildkit.md).
* Ensure that this CiviCRM installation has a clean git status.
* We will henceforth refer to the CiviCRM root directory within this installation as `<civiroot>`.
* This core installation can actually be any installation, not necessarily the one you're using to develop your extension. We're basically just temporarily hijacking its environment to generate DAO and SQL.
1. Copy your custom XML schema file (e.g. `MyEntity.xml`) into `<civiroot>/xml/schema/`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment