tholcomb/symple

Yet Another Symfony-based PHP Framework

v1.0.5 2021-10-18 02:55 UTC

Requires

• php: >=7.2
• ext-json: *
• doctrine/annotations: ^1.8
• doctrine/cache: ^1.10
• monolog/monolog: ^2.0
• pimple/pimple: ^3.2
• symfony/config: ^5.0
• symfony/console: ^5.0
• symfony/dotenv: ^5.0
• symfony/error-handler: ^5.0
• symfony/event-dispatcher: ^5.0
• symfony/http-kernel: ^5.0
• symfony/routing: ^5.0
• symfony/twig-bridge: ^5.0
• twig/twig: ^3.0

Requires (Dev)

• phpunit/phpunit: ^8.5 | ^9.5

Replaces

• tholcomb/symple-core: v1.0.5
• tholcomb/symple-event: v1.0.5
• tholcomb/symple-http: v1.0.5
• tholcomb/symple-logger: v1.0.5
• tholcomb/symple-twig: v1.0.5

MIT

• Tyler Holcomb

README

Yet Another Symfony-based PHP Framework

Install

Quick install: composer require tholcomb/symple.

It is recommended to require the individual components instead of this package. e.g. composer require tholcomb/symple-http tholcomb/symple-twig

Usage

• Pimple is used for dependency injection: Docs
• Controllers use Symfony's annotation-based routing: Examples

Example:

<?php
// ./src/MyController.php

namespace MyNamespace;

use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Tholcomb\Symple\Http\AbstractController;

/** @Route("/", name="my-", methods={"GET","HEAD"}) */
class MyController extends AbstractController {
  private $log;

  public function __construct(LoggerInterface $log)
  {
    $this->log = $log;
  }

  /** @Route("/", name="home") */
  public function home(): Response
  {
    $params = [
      'api_url' => $this->url('my-api'),
    ]; 

    return $this->renderToResponse('my-template.html.twig', $params);
  }
  
  /** @Route("/api", name="api", methods={"POST"}) */
  public function api(Request $req): JsonResponse
  {
    return $this->json(['status' => 'success']);
  }
}

<?php
// ./src/MyProvider.php

namespace MyNamespace;

use Doctrine\Common\Cache\FilesystemCache;
use Pimple\Container;
use Pimple\ServiceProviderInterface;
use Tholcomb\Symple\Http\HttpProvider;
use Tholcomb\Symple\Logger\LoggerProvider;
use Tholcomb\Symple\Twig\TwigProvider;

class MyProvider implements ServiceProviderInterface {
  public function register(Container $c)
  {
    // Register the providers. In theory, these could be registered in any order
    $c->register(new LoggerProvider(), [
      'logger.path' => 'path/To/My/symple.log', // Optional - defaults to tmp_dir/symple.log
    ]);
    $c->register(new HttpProvider());
    $c->register(new TwigProvider(), [
      'twig.enable_routing' => true, // Optional - Enables generating URLs in templates
      'twig.cache_path' => 'path/To/My/Cache/', // Optional - Enables caching for Twig
    ]);
    
    $c['http.annotation_cache'] = function () { // Optional - Enable annotation cache
      return new FilesystemCache('path/To/My/Annot/Cache/'); // Must implement Doctrine\Common\Cache\Cache
    };
    
    HttpProvider::addController($c, MyController::class, function ($c) {
      return new MyController(LoggerProvider::getLogger($c, 'controller'));
    });
    TwigProvider::addTemplateDir($c, 'path/To/My/Templates/', 'optional_namespace');
  }
}

<?php
// ./bootstrap.php

namespace MyNamespace;

use Tholcomb\Symple\Core\Symple;

require_once __DIR__ . '/vendor/autoload.php';

Symple::boot(); // Enables Symfony's ErrorHandler
Symple::registerEnv('path/To/My/.env'); // Optional - Uses symfony/dotenv
Symple::enableDebug(); // Optional - Force debug mode, automatically enabled if environment var APP_ENV === 'dev'

<?php
// ./public/index.php

namespace MyNamespace;

require_once __DIR__ . '/../bootstrap.php';

use Pimple\Container;
use Tholcomb\Symple\Http\HttpProvider;

$c = new Container();
$c->register(new MyProvider());

HttpProvider::run($c);

<?php
// ./bin/console

namespace MyNamespace;

require_once __DIR__ . '/../bootstrap.php';

use Pimple\Container;
use Tholcomb\Symple\Console\ConsoleProvider;

$c = new Container();
// The ConsoleProvider must be registered first for integration with other components.
$c->register(new ConsoleProvider(), [
  'console.app.name' => 'MyName', // Optional - Set console name
  'console.app.version' => 'v0.0', // Optional - Set console version
]);
ConsoleProvider::addBuiltinCommands($c);
$c->register(new MyProvider());

ConsoleProvider::getConsole($c)->run();