drpheltright/lily

A lightweight web application library for PHP.

Lily

A lightweight web application library for PHP 5.3+., _(*1)

Lily provides your application with a common sense interface to HTTP. She also provides routing, exception handling, dependency injection and more. This project is inspired by the design of [ring][ring], especially in regards to the use of higher order functions and middleware., _(*2)

Lil' Lily has very little to her weighing in at 1019LOC. She aims to be readable in one sitting., _(*3)

``` php <?php require DIR.'/vendor/autoload.php';, <sub>(*4)</sub>

// Lily provides building blocks for applications like routing $handler = new Lily\Application\RoutedApplication([ // Define your routes as plain arrays 'routes' => [['GET', '/', 'Hello world']], ]);, <sub>(*5)</sub>

// Serve your application over HTTP (new Lily\Adapter\HTTP)->run(compact('handler')); ?>, <sub>(*6)</sub>

*This example uses PHP 5.4 as do all examples found in the [wiki][wiki]. Lily
supports 5.3+ though so you can backport examples.*

A slightly more complex example can be found in [`/example`][example].

[ring]: https://github.com/ring-clojure/ring
[wiki]: https://github.com/DrPheltRight/lily/wiki/000-overview
[example]: https://github.com/DrPheltRight/lily/blob/develop/example/

## Why Lily?

Because she's different. She doesn't enforce you to obide by interfaces and
implement classes in a rigid fashion that is tightly coupled to a framework. She
instead provides the same functionality with less restriction.

By providing decoupled components that behave like ordinary functions, by
representing requests and responses as hashes, she doesn't tie you to complex
interfaces that force you to stay with a framework.

Ultimately she provides you the flexibility to grow your application in whatever
way you want by providing all the components you need without fencing you in
a framework. With Lily you can compose a framework yourself.

## Installation

Installing Lily through [composer][composer] is easy. Just create a
`composer.json` file in a new directory for your application:

```json
{
    "require": {
        "drpheltright/lily": "~0.7.0"
    }
}

Now run the following command in that directory:, <sub>(*7)</sub>

curl -s https://getcomposer.org/installer | php && php composer.phar install

Done!, <sub>(*8)</sub>

Documentation

• Start here
• Basics
• Routing
• Middleware
  • Error handling
  • Dependency injection
  • Default headers
  • Cookies
  • Sessions
  • Flash

Tests

[][coveralls], <sub>(*9)</sub>

To run the test suite, you need composer and it will handle the rest. Lily unit tests are written with PHPUnit., <sub>(*10)</sub>

php composer.phar install --dev
vendor/bin/phpunit

We try and keep coverage high and no feature is added without some kind of test., <sub>(*11)</sub>

Development

All development should be done via GitHub Issues. New features should be suggested/planned there and can be identified by the feature tag. Also bugs should be reported with the bug label., <sub>(*12)</sub>

I'd like some development help with new features. I've labelled the features that people are welcome to hack at with please help. If a task isn't labelled please just comment to ask if you want to help out., <sub>(*13)</sub>

Features must be tested before pull requests opened., <sub>(*14)</sub>

License

Copyright © 2014 Luke Morton, <sub>(*15)</sub>

Distributed under MIT. See LICENSE distributed with Lily for more information. TL;DR, Keep the license found at the top of each Lily file with significant chunks of code you want to reuse., <sub>(*16)</sub>