Download the PHP package makertim/multisite-env-switcher without Composer

On this page you can find all versions of the php package makertim/multisite-env-switcher. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of makertim/multisite-env-switcher

Informations about the package multisite-env-switcher

Multisite Env Switcher

PHP from Packagist Latest Version on Packagist

This PHP library helps you to use one deployment / instance / codebase for multiple sites, e.g. live database switching.
It resolves the active site from the request host, then maps that site's prefixed variables to their normal names.
Resolved values are written to getenv(), $_ENV, and $_SERVER. Requests without a matching host, including CLI processes, fall back to the DEFAULT site.

For example, when ALPHA is active, SITE_ALPHA_DB_NAME is exposed as DB_NAME.

Installation

Install the package with Composer:

And ensure it's loaded before you boot a kernel / use environment variables.

Usage

On top of the entrypoint (like index.php or other autoload/included script) include

Call MultisiteEnvSwitcher::load() before you use / validate environment variables. When using external methods of loading env, you should load this after them.

Composer autoload

Add a bootstrap file, e.g. autoload.env.php to Composer's autoload configuration: composer.json

src/autoload.env.php

Dotenv example

https://github.com/vlucas/phpdotenv

src/autoload.env.php

Configure sites

Set APP_SITES to a space-separated list of site names.
Define an APP_SITE_DOMAIN__<SITE> regular expression for each site you want to load.
The regular expression is anchored on both ends (by using ~^...$~), so make sure the expression is a full match.
Notice: hosts are lowercased before matching.

Example

Sites are checked in the order listed in APP_SITES.
The first match wins, so put broad patterns such as .*\.example\.com last.

Common pitfall, when using a dotenv file/shell evaluated method is escaping the \ Single quote don't need \ escaping, but double-qouted values do.

For compatability with the abandoned https://github.com/drunomics/multisite-request-matcher library there is backwards support for uppercase or lowercase site suffixes.
E.g. a site named ALPHA, it is supported to use APP_SITE_DOMAIN__ALPHA and APP_SITE_DOMAIN__alpha.
Best practices recommend uppercased environment values.

Override values per site

Prefix site-specific variables with SITE_<SITE>_. When the site is resolved, the prefix is removed and the value is published under its normal name:

A request to alpha.example.com receives DB_NAME=alpha_db.
A request to beta.example.com receives DB_NAME=beta_db. Variables without a SITE_ prefix are left unchanged unless the active site provides an override.
So other requests do have access to the other variables, since SITE_... are not removed after requests.
Still overrides for other sites are not published, so an ALPHA request does not receive values from SITE_BETA_*.

The APP_SITES variable always uppercase the ENV matcher. In the example it contains alpha but the corresponding variables still use SITE_ALPHA_*.

Values are copied as-is, including empty strings and special characters. They do not get evaluated when they are copied. So everything is kept as-is.

Default site

If no domain pattern matches, the switcher uses the DEFAULT site. This also applies to CLI processes when no host is available.

DEFAULT does not need to be included in APP_SITES and does not have a domain pattern. If APP_SITES is not set, every request resolves to DEFAULT.
It has the same behaviour as not prefixing it with SITE_DEFAULT_ but it ensures that it can never leak to the other domains when there is an issue.

Force a site

It is possible to force a site to be current. E.g. when using the cli, cron or something.
When the SITE environment value is set it skips the domain matching process and apply the site override.

It is supported to use the load() multiple times at runtime.
When the SITE env is changed, it can load a different site.
Creating a loop that does something for each APP_SITES entry, set SITE=... and MultisiteEnvSwitcher::load
WARNING: it does not unload the previous site overwritten values!

Load by host name

You can also pass a host directly to load().

After load() completes, SITE contains the resolved site (or default when no match is found)

Request / Host load order

If the configured header is not present, the switcher continues through the normal host-resolution chain.

Only use a forwarded host header when it is set by a trusted proxy.
A client-controlled header could allow a request to select another site's environment variables.

Resolving the hosts is in the order:

  1. The $host argument passed to load()
  2. $_SERVER[<HEADER_FORWARDED_HOST>], when configured (see below)
  3. $_SERVER['HTTP_HOST']
  4. $_SERVER['SERVER_NAME']
  5. $_SERVER['SERVER_ADDR']
  6. "DEFAULT" (fallback)

Custom host-header support / Proxy and load balancer support

If the HEADER_FORWARDED_HOST env is filled, it uses it's value to get from the $_SERVER pool.
Most often, behind a Proxy it is something like HTTP_X_FORWARDED_HOST, then you need:

Configuration reference

Variable Description
APP_SITES Space-separated list of site names. Defaults to DEFAULT.
APP_SITE_DOMAIN__<SITE> Anchored regular expression matched against the lowercased request host.
SITE_<SITE>_<NAME> Site-specific value published as <NAME> when <SITE> is active.
SITE Forces a site and skips domain matching. Updated with the resolved site after load().
HEADER_FORWARDED_HOST Name of the $_SERVER key containing the forwarded host, for example HTTP_X_FORWARDED_HOST.

Testing & Development

Run the test suite directly:

Run static analysis and coding-standard checks with:

Contributing

Pull requests are welcome.

License

Licensed under the MIT License. See LICENSE.

All versions of multisite-env-switcher with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package makertim/multisite-env-switcher contains the following files

Loading the files please wait ...