[Docs] Migrate phpstorm docs page #208
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the deploy preview of this PR
|
HuongNV13
force-pushed
the
migratephpstormdocs
branch
from
bc583c5 to
7984d72
Compare
andrewnicols
requested changes
Jun 10, 2022
| - PhpStorm | ||
| - Tools | ||
| --- | ||
| <!-- markdownlint-disable MD029 --> |
| title: Setting up PhpStorm | ||
| tags: | ||
| - PhpStorm | ||
| - Tools |
There was a problem hiding this comment.
Suggest adding 'IDE' and/or 'Editor' to the list of tags
| - Use `/** @var admin_root $ADMIN */` to autofill $ADMIN->... | ||
| - Remove SQL syntax inspection errors for Moodle tables surrounded by curly brackets (like: `SELECT * FROM {user}`) by adding `\{(\w+)\}` to Tools > Databases > user parameters | ||
| (more info: https://blog.jetbrains.com/phpstorm/2014/11/database-language-injection-configuration/ , and a "feature request" to improve it: https://youtrack.jetbrains.com/issue/WI-4123 ) | ||
| - You can deactivate warnings for specific exceptions (in particular the coding_exception, which is unlikely to be catched in your code) by going to Settings > PHP and add them to 'Unchecked Exceptions' under the 'Analysis' tab |
There was a problem hiding this comment.
Suggested change
| - You can deactivate warnings for specific exceptions (in particular the coding_exception, which is unlikely to be catched in your code) by going to Settings > PHP and add them to 'Unchecked Exceptions' under the 'Analysis' tab | |
| - You can deactivate warnings for specific exceptions (in particular the `coding_exception`, which is unlikely to be caught in your code) by going to Settings > PHP and add them to 'Unchecked Exceptions' under the 'Analysis' tab |
| @@ -72,6 +74,7 @@ calculatedmulti | |||
| calculatedsimple | |||
| capabilityname | |||
| captype | |||
| catched | |||
There was a problem hiding this comment.
Not a word :) You're after caught
Suggested change
| catched |
| @@ -211,6 +211,7 @@ const sidebars = { | |||
| 'development/tools/mdk', | |||
| 'development/tools/phpcs', | |||
| 'development/tools/nodejs', | |||
| 'development/tools/phpstorm', | |||
There was a problem hiding this comment.
I'd suggest maybe creadting a sub-category for IDEs here?
Comment on lines
+128
to
+138
| ```php | ||
| XDEBUG_CONFIG: | ||
| idekey=phpstorm | ||
| remote_enable=1 | ||
| remote_mode=req | ||
| remote_port=9000 | ||
| remote_host=host.docker.internal | ||
| remote_connect_back=0 | ||
| PHP_IDE_CONFIG: | ||
| serverName=moodle-local | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| ```php | |
| XDEBUG_CONFIG: | |
| idekey=phpstorm | |
| remote_enable=1 | |
| remote_mode=req | |
| remote_port=9000 | |
| remote_host=host.docker.internal | |
| remote_connect_back=0 | |
| PHP_IDE_CONFIG: | |
| serverName=moodle-local | |
| ``` | |
| ```yaml | |
| XDEBUG_CONFIG: | |
| idekey=phpstorm | |
| remote_enable=1 | |
| remote_mode=req | |
| remote_port=9000 | |
| remote_host=host.docker.internal | |
| remote_connect_back=0 | |
| PHP_IDE_CONFIG: | |
| serverName=moodle-local |
Comment on lines
+142
to
+166
| ```php | ||
| webserver: | ||
| image: "moodlehq/moodle-php-apache:${MOODLE_DOCKER_PHP_VERSION}" | ||
| depends_on: | ||
| - db | ||
| volumes: | ||
| - "${MOODLE_DOCKER_WWWROOT}:/var/www/html" | ||
| - "${ASSETDIR}/web/apache2_faildumps.conf:/etc/apache2/conf-enabled/apache2_faildumps.conf" | ||
| environment: | ||
| MOODLE_DOCKER_DBTYPE: pgsql | ||
| MOODLE_DOCKER_DBNAME: moodle | ||
| MOODLE_DOCKER_DBUSER: moodle | ||
| MOODLE_DOCKER_DBPASS: "m@0dl3ing" | ||
| MOODLE_DOCKER_BROWSER: firefox | ||
| MOODLE_DOCKER_WEB_HOST: "${MOODLE_DOCKER_WEB_HOST}" | ||
| XDEBUG_CONFIG: | ||
| idekey=phpstorm | ||
| remote_enable=1 | ||
| remote_mode=req | ||
| remote_port=9000 | ||
| remote_host=host.docker.internal | ||
| remote_connect_back=0 | ||
| PHP_IDE_CONFIG: | ||
| serverName=moodle-local | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| ```php | |
| webserver: | |
| image: "moodlehq/moodle-php-apache:${MOODLE_DOCKER_PHP_VERSION}" | |
| depends_on: | |
| - db | |
| volumes: | |
| - "${MOODLE_DOCKER_WWWROOT}:/var/www/html" | |
| - "${ASSETDIR}/web/apache2_faildumps.conf:/etc/apache2/conf-enabled/apache2_faildumps.conf" | |
| environment: | |
| MOODLE_DOCKER_DBTYPE: pgsql | |
| MOODLE_DOCKER_DBNAME: moodle | |
| MOODLE_DOCKER_DBUSER: moodle | |
| MOODLE_DOCKER_DBPASS: "m@0dl3ing" | |
| MOODLE_DOCKER_BROWSER: firefox | |
| MOODLE_DOCKER_WEB_HOST: "${MOODLE_DOCKER_WEB_HOST}" | |
| XDEBUG_CONFIG: | |
| idekey=phpstorm | |
| remote_enable=1 | |
| remote_mode=req | |
| remote_port=9000 | |
| remote_host=host.docker.internal | |
| remote_connect_back=0 | |
| PHP_IDE_CONFIG: | |
| serverName=moodle-local | |
| ``` | |
| ```yaml | |
| webserver: | |
| image: "moodlehq/moodle-php-apache:${MOODLE_DOCKER_PHP_VERSION}" | |
| depends_on: | |
| - db | |
| volumes: | |
| - "${MOODLE_DOCKER_WWWROOT}:/var/www/html" | |
| - "${ASSETDIR}/web/apache2_faildumps.conf:/etc/apache2/conf-enabled/apache2_faildumps.conf" | |
| environment: | |
| MOODLE_DOCKER_DBTYPE: pgsql | |
| MOODLE_DOCKER_DBNAME: moodle | |
| MOODLE_DOCKER_DBUSER: moodle | |
| MOODLE_DOCKER_DBPASS: "m@0dl3ing" | |
| MOODLE_DOCKER_BROWSER: firefox | |
| MOODLE_DOCKER_WEB_HOST: "${MOODLE_DOCKER_WEB_HOST}" | |
| XDEBUG_CONFIG: | |
| idekey=phpstorm | |
| remote_enable=1 | |
| remote_mode=req | |
| remote_port=9000 | |
| remote_host=host.docker.internal | |
| remote_connect_back=0 | |
| PHP_IDE_CONFIG: | |
| serverName=moodle-local |
| 1. Only if you're using Docker on linux: From a PhpStorm terminal, run: `docker exec -it moodledocker_webserver_1 ./add-host.docker.internal-to-etc-hosts`. You have to see how packages are installed. | ||
| 1. In any type of host (Mac, Windows or linux): Check that `/etc/hosts</syntaxhighlight> has a line with <syntaxhighlight lang="php">host.docker.internal</syntaxhighlight>. You can do that with the command <syntaxhighlight lang="php">docker exec -it moodledocker_webserver_1 cat /etc/hosts` (if you have a custom container name, use the name for the webserver container). The result should be something like this: | ||
|
|
||
| ```php |
There was a problem hiding this comment.
Not sure what type to put here, but not php. Text maybe?
Suggested change
| ```php |
| 172.20.0.1 host.docker.internal | ||
| ``` | ||
|
|
||
| 8. Go to your PhpStorm and go to `Run -> Edit configurations</syntaxhighlight> and select new <syntaxhighlight lang="php">PHP Remove Debug` |
There was a problem hiding this comment.
A few more syntaxhighlight occurrences
|
|
||
| You can work on JavaScript development by add Grunt configuration: | ||
|
|
||
| 1. Install Watchman - https://facebook.github.io/watchman/docs/install.html |
There was a problem hiding this comment.
Suggested change
| 1. Install Watchman - https://facebook.github.io/watchman/docs/install.html | |
| 1. Install [Watchman](https://facebook.github.io/watchman/docs/install.html) |
|
I've converted this PR to a draft. Please send back to review when ready. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Trying to migrate my first new Moodle Dev Doc