slimphp/slim-documentation

Old Slim Framework 3 documentation

slim-documentation's Issues

Documentation in progress?

Any update when you will have documentation sorted in full?

Incorrect instructions for slim/twig-view

According to http://docs-new.slimframework.com/features/templates/ ("Register the view service"), the code to use is:

// Create Slim app
$app = new \Slim\App();

// Register Twig View service
$app->register(new \Slim\Views\Twig('path/to/templates', [
    'cache' => 'path/to/cache'
]));

However that throws a fatal error Call to undefined method Slim\App::register().

From the readme at https://github.com/slimphp/Twig-View it seems the correct code is actually:

// Create Slim app
$app = new \Slim\App();

// Fetch DI Container
$container = $app->getContainer();

// Register Twig View helper
$container->register(new \Slim\Views\Twig('path/to/templates', [
    'cache' => 'path/to/cache'
]));

.. which seems to at least get rid of the error.

Recommendation to install using `composer require`

I tried to find where the installation document was to make a PR but have failed.

My suggestion is to recommend that rather than manually creating composer.json then copying and pasting from the file, simply use composer require slim/slim to install and Composer will create the file for you.

A chapter on testing

Hey,

We should add a chapter on testing, so people can learn and improve their code.

Thanks

Section on caching

Does the section on caching just need to get updated to show how to use slim/http-cache?

Injecting view

Hi,

I think it is good to show how to inject a Twig view rather than calling $this['view'] inside controller / anonymous function.

$app->get('/hello/{name}', function ($request, $response, $args) {
    $this['view']->render('profile.html', [
        'name' => $args['name']
    ]);
})->setName('profile');

The idea is even if we are using a different framework, we can make use of the code without changes.

Adding Content-Type description

New users often seem confused regarding how slim populates params()/get()/post(). Content-Type application/json isn't supported by default, and users have been posting to a route with json data and not receiving anything from request->post().

We should improve the documentation with examples on how to correctly POST application/json data to a slim route, and now to receive that data.