rican7 / paulus

A PHP micro-framework for creating RESTful services

Paulus

A PHP micro-framework (well, more like a "mini" framework) for creating RESTful API services quickly and efficiently. Its meant to work as a sort of "boilerplate" for REST-like API services in PHP.

Getting Started

• PHP 5.4.x is required
• Download the current stable release
• Setup URL rewriting for the routing engine (Klein)
• Configure the framework to your needs
• Create a route (and optionally, a controller) and start hitting your newly created API!

Attributions

• One Mighty Roar - For giving me the "20% time" to create this, the influence in its development direction, and the trust for using this internally.
• Plymouth WebApp - Much of the structure/organization was originally (it has since deviated pretty significantly) inspired by or taken and modified from the MIS team at Plymouth State University, with most of the credit going to past member's of the team: Matthew Batchelder and Adam Backstrom
• Klein.php - URL routing provided by Klein
  • Copyright (c) 2010 Chris O'Hara [email protected]
• PHP ActiveRecord - ActiveRecord style database access pattern
  • Copyright (c) 2009 Kien La and Jacques Fuentes

paulus's Issues

"Configure" link in the README is a 404

Nested string replace causing unnecessary removals in "Paulus::parse()"

Currently, the parse() method does a nested str_replace on the built-in "{ENDPOINT}" template key.

If the base-url is simply "/", though, this removes all slashes from the endpoint. Yea, bad.

Simply changing:

$processed_string = str_replace( '{ENDPOINT}',
    str_replace( $this->config['app-meta']['base_url'], '', parse_url($this->request->uri(), PHP_URL_PATH) ),
    $processed_string
);

to this:

$processed_string = str_replace( '{ENDPOINT}',
    ltrim( parse_url($this->request->uri(), PHP_URL_PATH), $this->config['app-meta']['base_url'] ),
    $processed_string
);

should do the trick.

JsonResponse should implement JsonSerializable

The Paulus\Response\JsonResponse should implement the newly available (since PHP 5.4) JsonSerializable class.

I'm thinking that instead of encoding the body every time new data is set on the JsonResponse class to instead have some sort of preparation before sending based on whether the class implements the JsonSerializable interface or not. Maybe some sort of middleware layer? Not sure.

Namespace issue on default "Exception" throw

The \Paulus\Paulus class contains a call to throw a new "Exception" in the abort method. Unfortunately, since \Paulus\Paulus is under a namespace, "Exception" isn't resolving.

Simply add a "use" statement to the top of the class for "\Exception", and profit.