Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A RESTful micro framework for PHP 5 inspired by Sinatra

This branch is 779 commits behind slimphp:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
Slim
tests
.htaccess
README.markdown
index.php
logo.png

README.markdown

Slim Framework for PHP 5

Thank you for choosing the Slim Framework, a micro framework for PHP 5 inspired by Sinatra released under the MIT public license.

Features

The Slim Framework for PHP 5 provides the following notable features out-of-the-box:

  • Clean and simple DSL for writing powerful web applications
  • HTTP routing
    • Supports all standard and custom HTTP request methods
    • Named routes w/ urlFor() helper
    • Route passing
    • Route redirects
    • Route halting
    • Custom Not Found handler
    • Custom Error handler
    • Optional route segments... /archive(/:year(/:month(/:day)))
  • Easy app configuration
  • Easy templating with custom Views (ie. Twig, Smarty, Mustache, ...)
  • Secure sessions
  • Signed cookies with AES-256 encryption
  • Flash messaging
  • HTTP caching (ETag and Last-Modified)
  • Logging
  • Error and Exception handling
  • Supports PHP 5+

"Hello World" application (PHP 5 >= 5.3)

The Slim Framework for PHP 5 supports anonymous functions. This is the preferred method of defining Slim application routes.

<?php
require 'Slim/Slim.php';
$app = new Slim();
$app->get('/hello/:name', function ($name) {
    echo "Hello, $name!";
});
$app->run();
?>

"Hello World" application (PHP 5 < 5.3)

If you are running PHP 5 < 5.3, the second Slim::get app instance method parameter will be the name of a callable function instead of an anonymous function.

<?php
require 'Slim/Slim.php';
$app = new Slim();
$app->get('/hello/:name', 'hello');
function hello($name) {
    echo "Hello, $name!";
}
$app->run();
?>

Get Started

Install Slim

Download the Slim Framework for PHP 5 and unzip the downloaded file into your virtual host's public directory. Slim will work in a sub-directory, too.

Setup .htaccess

Ensure the .htaccess and index.php files are in the same public-accessible directory. The .htaccess file should contain this code:

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ index.php [QSA,L]

Build Your Application

Your Slim application will be defined in index.php. First, require the Slim Framework:

require 'Slim/Slim.php';

Next, initialize the Slim application:

$app = new Slim();

Next, define your application's routes:

$app->get('/hello/:name', function ($name) {
    echo "Hello $name";
});

Finally, run your Slim application:

$app->run();

For more information about building an application with the Slim Framework, refer to the official documentation.

Documentation

Stable Branch Documentation Development Branch Documentation

Community

Forum

Join the Slim Framework official forum at http://forum.slimframework.com where you can find announcements, chat with fellow Slim users, ask questions, help others, or show off your cool Slim Framework apps. Membership is free; create an account or login with OpenID or your Google account.

Twitter

Follow @slimphp on Twitter to receive the very latest news and updates about the framework.

IRC

You can find me, Josh Lockhart, hanging out in the ##slim chat room during the day. Feel free to say hi, ask questions, or just hang out. If you're on a Mac, check out Colloquy; if you're on a PC, check out mIRC; if you're on Linux, I'm sure you already know what you're doing.

Resources

Additional resources (ie. custom Views and plugins) are available online in a separate repository.

https://github.com/codeguy/Slim-Extras

Here are more links that may also be useful.

About the Author

Slim is created and maintained by Josh Lockhart, a web developer by day at New Media Campaigns, and a hacker by night.

Slim is in active development, and test coverage is continually improving.

Open Source License

Slim is released under the MIT public license.

http://www.slimframework.com/license

Something went wrong with that request. Please try again.