Gravity

Gravity is a service and configuration manager for everyone. It makes it easy to use other people's settings and services in your application, no framework required!

Usage

First, let's write a simple service in this repository (services are usually much more complex and stored in a separate repository):

# /path/to/jstewmc/gravity/examples/src/Service/Foo.php

namespace Jstewmc\Gravity\Example\Service;

class Foo
{
    public function __invoke(): string
    {
        return 'foo';
    }
}

Next, let's define our service and a setting in a Gravity file (since the example service is in this repository so is the .gravity directory):

# /path/to/jstewmc/gravity/.gravity/examples/first.php

namespace Jstewmc\Gravity\Example\Service;

// here, we define a _service_ named "Jstewmc\Gravity\Example\Service\Foo" with
//   an anonymous function
// when the service is requested, Gravity will invoke the function and return
//   its return value, an instance of Jstewmc\Gravity\Example\Service\Foo
//
$g->set(Foo::class, function (): Foo {
    return new Foo();
});

// here, we define a _setting_ named "jstewmc.gravity.example.foo"
// when the setting is requested, Gravity will return its value, true
//
$g->set('jstewmc.gravity.example.foo', true);

Now, use your service (this example is a little verbose since it's a plain old PHP script):

# /path/to/jstemwc/gravity/examples/first.php

namespace Jstewmc\Gravity\Example\Service;

use Jstewmc\Gravity\Gravity;

require_once realpath(__DIR__ . '/../vendor/autoload.php');

// instantiate Gravity
$g = (new Gravity())->pull();

// Gravity returns the "Jstewmc\Gravity\Example\Service\Foo" _service_
assert($g->get(Foo::class) instanceof Foo);

// Gravity returns the "jstewmc.gravity.example.foo" value
$expected = true;
$actual   = $g->get('jstewmc.gravity.example.foo');

assert($expected == $actual);

That's it!

Of course, this was just a simple example. Imagine getting and setting services and settings in any package! That's the power of Gravity. It just pulls everything together!

Examples

You can run the example above (and most examples in the documentation), by cloning the repository to your computer, navigating to it on your filesystem, and using the PHP command line. Most examples use assert() statements, and will output nothing when successful, unless stated otherwise.

# navigate to a directory on your computer
$ cd ~/projects

# clone the repository to your computer
~/projects $ git clone https://github.com/jstewmc/gravity.git

# navigate to the repository
~/projects $ cd gravity

# run the first example
~/projects/gravity $ php examples/first.php

Documentation

Documentation is available online or in the docs directory.

We strive to maintain great documentation. If you see a mistake or have a suggestion, feel free to fork it!

Installation

Gravity requires PHP 7.2+.

Gravity is multi-platform, and we strive to make it run equally well on Windows, Linux, and OSX.

Gravity must be installed via Composer. To do so, add the following line to the require section of your composer.json file (where x is the latest major version), and run composer update:

{
   "require": {
       "jstewmc/gravity": "^x"
   }
}

Compliance

This library strives to adhere to the following standards:

If you spot an error, please let us know!

License

This library is licensed under the MIT license.

Credits

This library was originally developed by Jack Clayton with input from good friends like Andy O'brien and Harry Wallin.

We hope you enjoy it!

javabudd/gravity