NGS-PHP

Introduction

ngs-php is a set of core PHP files used for interaction of DSL platform and PHP.

If you are new to the DSL platform, take a look at [introduction] 2 and check out [the tutorials] 4. You can even [try it online] 8.

Installing

Run composer to install required dependencies.

$ composer install

This package should primarily be used for testing. To setup DSL platform in easy way, we recommend you to create and download a project from dsl-platform.com. For further information about using DSL platform in your projects, follow the instructions in Setup guide.

Running tests

To run tests you must first copy project files to tests/platform folder. Take a look at Setup guide to see how to create a new project.

Run phpunit from the composer vendors folder:

$ ./vendor/bin/phpunit

Some tests need aditional setup:

• Template tests require a template file in the project: upload template.txt file from tests/fixtures/ folder to your project (in the uploads).
• Amazon S3 tests require a valid Amazon account. Copy phpunit.xml.dist to phpunit.xml and enter your account credentials in the 'php' section.

You can test single components by specifying their name:

$ phpunit tests/unit/types/LocalDateTest

All unit tests are located in the tests/unit folder.

apigen --source NGS/ --destination ../docs/NGS22

Documentation

List of documentation resources:

• API docs
• Try it online
• Introduction
• Setup guide
• Quick tutorial
• Intermediate tutorial
• Advanced tutorial
• Example usage of DSL platform inside a Laravel app

API documentation is created using apigen.

$ apigen --source NGS/ --destination path