Skip to content

Getting started

Requirements

  • PHP 7.4 or greater
  • ext-json
  • ext-libxml
  • ext-pcre
  • ext-spl
  • PHPUnit 9 or greater (if you want to run unit tests)

GraPHP Composer

Generated with fork of clue/graph-composer. Read more on PR request.

Installation

With Composer

Install the PHP CompatInfo with Composer. If you don't know yet what is composer, have a look on introduction.

composer require bartlett/php-compatinfo ^6.5

With Git

The PHP CompatInfo can be directly used from GitHub by cloning the repository into a directory of your choice.

git clone -b 6.5 https://github.com/llaville/php-compatinfo.git

Configuring the Database

The database connection information is stored as an environment variable called DATABASE_URL.

# to use mysql:
DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=5.7"

# to use mariadb:
DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=mariadb-10.5.8"

# to use sqlite:
DATABASE_URL="sqlite:///%kernel.cache_dir%/compatinfo-db.sqlite"

# to use postgresql:
DATABASE_URL="postgresql://db_user:db_password@127.0.0.1:5432/db_name?serverVersion=11&charset=utf8"

After installation, or if you change database connection, you have to run following command(s):

  • bin/phpcompatinfo db:create
  • bin/phpcompatinfo db:init

At first run of CompatInfoDB, DATABASE_URL will be set to use default SQLite connection

Build PHAR distribution

Uses the BOX Manifest to compile your PHAR version of application. Configuration file (box.json.dist) is provided with each release of phpCompatInfo.