README

Set of tools that will help you to develop a program without need to rewrite code.

This lib was write thinking to help new projects, bringing them to life much more easier.

Table of Contents

Quickstart example
System Interaction
- setAppInitiated()
  - getAppInitiated()
  - setFunctionOnAppAborted()
- setAborted()
Install
Tests
License

Quickstart example

This is the ways to be construct this:

$systemInteraction = new BrunoNatali\Tools\SystemInteraction();

// Alternatively you can set system folder by hand

$mySystemFolder = ['/home/user/myApp/', '/var/myfolder/myApp/'];
$systemInteraction = new BrunoNatali\Tools\SystemInteraction($mySystemFolder);

System Interaction

setAppInitiated()

The setAppInitiated() method set app running by provided name, creating system file with current pid and handling requested shutdown.

$systemInteraction->setAppInitiated("MyAppName" [,bool $handleShutDown]): bool;

getAppInitiated()

The getAppInitiated() get info from system folder to inform if this app was set as initiated.

$systemInteraction->getAppInitiated(string $appName): bool;

setFunctionOnAppAborted()

The setFunctionOnAppAborted() will provide a method where you can add functions that must be executed before system shut down.

$systemInteraction->setFunctionOnAppAborted(callable $func): bool;

setAborted()

The setAborted() is generally used internal, but you could call this function to manually set app aborted and close script.

$systemInteraction->setAborted(void);

Install

The recommended way to install this library is through Composer. New to Composer?

This project follows SemVer. This will install the latest supported version:

$ composer require brunonatali/tools:^1.0

This project aims to run on any platform and thus does not require any PHP extensions, but actually not tested in all environments. If you find a bug, please report.

License

MIT, see LICENSE file.

brunonatali / tools

Maintainers

Details