Download the PHP package vanilla/garden-sites without Composer
On this page you can find all versions of the php package vanilla/garden-sites. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vanilla/garden-sites
More information about vanilla/garden-sites
Files in vanilla/garden-sites
Package garden-sites
Short Description Package containing interfaces and implementations for local and hosted vanilla forums sites management and definitions.
License proprietary
Informations about the package garden-sites
vanilla/garden-sites
Library for managing providing a list of sites and clusters from localhost or an orchestration server.
Installation
Usage
The entrypoint to usage of this library is through either the Garden\Sites\LocalSiteProvider
or the Garden\Sites\OrchSiteProvider
.
LocalSiteProvider
Notably the path to the site configs must be a readable directory to the PHP process.
The local site provider works be reading php-based config files from a given directory. This reads all sites recognized by the vnla docker
setup. For a site config to be recognized it must meet the following criteria
- The file has name matching one of the following patterns
/*.php
- Becomes*.vanilla.localhost
/vanilla.localhost/*.php
- Becomesvanilla.localhost/*
/e2e-tests.vanilla.localhost/*.php
- Becomese2e-tests.vanilla.localhost/*
- The file contains a valid PHP configuration files.
- The configuration contains the following values
Vanilla.SiteID
Vanilla.AccountID
- Optional
Vanilla.ClusterID
. Defaults tocl00000
Clusters
By default all local sites are on the same cluster cl00000
. You can bypass this by adding a Vanilla.ClusterID
config to the site.
Cluster configurations may be added into the configs /clusters
directory and are named /clusters/cl*.php
. These should php config files just like sites. The configurations in these files will be merged with the site configs.
OrchSiteProvider
The orch site provider loads sites and clusters from a remote orchestration http server. Sites, clusters, and configs are cached for a 1 minute period.
The orchestration provider needs to be configured with an authenticated OrchHttpClient
and a region/network to load sites from.
Using site providers
Both OrchSiteProvider
and LocalSiteProvider
extend from SiteProvider
and implement similar functionality.
Using Clusters and Sites
All versions of garden-sites with dependencies
psr/http-message Version ^1.0.1
ext-json Version *
php Version >=8.0
vanilla/garden-utils Version ^1.0.1
symfony/cache-contracts Version ^2.5
firebase/php-jwt Version ^6.10