Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Developer Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
brienne
Developer Documentation
Commits
bbf347bb
Commit
bbf347bb
authored
8 years ago
by
Sean Madsen
Browse files
Options
Downloads
Patches
Plain Diff
civix - misc small clean up
parent
6680395a
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/extensions/civix.md
+10
-10
10 additions, 10 deletions
docs/extensions/civix.md
with
10 additions
and
10 deletions
docs/extensions/civix.md
+
10
−
10
View file @
bbf347bb
...
...
@@ -3,7 +3,7 @@
!!! caution "Notice: page undergoing migration"
This page started
[
here in the wiki
](
https://wiki.civicrm.org/confluence/display/CRMDOC/Create+a+Module+Extension
)
.
We have not yet transferred all of the script snipets, so you may wish to
We have not yet transferred all of the script snip
p
ets, so you may wish to
peruse this page as well.
## Introduction
...
...
@@ -56,7 +56,7 @@ civix generate:module com.example.myextension --license=AGPL-3.0
This command will report that it has created three files, following the
[
standard extension structure
](
/extensions/files
)
.
The command attempts to autodetect authorship information (your name and
The command attempts to auto
-
detect authorship information (your name and
email address) by reading your
[
`git`
](
https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup
)
configuration. If this fails or is
...
...
@@ -172,7 +172,7 @@ This creates three files:
[
the smarty guide
](
http://www.smarty.net/docsv2/en/
)
.
The auto-generated code for the controller and view demonstrate a few
basic operations, such as adding a <SELECT
\>
element to the form.
basic operations, such as adding a
`
<SELECT\>
`
element to the form.
!!! note
After adding or modifying a route in the XML file, you must reset
...
...
@@ -188,7 +188,7 @@ comment out the various upgrade and uninstall functions
to make it work. Generally your install script belongs in an
`sql/`
folder
in the root of your extension with a name like 'install'
This
`civix`
command does not require argu
e
ments:
This
`civix`
command does not require arguments:
```
bash
civix generate:upgrader
...
...
@@ -241,7 +241,7 @@ command:
civix
help
generate:case-type
```
This reports that civix expects a
<Label>
argu
r
ment and an optional name:
This reports that civix expects a
`
<Label>
`
argument and an optional name:
```
bash
civix generate:case-type
"Volunteer Training"
Training
...
...
@@ -263,7 +263,7 @@ Your extension can create one or more sets of custom
fields at installation. There are two
methods depending on whether the custom data set extends an entity
(e.g. "Individual" – without any specific subtype)
or exends a specific subtype of an entity.
or ex
t
ends a specific subtype of an entity.
(e.g. Activities of type 'Volunteer')
#### Extending a base entity
...
...
@@ -274,7 +274,7 @@ them for use with the extension:
!!! note
Before you begin verify that civix is connected to your instance of
f
CiviCRM by running
`civix civicrm:ping`
.
CiviCRM by running
`civix civicrm:ping`
.
-
On your development instance of CiviCRM, create the new custom
fields using the web interface. Note the unique ID of the custom data
...
...
@@ -303,7 +303,7 @@ Most of the [CiviHR](https://github.com/civicrm/civihr/tree/master) modules rely
#### Extending an subtype
<!-- This section still is not really clear to me.
<!-- This section still is not really clear to me.
(Erich Schulz)
Is this really about sub-types in an OO sense?? or subtypes in as a base
entity of a particular type as defined by its properties?
-->
...
...
@@ -393,7 +393,7 @@ CiviReport enables developers to define new business reports using
customizable SQL logic and form layouts.
If another existing report is close to your needs you may copy and modify it.
To to see the available report generation options ac
i
tivate the
`civix`
help:
To to see the available report generation options activate the
`civix`
help:
```
bash
civix generate:report
--help
...
...
@@ -551,7 +551,7 @@ CiviCRM. For this, you can use the command `civix generate:entity`
`php ./GenCode.php`
(In CiviCRM 4.7.12+, run
`<civiroot>/bin/setup.sh -g`
instead). This will generate a DAO file
for you in the CiviCRM core code; copy it into the
CRM/<Entityname
\
>
/DAO folder of your extension.
`
CRM/<Entityname>/DAO
`
folder of your extension.
-
Currently,
`civix`
does not generate the SQL to create and
drop your table(s). You can create these by hand, or, if
you used the
`<civiroot>/bin/setup.sh -g`
technique to create your
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment