Implement PHP RFC 0001: Restructure PHP

[sophiewigmore]

Per PHP RFC 0001 we are restructuring the PHP language family of buildpacks to make them more modular, up-to-date, and as a result, maintainable.

This issue serves as a meta-issue for tracking the implementation all of the restructure work amongst the implementation buildpacks and language family.

Issues

• PHP Restructure: RFC to Migrate from Buildpack.yml to Environment Variables #472

---

1. Deprecation warning for buildpack.yml usage (Parallelizable)

• Add deprecation warning for buildpack.yml usage php-web#216
• Add deprecation warning for buildpack.yml usage php-dist#329
• Add deprecation warning for buildpack.yml usage php-composer#265

---

2. PHP Builtin Server Simple Use case

• Restructure buildpack: PHP Dist php-dist#324
• Waiting for release - Restructure buildpack: Create php-builtin-server buildpack php-builtin-server#1

---

3. Implement initial php-fpm buildpack

• Restructure buildpack: Create php-fpm buildpack  php-fpm#3

---

4. NGINX and HTTPD Web servers (parallelizable)

• Restructure buildpack: Create php-httpd buildpack php-httpd#2
• RFC for Introduce a PHP Start buildpack #503
• Restructure buildpack: Create php-httpd buildpack php-httpd#4
• Restructure buildpack: PHP Start for HTTPD php-start#1
• Restructure buildpack: Create php-nginx buildpack  #479
• Restructure buildpack: Create php-nginx buildpack php-nginx#2
• Restructure buildpack: PHP Start for Nginx php-start#2
  These may require changes to php-dist and/or php-fpm buildpacks

---

5. Modularize composer and substitute in the language family (sequential)

• Restructure buildpack: Create composer buildpack composer#12
• In Progress - Restructure buildpack: Create composer-install buildpack composer-install#4
• Restructure buildpack: Update composer groups in language family #475

---

6. Optional session handlers (parallelizable)

• https://github.com/paketo-buildpacks/php-memcached-session-handler#1
• Restructure buildpack: Create php-redis-session-handler buildpack php-redis-session-handler#1

---

7. Swap new buildpacks into the language family order groups, finish up

• Restructure buildpack: Update language family order groups #483
• Restructure: Update Language Family Order Groups  #524
• PHP Restructure: Documentation Updates paketo-website#370

---

8. Future optimizations (can be done outside of rewrite):

• Allow location of nginx.conf to be configurable by environment variable nginx#358
• Can we make the subsequent buildpack-provided configuration location configurable? php-fpm#26

[fg-j]

I'm working on paketo-buildpacks/php-fpm#3, and I'm trying to get a handle on what functionality is required in the buildpack. Will the php-builtin-server buildpack created in https://github.com/paketo-buildpacks/php/issues/477 be responsible for generating the php.ini file the that the php-web buildpack currently generates? Or does the php-fpm buildpack need to generate that config file? Currently, the php-web buildpack writes the file into its layer during every build.

[sophiewigmore]

@fg-j Hmm. This is a good question. Based off of my limited knowledge of PHP, I think the PHP FPM buildpack should only be responsible for configuring the php-fpm.conf file. I believe setting configuration in a PHP FPM config file overrides a php.ini file anyways. If a php.ini file is actually necessary to be generated, my instinct would be to have the php-builtin-server buildpack handle this, since the php-httpd and php-nginx counterparts generate their respective config files as well.

Happy for @paketo-buildpacks/php-maintainers to weigh in as well

[dmikusa]

My $0.02. I would suggest that we have the buildpack which installs PHP add a default php.ini file. This is traditionally how it's done. When you install PHP with apt or another package manager, that provides a default php.ini. It should also set PHPRC and PHP_INI_SCAN_DIR.

The individual buildpacks can then customize that by adding php.ini snippets to the PHP_INI_SCAN_DIR. Right now, that points to something in the application workspace. That is probably OK, we just have to regenerate those every time the buildpack runs. Alternatively, we could have a second buildpack-only location for that. You can add multiple folders to the scan dir.

It is possible to scan multiple directories by separating them with the platform-specific path separator (; on Windows, NetWare and RISC OS; : on all other platforms; the value PHP is using is available as the PATH_SEPARATOR constant).

That leaves PHP-FPM & the web server buildpacks only responsible for generating their specific config.

[fg-j]

In that case, I think paketo-buildpacks/php-dist#324 needs to be updated to include generating a default configuration file (and possibly setting up the PHP_INI_DIR).

[arjun024]

@fg-j
This is addressed directly in the rfc.

• php-dist:
  Installs the php distribution, making it available on the $PATH
  • provides: php
  • requires: none

This distribution must include popular modules like memcached, mongodb,
mysqli, openssl, phpiredis, zlib etc; and a suitable php.ini.

[ForestEckhardt]

@sophiewigmore Is this issue still being used to track work or are we done?

[sophiewigmore]

@ForestEckhardt as you can see, the documentation issue is still in review. That's the last remaining issue. I will close out this issue when that is available on the Paketo website.