guresicpark / phphotreload

Hotreload feature in php

phphotreload

Getting started

git clone https://github.com/guresicpark/phphotreload

Install phphotreload Chrome plugin

In Chrome browser enable developers mode (in Chrome's extensions tab) and open/load folder /chrome_extension as an Chrome extension. There should appear a yellow round icon on the Chrome extension bar, that will turn green when it is connected to your running node js server.

Start phphotreload nodejs server

Go to phphotreload server cd /nodejs_server and type npm install.

You can start the server it with npm start.

If it fails to start because node js is missing, you can execute in your bash: sudo ln -s /usr/bin/nodejs /usr/bin/node and you can try again npm start.

But before you start the node js server you have to add a config file under /nodejs_server/config/my_config.yml that matches your specific project data, like for example:

# config.yml
"C:/your_local_repository/your_php_project/src/": # what folder to watch for local file changes
  latency: 400 # how long to wait to reload tab after a file has changed, 200ms here
  debounce: 400 # reaction time of file change debounce timer, 400ms here
  updatealltabs: false # update all tabs related to this local folder
  ignorepaths: 
    - "generated" # please do not watch this folder for local file changes
    - "out"
    - "tmp"
  extensions: # files with this extensions should be watched
    - php
    - js
    - html
  domains: # associated domains for your local project folder; wildcard patterns are allowed like test*.mypage.com
    - "mypage.com"
    - "mobile.mypage.org"
  ignoreurls: # what urls should be ignored; wildcard patterns are allowed like http://mypage2.com/admin/*/sub
    - "admin"
    - "backend"
  clearpaths: [] # clear files in this folder locally before tab reload begins
  clearurls: # or use a php script to clear your temp files
    - "clearcache.php"
# next entry here possible...

Example config in nodejs_server/config/bla.yml:

"/home/bla/Workspace/blabla/src/":
  latency: 400
  debounce: 400
  updatealltabs: false
  ignorepaths: []
  extensions:
    - php
    - js
    - html
  domains:
    - "blabla.dev.local"
  ignoreurls:
    - "admin"
  clearpaths: []
  clearurls:
    - "clrtmp.php"

Don't forget to copy cache delete script provided by phphotreload to your server root.

Linux system setting

On Ubuntu execute the following commands in terminal to increase count of watched files:

• add entry for maximum watch items: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf
• reconfigure linux kernel on the fly: sudo sysctl -p

Congratulations, you installed successfully phphotreload!