district5/slimify

Slimify is a helper library for Slim Framework 4

1.6.1 2024-11-14 12:31 UTC

Requires

• php: >=8.1
• ext-json: *
• district5/simple-session-store: ^1.1
• monolog/monolog: >=2.3.5
• php-di/slim-bridge: *
• slim/php-view: *
• slim/psr7: *
• slim/slim: *

Requires (Dev)

• phpunit/phpunit: ^9

Suggests

• mongodb/mongodb: To leverage better JSON parsing functionality for mongoId method

mit

• Roger Thomas

README

Requirements...

{
    "php": ">=7.1",
    "slim/slim": "^4.0",
    "slim/php-view": "^2.2",
    "slim/psr7": "^0.5.0",
    "ext-json": "*",
    "php-di/slim-bridge": "^3.0"
}

Set up...

<?php
use DI\Container;

/**
 * Build a container
 */
$container = new Container();

/**
 * Instantiate App
 */
$app = \Slimify\SlimifyFactory::createSlimify(
    $container,
    true // Is this the 'development' environment?
);

/**
 * Add default view
 */
$app->addView(
    '/path/to/view/template/folder',
    '/path/to/view/layout.phtml',
    [], // params to inject to all views
    'default' // the view name (you can have multiple views)
);

/**
 * Add a file log.
 */
//$app->addFileLog(
//    '/path/to/log/app.log',
//    \Monolog\Logger::DEBUG,
//    1,
//    'app'
//);

/**
 * Add stdout log.
 */
$app->addStdOutLog(
    \Monolog\Logger::DEBUG,
    1,
    'app'
);

/**
 * Add router
 */
$app->addRouterWithCache(
    '/path/to/cache/routes.php',
    true
);

/**
 * Add any middleware
 */
// $app->add(new MyMiddleware());

include '/path/to/my/routes.php';

/**
 * Add any params to inject into the error views.
 */
\Slimify\SlimifyStatic::retrieve()->setErrorViewParams(
    [
        'css' => '/some/file'
    ]
);

/**
 * Add middleware for error handling
 */
$app->addErrorMiddleware(
    $app->isDevelopment(),
    true,
    true
)->setDefaultErrorHandler(
    \SlimifyMiddleware\ErrorHandlingMiddleware::class
);

/**
 * Run app
 */
$app->run();

Error handling...

Error handling expects there to be an error directory in your view template path. The following files are required:

error-access-denied.phtml
error-bad-request.phtml
error-generic.phtml
error-not-found.phtml

Usage...

In the beginning of your route, make sure you call setInterfaces, passing the request and response objects.

<?php
/* @var $app \Slimify\SlimifyInstance */

use Slim\Psr7\Request;
use Slim\Psr7\Response;

$app->get('/', function (Request $request, Response $response, $args) use ($app) {
    $app->setInterfaces($request, $response);

    return $app->getView()->render(
        $response,
        'my-view.phtml',
        [
        ]
    );
});

$app->post('/json-endpoint', function (Request $request, Response $response, $args) use ($app) {
    $app->setInterfaces($request, $response);

    $jsonParser = $app->getJsonParser();
    $mixedValue = $jsonParser->anything('someKey');
    $arrayValue = $jsonParser->array('arrayKey');
    $boolValue = $jsonParser->bool('boolKey');
    $floatValue = $jsonParser->float('floatKey');
    $intValue = $jsonParser->int('intKey');
    $stringValue = $jsonParser->string('stringKey');
    $mongoIdValue = $jsonParser->mongoId('mongoIdKey');

    // Do something with the values...

    return $app->response()->json([
        'success' => true
    ]);
])
});