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
8ba9a626
Commit
8ba9a626
authored
8 years ago
by
Sean Madsen
Browse files
Options
Downloads
Patches
Plain Diff
civix - converting some double quotes to backticks
parent
5703b64f
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/extensions/civix.md
+12
-13
12 additions, 13 deletions
docs/extensions/civix.md
with
12 additions
and
13 deletions
docs/extensions/civix.md
+
12
−
13
View file @
8ba9a626
...
@@ -90,7 +90,7 @@ at your discretion. A few possibilities:
...
@@ -90,7 +90,7 @@ at your discretion. A few possibilities:
CiviCRM uses a typical web-MVC architecture. To implement a basic web
CiviCRM uses a typical web-MVC architecture. To implement a basic web
page, you must create a PHP controller class, create a Smarty template
page, you must create a PHP controller class, create a Smarty template
file, and create a routing rule. You can create the appropriate files by
file, and create a routing rule. You can create the appropriate files by
calling
"
civix generate:page
"
calling
`
civix generate:page
`
Once again you can review the output of this command to see the available options:
Once again you can review the output of this command to see the available options:
...
@@ -109,7 +109,7 @@ This creates three files:
...
@@ -109,7 +109,7 @@ This creates three files:
-
`xml/Menu/myextension.xml`
defines request-routing rules and
-
`xml/Menu/myextension.xml`
defines request-routing rules and
associates the controller ("CRM_Myextension_Page_Greeter") with
associates the controller ("CRM_Myextension_Page_Greeter") with
the web path
("
civicrm/my-page
")
the web path
`
civicrm/my-page
`
.
-
`CRM/Myextension/Page/MyPage.php`
is the controller which
-
`CRM/Myextension/Page/MyPage.php`
is the controller which
coordinates any parsing, validation, business-logic, or database
coordinates any parsing, validation, business-logic, or database
operations.
operations.
...
@@ -125,7 +125,7 @@ basic operations, such as passing data from the controller to the view.
...
@@ -125,7 +125,7 @@ basic operations, such as passing data from the controller to the view.
!!! note
!!! note
After adding or modifying a route in the XML file, you must reset
After adding or modifying a route in the XML file, you must reset
CiviCRMs "menu cache". Do this in a web browser by visiting
CiviCRMs "menu cache". Do this in a web browser by visiting
"
/civicrm/menu/rebuild?reset=1
"
or by running
`
/civicrm/menu/rebuild?reset=1
`
or by running
`drush cc civicrm`
if using Drupal & Drush.
`drush cc civicrm`
if using Drupal & Drush.
**Edit In Place**
**Edit In Place**
...
@@ -147,7 +147,7 @@ may want to consider using the
...
@@ -147,7 +147,7 @@ may want to consider using the
CiviCRM uses a typical web-MVC architecture. To implement a basic web
CiviCRM uses a typical web-MVC architecture. To implement a basic web
form, you must create a PHP controller class, create a Smarty template
form, you must create a PHP controller class, create a Smarty template
file, and create a routing rule. You can create the appropriate files by
file, and create a routing rule. You can create the appropriate files by
calling
"
civix generate:form
"
.
calling
`
civix generate:form
`
.
The form generation command has similar arguments to
`civix generate:page`
,
The form generation command has similar arguments to
`civix generate:page`
,
requiring a class name and a web route:
requiring a class name and a web route:
...
@@ -159,8 +159,8 @@ civix generate:form FavoriteColor civicrm/favcolor
...
@@ -159,8 +159,8 @@ civix generate:form FavoriteColor civicrm/favcolor
This creates three files:
This creates three files:
-
`xml/Menu/myextension.xml`
defines request-routing rules and
-
`xml/Menu/myextension.xml`
defines request-routing rules and
associates the controller
("
CRM_Myextension_Form_FavoriteColor
")
associates the controller
`
CRM_Myextension_Form_FavoriteColor
`
with the web path
("
civicrm/favcolor
")
with the web path
`
civicrm/favcolor
`
.
-
`CRM/Myextension/Form/FavoriteColor.php`
is the controller which
-
`CRM/Myextension/Form/FavoriteColor.php`
is the controller which
coordinates any parsing, validation, business-logic, or database
coordinates any parsing, validation, business-logic, or database
operations. For more details on how this class works, see
[
QuickForm
operations. For more details on how this class works, see
[
QuickForm
...
@@ -177,7 +177,7 @@ basic operations, such as adding a <SELECT\> element to the form.
...
@@ -177,7 +177,7 @@ basic operations, such as adding a <SELECT\> element to the form.
!!! note
!!! note
After adding or modifying a route in the XML file, you must reset
After adding or modifying a route in the XML file, you must reset
CiviCRMs "menu cache". This can be done in a web browser by visiting
CiviCRMs "menu cache". This can be done in a web browser by visiting
"
/civicrm/menu/rebuild?reset=1
"
`
/civicrm/menu/rebuild?reset=1
`
### Add a database upgrader, installer and uninstaller
### Add a database upgrader, installer and uninstaller
...
@@ -467,7 +467,7 @@ PHP, SQL and templates.
...
@@ -467,7 +467,7 @@ PHP, SQL and templates.
To make a new search based on an existing search first determine the name of
To make a new search based on an existing search first determine the name of
the original search class within the
`civicrm/CRM/Contact/Form/Search/Custom`
the original search class within the
`civicrm/CRM/Contact/Form/Search/Custom`
directory of CiviCRM source tree. Then run the
"
generate:search
"
command from
directory of CiviCRM source tree. Then run the
`
generate:search
`
command from
within your module directory.
within your module directory.
For example, the zipcode search is in the class
For example, the zipcode search is in the class
...
@@ -515,8 +515,8 @@ This creates one file:
...
@@ -515,8 +515,8 @@ This creates one file:
particular way (as demonstrated by the auto-generated file).
particular way (as demonstrated by the auto-generated file).
<!-- fixme - clarify is this 4.3 and later? -->
<!-- fixme - clarify is this 4.3 and later? -->
For use with CiviCRM 4.3, you can also add the
"
–schedule
"
option (e.g.
For use with CiviCRM 4.3, you can also add the
`
–schedule
`
option (e.g.
"
–schedule Hourly
"
). This will create another file:
`
–schedule Hourly
`
). This will create another file:
-
`api/v3/NewEntity/NewAction.mgd.php`
provides the scheduling
-
`api/v3/NewEntity/NewAction.mgd.php`
provides the scheduling
record that will appear in the CiviCRM's job-manager.
record that will appear in the CiviCRM's job-manager.
...
@@ -538,7 +538,7 @@ CiviCRM. For this, you can use the command `civix generate:entity`
...
@@ -538,7 +538,7 @@ CiviCRM. For this, you can use the command `civix generate:entity`
FirstLetterCapitalized here). This creates a skeletal file for your
FirstLetterCapitalized here). This creates a skeletal file for your
XML schema, your BAO, and your API. It does NOT create a skeletal
XML schema, your BAO, and your API. It does NOT create a skeletal
SQL file to create your table or DAO files at this time.
SQL file to create your table or DAO files at this time.
-
Edit the XML schema in the
"
xml
"
folder to match the fields you
-
Edit the XML schema in the
`
xml
`
folder to match the fields you
want. Minimal documentation is available
want. Minimal documentation is available
[
here
](
https://wiki.civicrm.org/confluence/display/CRMDOC/Database+Reference
)
,
[
here
](
https://wiki.civicrm.org/confluence/display/CRMDOC/Database+Reference
)
,
but you are better off looking at the
[
existing XML
but you are better off looking at the
[
existing XML
...
@@ -628,8 +628,7 @@ civix config:get
...
@@ -628,8 +628,7 @@ civix config:get
civix config:set civicrm_api3_conf_path /your/path/to/sites/default
civix config:set civicrm_api3_conf_path /your/path/to/sites/default
```
```
To run this test-class, change to your extension folder and call "civix
To run this test-class, change to your extension folder and run the following:
test":
```
bash
```
bash
civix
test
CRM_Myextension_MyTest
civix
test
CRM_Myextension_MyTest
...
...
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