Commit e32ca57f authored by MikeyMJCO's avatar MikeyMJCO
Browse files

Fix incorrectly cased brand names/abbreviations.

parent 2c8af2fc
# Using PhpStorm for CiviCRM Development
[PhpStorm](https://www.jetbrains.com/phpstorm) is a commercial IDE which is popular among CiviCRM developers.
[PHPStorm](https://www.jetbrains.com/phpstorm) is a commercial IDE which is popular among CiviCRM developers.
## General project setup
......@@ -24,21 +24,21 @@ Create the 'CiviCRM' code styling preference:
That's it. You can now use this code style on all future CiviCRM-related projects. If you are only developing for CiviCRM, you can also copy this style to the 'Default' style.
## XDebug integration
You need to configure XDebug on the webserver, phpstorm on the development machine and a debugger helper in the browser.
To configure XDebug and PHPStorm see: https://www.jetbrains.com/help/phpstorm/configuring-xdebug.html
For browser helpers see: https://confluence.jetbrains.com/display/PhpStorm/Browser+Debugging+Extensions
## Running automated tests from within PhpStorm {:#testing}
## Running automated tests from within PHPStorm {:#testing}
*PhpStorm provides convenient tools for running and debugging unit tests in-app.*
*PHPStorm provides convenient tools for running and debugging unit tests in-app.*
!!! note
These instructions assume you already have a working instance of CiviCRM running locally with [buildkit](buildkit).
1. On the cli from a directory inside your build, run the command `civibuild phpunit-info`.
This outputs configuration settings you will need to paste into PhpStorm.
1. On the CLI from a directory inside your build, run the command `civibuild phpunit-info`. This outputs configuration settings you will need to paste into PHPStorm.
2. From the `Run > Edit Configurations` menu edit the default PHPUnit configuration for your project.
3. Check "Use alternative configuration file" and choose the one output by the `civibuild` command.
4. Set the custom working directory as specified by the `civibuild` output.
......@@ -50,12 +50,9 @@ For more detailed instructions (with screenshots!) see this [StackExchange answe
It can be frustrating when writing tests the PHPStorm complains about missing classes or undefined methods. This happens because PHPUnit is not included in the CiviCRM codebase.
To remedy this you can add an external content root. You'll need to clone the [phpunit] library locally. Then from that directory check out the latest supported version of phpunit (4.x right now).
After that you just add the directory to your project include paths by [following the instructions on the Jetbrains site][phpstorm-include-paths].
To remedy this you can add an external content root. You'll need to clone the [PHPUnit](https://phpunit.de/) library locally. Then from that directory check out the latest supported version of PHPUnit (4.x right now).
[phpstorm-include-paths]: https://www.jetbrains.com/help/phpstorm/configuring-include-paths.html
[phpunit]: https://github.com/sebastianbergmann/phpunit
After that you just add the directory to your project include paths by [following the instructions on the Jetbrains site](https://www.jetbrains.com/help/phpstorm/configuring-include-paths.html).
Alternatively: always use buildkit to generate you CiviCRM development environment; it ships with many tools - including phpunit4
Alternatively: always use buildkit to generate you CiviCRM development environment; it ships with many tools - including PHPUnit 4
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment