[Docs] Migrate phpstorm docs page #208

HuongNV13 · 2022-06-10T08:27:20Z

Trying to migrate my first new Moodle Dev Doc

netlify · 2022-06-10T08:27:25Z

✅ Deploy Preview for moodledevdocs ready!

Name	Link
🔨 Latest commit	`7984d72`
🔍 Latest deploy log	https://app.netlify.com/sites/moodledevdocs/deploys/62a306774680f800083bbddc
😎 Deploy Preview	https://deploy-preview-208--moodledevdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

github-actions · 2022-06-10T08:33:02Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟢 93	🟢 95	🟢 100	🟢 90	🟢 100	Report
/docs/apis/commonfiles	🟠 71	🟢 94	🟢 100	🟢 100	🟢 100	Report
/general/development/gettingstarted	🟠 89	🟢 94	🟢 100	🟢 90	🟢 100	Report
/general/releases	🟠 84	🟢 94	🟢 100	🟢 100	🟢 100	Report

andrewnicols

A few, mostly minor, changes here I think.

andrewnicols · 2022-06-10T12:01:06Z

general/development/tools/phpstorm.md

+ - PhpStorm
+ - Tools
+---
+<!-- markdownlint-disable MD029 -->


What's this for?

andrewnicols · 2022-06-10T12:01:25Z

general/development/tools/phpstorm.md

+title: Setting up PhpStorm
+tags:
+ - PhpStorm
+ - Tools


Suggest adding 'IDE' and/or 'Editor' to the list of tags

andrewnicols · 2022-06-10T12:01:58Z

general/development/tools/phpstorm.md

+- 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


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

andrewnicols · 2022-06-10T12:02:12Z

project-words.txt

@@ -72,6 +74,7 @@ calculatedmulti
 calculatedsimple
 capabilityname
 captype
+catched


Not a word :) You're after caught

Suggested change

catched

andrewnicols · 2022-06-10T12:02:33Z

sidebars/general.js

@@ -211,6 +211,7 @@ const sidebars = {
                'development/tools/mdk',
                'development/tools/phpcs',
                'development/tools/nodejs',
+                'development/tools/phpstorm',


I'd suggest maybe creadting a sub-category for IDEs here?

andrewnicols · 2022-06-10T12:09:34Z

general/development/tools/phpstorm.md

+```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
+```


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

andrewnicols · 2022-06-10T12:10:10Z

general/development/tools/phpstorm.md

+```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
+```


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

andrewnicols · 2022-06-10T12:10:39Z

general/development/tools/phpstorm.md

+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


Not sure what type to put here, but not php. Text maybe?

Suggested change

```php

andrewnicols · 2022-06-10T12:10:54Z

general/development/tools/phpstorm.md

+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`


A few more syntaxhighlight occurrences

andrewnicols · 2022-06-10T12:11:23Z

general/development/tools/phpstorm.md

+
+You can work on JavaScript development by add Grunt configuration:
+
+1. Install Watchman - https://facebook.github.io/watchman/docs/install.html


Suggested change

1. Install Watchman - https://facebook.github.io/watchman/docs/install.html

1. Install [Watchman](https://facebook.github.io/watchman/docs/install.html)

andrewnicols · 2022-06-24T14:02:10Z

I've converted this PR to a draft. Please send back to review when ready.

[Docs] Migrate phpstorm docs page

7984d72

HuongNV13 force-pushed the migratephpstormdocs branch from bc583c5 to 7984d72 Compare June 10, 2022 08:53

andrewnicols requested changes Jun 10, 2022

View reviewed changes

andrewnicols assigned HuongNV13 Jun 14, 2022

andrewnicols marked this pull request as draft June 24, 2022 14:01

moodle deleted a comment Jan 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Migrate phpstorm docs page #208

[Docs] Migrate phpstorm docs page #208

HuongNV13 commented Jun 10, 2022 •

edited by gitpod-io bot

Loading

netlify bot commented Jun 10, 2022 •

edited

Loading

github-actions bot commented Jun 10, 2022 •

edited

Loading

andrewnicols left a comment

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols Jun 10, 2022

andrewnicols commented Jun 24, 2022

	- 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


		You can work on JavaScript development by add Grunt configuration:

		1. Install Watchman - https://facebook.github.io/watchman/docs/install.html

	1. Install Watchman - https://facebook.github.io/watchman/docs/install.html
	1. Install [Watchman](https://facebook.github.io/watchman/docs/install.html)

[Docs] Migrate phpstorm docs page #208

Are you sure you want to change the base?

[Docs] Migrate phpstorm docs page #208

Conversation

HuongNV13 commented Jun 10, 2022 • edited by gitpod-io bot Loading

netlify bot commented Jun 10, 2022 • edited Loading

✅ Deploy Preview for moodledevdocs ready!

github-actions bot commented Jun 10, 2022 • edited Loading

⚡️ Lighthouse report for the deploy preview of this PR

andrewnicols left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewnicols commented Jun 24, 2022

HuongNV13 commented Jun 10, 2022 •

edited by gitpod-io bot

Loading

netlify bot commented Jun 10, 2022 •

edited

Loading

github-actions bot commented Jun 10, 2022 •

edited

Loading