Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grobmeier/cicada
Cicada lightweight php framework
https://github.com/grobmeier/cicada
Last synced: about 2 months ago
JSON representation
Cicada lightweight php framework
- Host: GitHub
- URL: https://github.com/grobmeier/cicada
- Owner: grobmeier
- License: apache-2.0
- Created: 2013-12-09T11:57:19.000Z (about 11 years ago)
- Default Branch: develop
- Last Pushed: 2017-05-09T12:41:03.000Z (over 7 years ago)
- Last Synced: 2024-11-01T08:50:45.820Z (about 2 months ago)
- Language: PHP
- Size: 473 KB
- Stars: 7
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Cicada
======
A micro framework for creating traditional or REST-like web applications.
[](https://packagist.org/packages/cicada/cicada) [](https://packagist.org/packages/cicada/cicada) [](https://travis-ci.org/cicada/cicada) [](https://coveralls.io/r/cicada/cicada) [](https://packagist.org/packages/cicada/cicada)
Installation
------------
Add Cicada as a requirement for your project via Composer:
```
composer require "cicada/cicada=@stable"
```
Usage
-----
Minimal application:
```php
require '../vendor/autoload.php';
use Cicada\Application;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
$app = new Application();
// Add a route
$app->get('/hello/{name}', function (Application $app, Request $request, $name) {
return new Response("Hello $name");
});
$app->run();
```
This application has one route which will match GET requests starting with
`/hello/` and will forward the matched `{name}` into the callback function as
`$name`.
The callback function should return a
[Response](http://symfony.com/doc/current/components/http_foundation/introduction.html#response)
object. If it returns a string, it will implicitly be converted into a Response.
Handling exceptions
-------------------
It is possible that route callbacks throw an exception. By default, Cicada will
in this case return a HTTP 500 response (Internal Server Error). However, it
is possible to add exception handlers which will intercept specific exceptions
and return an appropriate response.
For example, if you want to catch a custom NotImplementedException and return a
custom error message:
```php
$app->exception(function (NotImplementedException $ex) {
$msg = "Dreadfully sorry, old chap, but tis' not implemented yet.";
return new Response($msg, Response::HTTP_INTERNAL_SERVER_ERROR);
});
```
The callback function passed to `$app->exception()` must have a single argument
and that argument must have a class type hint which denotes the exception class
which it will handle.
It's possible to specify multiple exception handlers and they will be tried in
order in which they were specified:
```php
$app->exception(function (SomeException $ex) {
return new Response("Arrrghhhhh", Response::HTTP_INTERNAL_SERVER_ERROR);
});
$app->exception(function (OtherException $ex) {
return new Response("FFFFUUUUUUU...", Response::HTTP_INTERNAL_SERVER_ERROR);
});
// If all else fails, this will catch any exceptions
$app->exception(function (Exception $ex) {
$msg ="Something went wrong. The incident has been logged and our code monkeys are on it.";
return new Response($msg, Response::HTTP_INTERNAL_SERVER_ERROR);
});
```