PHP Command Line Boilerplate / Example Project

This repository shows a basic setup for a PHP package or application in PHP.

Getting Started

PHP 8.1 or above and Composer is expected to be installed on our system.

Installing Composer

For instructions on how to install Composer visit getcomposer.org.

Installing

After cloning this repository, change into the newly created directory and run

composer install

or if you have installed Composer locally in your current directory

php composer.phar install

This will install all dependencies needed for the project.

Running the Tests

All tests can be run by executing

vendor/bin/phpunit

phpunit will automatically find all tests inside the test directory and run them based on the configuration in the phpunit.xml file.

Testing Approach

The test for the class Greeting verifies that the return value of the sayHello method returns the string "Hello {name}", where {name} is the value passed through to the constructor.

Running the Application

To run the application execute bin/hello.php or php bin/hello.php.

You should see the text "Hello" being printed.

bin/hello.php

Built With

• PHP
• Composer
• PHPUnit

License

This project is licensed under the MIT License - see the LICENCE.md file for details.