https://github.com/itsgoingd/slim-facades
"Static" interface for various Slim features
https://github.com/itsgoingd/slim-facades
Last synced: over 1 year ago
JSON representation
"Static" interface for various Slim features
- Host: GitHub
- URL: https://github.com/itsgoingd/slim-facades
- Owner: itsgoingd
- Created: 2013-12-16T21:43:47.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-12-03T23:53:31.000Z (over 11 years ago)
- Last Synced: 2025-02-27T17:35:25.640Z (over 1 year ago)
- Language: PHP
- Size: 149 KB
- Stars: 74
- Watchers: 10
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-slim - 2.x - A collection of facades for Slim (Packages and Middleware / Videos)
README
SlimFacades
===========
SlimFacades is a collection of facades for [Slim PHP microframework](http://github.com/codeguy/slim), providing simple "static" interface for various Slim features.
For example, turn this:
```php
$app->get('/hello-world', function()
{
$app = Slim::getInstance();
$app->view()->display('hello.html', array('name' => $app->request()->get('name', 'world')));
})
```
Into this:
```php
Route::get('/hello-world', function()
{
View::display('hello.html', array('name' => Input::get('name', 'world')));
})
```
This library is based on the Laravel 4 Facade class, more info about facades in the [Laravel documentation](http://laravel.com/docs/facades).
## Installation
To install latest version simply add it to your `composer.json`:
```javascript
"itsgoingd/slim-facades": "dev-master"
```
Once the package is installed, you need to initialize the Facade class:
```php
require 'vendor/autoload.php';
use SlimFacades\Facade;
$app = new Slim\Slim();
// initialize the Facade class
Facade::setFacadeApplication($app);
Facade::registerAliases();
// now you can start using the facades
Config::set('debug', true);
Route::get('/hello/:name', function($name)
{
View::display('hello.html', array(
'name' => Input::get('name', $name)
));
});
App::run();
```
Following facades are available:
### App
- facade for Slim instance and following additional methods:
- _make($key)_ - returns $key from Slim's DI container
```php
$request = App::make('request');
App::flash('message', 'Som Kuli, ovladam kozmicku lod.');
App::halt();
```
### Config
- facade for Slim instance and following additional methods:
- _get($key)_ - returns value of _$app->config($key)_
- _set($key, $value = null)_ - calls _$app->config($key, $value)_
```php
$debug = Config::get('debug');
Config::set('log.enable', true);
```
### Input
- facade for Slim\Http\Request instance and following additional methods:
- _file($name)_ - returns $_FILES[$name], or null if the file was not sent in the request
```php
$username = Input::get('username', 'default');
$password = Input::post('password');
$avatar = Input::file('avatar');
```
### Log
- facade for Slim\Log instance
```php
Log::info('Tomi Popovic predava miliony albumov po celom svete.');
Log::debug('Okamizte na pozorovanie.');
```
### Request
- facade for Slim\Http\Request instance
```php
if (Request::isAjax()) { ... }
$host = Request::headers('host', 'localhost');
$path = Request::getPath();
```
### Response
- facade for Slim\Http\Response instance
```php
Response::redirect('/success');
```
### Route
- facade for Slim\Router instance and following methods:
- _map, get, post, put, patch, delete, options, group, any_ - calls the methods on Slim instance
```php
Route::get('/users/new', 'UsersController:index');
Route::post('/users', 'UsersController:insert');
```
### View
- facade for Slim\View instance
```php
View::display('hello.html');
$output = View::render('world.html');
```
### Custom facades
You can create a custom facades by extending `SlimFacades\Facade` class.
```php
class MyFacade extends SlimFacades\Facade
{
// return the name of the component from the DI container
protected static function getFacadeAccessor() { return 'my_component'; }
}
```
You can register custom facades by passing the aliases to the _Facade::registerAliases()_ function.
```php
Facade::registerAliases(array(
'App' => 'SlimFacades\App',
'Config' => 'SlimFacades\Config',
'Input' => 'SlimFacades\Input',
// 'Log' => 'SlimFacades\Log',
'Log' => 'CustomLogFacade',
'Request' => 'SlimFacades\Request',
'Response' => 'SlimFacades\Response',
'Route' => 'SlimFacades\Route',
'View' => 'SlimFacades\View',
));
```
Note that calling _Facade::registerAliases()_ with a list of aliases will register ONLY the specified facades, if you want to register default facades as well as custom ones, you can call the function two times, with and without the array argument.
## Links
- [SlimStatic](https://github.com/johnstevenson/slim-static) - alternative implementation with similar API, without dependency on Laravel components by [John Stevenson](https://github.com/johnstevenson)
## Licence
Copyright (c) 2013 Miroslav Rigler
MIT License
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.