PHPStorm (or IntelliJ) Integration

Running PHPUnit Tests

1. If you are using IntelliJ IDEA, you'll need to install the PHP, PHP Docker and PHP Remote Interpreter plugins from the marketplace (PHPStorm comes with these by default)
2. Install PHPUnit for your site as per these instructions.
3. Open settings
4. Go to PHP (In IntelliJ this is found under Languages & Frameworks)
5. Under CLI Interpreter, click the ... button
6. Remove any existing interpreters in the list
7. Add an interpreter, selecting From Docker, Vagrant, VM, WSL, Remote...
8. Select Docker Compose
9. Under Server, click New and add a new Docker daemon using the relevant type for your OS then click OK
   • MacOS: Rancher Desktop, or if you don't have Rancher, Docker Desktop
   • Windows: Docker for Windows
   • Linux: Unix socket

7. Add Configuration files, with the files being: (in the following order) totara-docker-dev/docker-compose.yml, and totara-docker-dev/compose/php.yml (where totara-docker-dev is the path of this docker-dev respository on your machine)

8. Select a PHP container under Service, e.g. php-8.3-debug
9. Click OK
10. Untick Visible only for this project
11. Set Lifecycle to Connect to existing container
12. Your CLI interpreter should look something like this:

13. Click OK
14. For CLI Interpreter, select the interpreter you just added and click OK
15. Under Path mappings, add a mapping for your local totara code directory, where Local Path = your local sites folder (e.g. /Users/mark/totara-sites) and Remote Path = /var/www/totara/src (i.e. the LOCAL_SRCand REMOTE_SRC vars in your docker-dev .env file)

16. Go to PHP > Test Frameworks
17. Add a test framework, selecting PHPUnit by Remote Interpreter
18. Select the interpreter you added and click Apply
19. Set Path to script to be /var/www/totara/src/SITENAME/test/phpunit/vendor/autoload.php, where SITENAME is the name of your site's subdirectory (if you do not have multiple sites set up, this can be omitted). Note: For Totara 12 or older/Moodle, this will need to be /var/www/totara/src/SITENAME/vendor/autoload.php
20. Set Default configuration file under Test Runner to be /var/www/totara/src/SITENAME/test/phpunit/phpunit.xml, where SITENAME is the name of your site's subdirectory (if you do not have multiple sites set up, this can be ommitted). Note: For Totara 12/Moodle or older, this will need to be /var/www/totara/src/SITENAME/phpunit.xml
21. Click OK

You should now be able to run unit tests directly from within the IDE. If you set up XDebug as documented below, you will also be able to set breakpoints within in your tests too.

Debugging via XDebug

1. Ubuntu & Windows: Set the HOST_IP variable in your docker-dev .env file to be 172.17.0.1. Mac Users can skip this step
2. Open settings
3. Go to PHP > Servers
4. Add a server, with the name being totaraXX (where XX = the PHP version, e.g. 83), the host being totaraXX.debug, the port being 80, and the debugger being Xdebug. If you have multiple sites set up with subdomains, you can set the host to be SITENAME.totaraXX. Note: the name being totaraXX is important, it won't work if you use SITENAME.totaraXX or SITENAME.totaraXX.debug.
5. Tick Shared (next to Name)
6. Tick Use path mappings, and set the absolute path on the server to be /var/www/totara/src (or /var/www/totara/src/SITENAME if you have multiple sites set up)

XDebug should now work and the IDE will listen and activate breakpoints when the Start Listening for PHP Debug Connections setting is enabled.

You can trigger your breakpoints when visiting http://SITENAME.totaraXX.debug/ pages in your browser, or when running unit tests within the IDE (if you are using a totaraXX.debug host), or when running a PHP script while in a php-X.X-debug container.

Viewing Your Databases

1. In the database tool pane, add a new database and select the DBMS you wish to view (e.g. PostgreSQL or MySQL) under Data Source

   

2. Set the Host to be localhost

3. Set the Port, User and Password values to be the same as what is listed in this table

4. Download Drivers if they are missing

5. Under the Schemas tab, select the database schemas you want to be able to view (or select All schemas_)
6. Click OK
7. Click Refresh in the Database panel

You should now be able to view tables and use the database console for the DBMS you added.

Performance Improvements

Faster Indexing

PHPStorm/IntelliJ can be slow when indexing Totara project files due to the sheer amount of code we have. It can be made quicker by excluding some directories that we don't need from indexing.

You can add non-important files and directories to the list of exclusions by copying the contents of this file into your project's main .iml file, which will be located at .idea/PROJECTNAME.iml (e.g ~/totara-sites/integration/.idea/integration.iml)

This can make the indexing of your project up to 30-40% faster.