jetbrains/phpstorm-workshop

Materials for the PhpStorm workshop. Check https://github.com/jetbrains/phpstorm-workshop/ for more info.

3.0 2019-01-16 15:10 UTC

Apache-2.0

• Maksim Kolmakov

README

PhpStorm Workshop

In these materials, you'll learn about many of the features and productivity tools available in PhpStorm. Examples are navigation, editing, inspections, live templates, refactoring, tools like Composer and the HTTP client, and many more. It's virtually impossible to cover every option and feature in PhpStorm, but we're providing a number of practical exercises on how we can do our daily work as PHP developers.

We'll also cover a vast amount of keyboard shortcuts to make working with PhpStorm more efficient. Other IntelliJ-based IDE's use the same keyboard shortcuts, so if you know how to work with PhpStorm, you'll know how to work with WebStorm, RubyMine, PyCharm, IntelliJ IDEA and more. A cheat sheet is available online and is also included in the workshop download.

This workshop is self-paced, meaning you can work your way through exercises on your own, whenever and wherever you want. Exercises come as a PhpStorm project in which every file is a new exercise that may contain code and tips to get things done.

Prerequisites

• Docker for Mac, Docker for Windows or Docker (Linux) 1.13+. See Docker documentation for installation instructions for your operating system.
• PhpStorm 2016.3+

Getting the Project

There are several ways to get started with the PhpStorm workshop materials:

• Create a new PhpStorm Workshop Project in PhpStorm

• Create a new project with Composer. Note that you can also create a new project in PhpStorm: use the Composer project type and search for "jetbrains/phpstorm-workshop"

  php composer.phar create-project jetbrains/phpstorm-workshop -s dev

• Clone the project from GitHub

  git clone https://github.com/JetBrains/phpstorm-workshop.git

  git checkout docker

• Download the ZIP

  wget https://github.com/JetBrains/phpstorm-workshop/archive/docker.zip

Getting Started

Most exercises not related to the code editor require having Docker containers running.

Before you start:

1. Open Settings/Preferences | Build, Execution, Deployment | Docker and select how to connect to the Docker daemon:

   • Windows:

     • Select TCP socket.
     • Set Engine API URL to tcp://localhost:2375.
     • Leave the Certificates folder field empty.

     Make sure to enable Expose daemon on tcp://localhost:2375 without TLS in the General section of Docker for Windows settings.

   • macOS:

     • Select Docker for Mac

   • Linux:

     • Select Unix socket

2. Update XDEBUG_CONFIG variable in docker-compose.yml with the value depending on your operating system. This is necessary for Web Debugging.

   • Windows/macOS: use host.docker.internal, which will automatically resolve to the internal address of the host Docker is running on.
   • Linux: execute hostname in Terminal and use the returned value.

3. Uncomment an appropriate line for sftp service in the same docker-compose.yml. This is necessary for Deployment to work correctly.

4. In the same docker-compose.yml, click the Run icon next to services: in the editor gutter to start all required Docker containers. Alternatively, you can open the built-in PhpStorm terminal from View | Tool Windows | Terminal and execute the docker-compose up command.

There are some things to know about the project:

• The project can be opened as is in PhpStorm. We've included configurations for PHP Remote Interpreter, Database, Deployment Server, PHP Web Debug, PHPUnit and Behat.
• All numbered folders contain exercises that you can work on. Simply open the numbered files one by one and follow the comments in the file. Most exercises are self-contained, others build on previous exercises.
• Some of the exercises (like this one) are in Markdown format. You can read these files easier by toggling View to Show Preview Only in the top-right corner.
• The PhpStorm Reference Card.pdf is the PhpStorm keymap. The latest version can always be found on the PhpStorm website.

Open Source and Contribution

The workshop is Open Source, licensed under the Apache 2 license. If you would like to contribute to the workshop materials, please feel free to fork the repo and send us a pull request. Or if you have a comment, question, or suggestion for improvements, please raise an issue.