Download the PHP package jupitern/slim3-skeleton without Composer

Slim Framework 3 Skeleton Application (http + cli)

Use this skeleton application to quickly setup and start working on a new Slim Framework 3 application (Tested with slim 3.12). This application handles http and command line requests. This application ships with a few service providers and a session middleware out of the box. Support for container resolution and auto-wiring.

To remove a service provider comment it on config/app.php file and remove it from composer.json, update composer.

Available service providers:

• SlashTrace
• Monolog
• Eloquent
• Plates
• Twig
• Flysystem
• PHPMailer
• Redis

Available middleware:

• Session

Install the Application

Run this command from the directory in which you want to install your new Slim Framework application.

php composer.phar create-project jupitern/slim3-skeleton [my-app-name]

Replace [my-app-name] with the desired directory name for your new application. You'll want to:

• Point your virtual host document root to your new application's public/ directory.
• Ensure storage/ is web writable.
• make the necessary changes in config file config/app.php

Run it:

1. $ cd [my-app-name]\public
2. $ php -S localhost:8080 OR $ composer serve
3. Browse to http://localhost:8080

Key directories

• app: Application code (models, controllers, cli commands, handlers, middleware, service providers and others)
• config: Configuration files like db, mail, routes...
• lib: Other project classes like utils, business logic and framework extensions
• storage: Log files, cache files and your raw, un-compiled assets such as LESS, SASS, or JavaScript.
• public: The public directory contains index.php file, assets such as images, JavaScript, and CSS
• views: Views template files.
• vendor: Composer dependencies

Routing and dependency injection

The app class has a route resolver method that:

• matches and injects params into the controller action passed as uri arguments
• looks up and injects dependencies from the container by matching controller constructor / method argument class names
• automatic Resolution using controller constructor / method argument types
• accepts string or Response object as controller action response

Example defining two routes for a website and backend folders:

Console usage

• Usage: php cli.php [command-name] [method-name] [parameters...]
• Help: php cli.php help

How to create a new command:

1. Create a class under directory app\Console in namespace App\Console
2. Your class should extend \App\Console\Command
3. create a public method with some params.
4. DONE!

Example:

Command class:

Execute the class:method from command line:

Code examples

Get application instance

Debug a variable, array or object using the debug helper function

Read a user from db using Laravel Eloquent service provider

Send a email using PHPMailer service provider service named 'mail' on config file

List a directory content with Flysystem service provider named 'fs_local' on config file

Write and read from session using Session Helper class

Write and read from cache with Redis service provider named 'redis' on config file

Changelog

v3.0

• moved core code to another package.
• route resolution using reflection can now be switched off for performance.
• config file services changed structure.
• register services in container using a string instead of classnames.
• code refactor and improvements.

v2.6

• Replaced Whoops and Collision packages by slashtrace that provides http and cli debug

V2.5

• Allow for providers and middleware to be registered only for a given scope (dependent on app name)
• general code improvements and error handling when developing rest api

Roadmap

• [ ] more service providers / separate service providers in packages
• [ ] more code examples

Contributing

• welcome to discuss a bugs, features and ideas.

License

jupitern/slim3-skeleton is release under the MIT license.