契約インターフェース (Slim\Interfaces\*)

Slim\Interfaces 名前空間（Slim/Interfaces/ 配下の全 17 ファイル・17 インターフェース）は、Slim Framework v4.15.3 の全サブシステムを疎結合化するアーキテクチャ契約群を定義します。PSR-17 ファクトリ自動検出、PSR-11 コンテナ連携の Callable 解決、LIFO 順の PSR-15 ミドルウェアディスパッチ、FastRoute による正規表現ルーティング、ルート呼び出しストラテジ、およびコンテンツネゴシエーション対応のエラー描画のすべてがインターフェース背後に抽象化されており、AppFactory または DI コンテナを通じて任意のカスタム実装へ差し替えることができます。

from drawlib.canvas import save, setup
from drawlib.icons import phosphor
from drawlib.smartarts import CardList, Panel
from drawlib.styles import Colors, Styles

setup(width=196, height=90, dpi=150)

# Left Panel: Routing & FastRoute Dispatching Contracts (7 Interfaces)
p_left = Panel(
    "ルーティング・ディスパッチ契約 (7 種)",
    "",
    style=Styles.Neutral.patch(shape_r=2.0),
    header_style=Styles.PrimaryNeutral.patch(shape_line_width=1.2),
    text_style=Styles.DarkBold.patch(text_size=11.0),
    icon=phosphor.git_branch,
    icon_style=Styles.PrimaryBold,
    header_variant="filled",
    header_height=8.6,
)
p_left.draw((4.0, 4.0), width=92.0, height=82.0)
lx, lw, lh = p_left.get_content_box((4.0, 4.0), width=92.0, height=82.0, padding=(3.5, 3.0))

cl_left = CardList(
    style=Styles.White,
    text_style=Styles.DarkBold.patch(text_size=10.5),
    description_style=Styles.Dark.patch(text_size=10.0),
    badge_shape="rounded_rect",
    badge_style=Styles.PrimaryNeutral,
    badge_text_style=Styles.PrimaryBold.patch(text_size=10.0),
    icon_style=Styles.PrimaryBold,
    direction="vertical",
    spacing=2.6,
    show_arrows=True,
    arrow_style=Styles.DarkBold.patch(line_arrow_head_scale=10, line_width=1.4),
)
cl_left.add(
    "RouteCollectorProxy & RouteCollector",
    "HTTP メソッド別のルート登録 (get/post/map/group)",
    badge_text="R1",
    icon=phosphor.compass,
    style=Styles.PrimaryFlat,
    text_style=Styles.WhiteBold.patch(text_size=10.5),
    description_style=Styles.White.patch(text_size=10.0),
    badge_style=Styles.White,
    badge_text_style=Styles.PrimaryBold.patch(text_size=10.0),
    icon_style=Styles.PrimaryBold,
)
cl_left.add(
    "RouteInterface & RouteGroupInterface",
    "ルート／グループ単位のミドルウェアと run()",
    badge_text="R2",
    icon=phosphor.brackets_curly,
    style=Styles.PrimaryNeutral,
)
cl_left.add(
    "RouteParserInterface",
    "名前付きルートからの逆引き URL 生成 (urlFor)",
    badge_text="R3",
    icon=phosphor.link,
)
cl_left.add(
    "RouteResolver & DispatcherInterface",
    "FastRoute URI 照合 -> RoutingResults 返却",
    badge_text="R4",
    icon=phosphor.lightning,
    style=Styles.SecondaryNeutral,
    badge_style=Styles.White.patch(shape_line_color=Colors.Gray4),
    badge_text_style=Styles.DarkBold.patch(text_size=10.0),
)
cl_left.draw(xy=lx, width=lw, height=lh)

# Right Panel: PSR-17, Callable, Middleware & Error Contracts (10 Interfaces)
p_right = Panel(
    "PSR-17・Callable・ミドルウェア・エラー契約 (10 種)",
    "",
    style=Styles.Neutral.patch(shape_r=2.0),
    header_style=Styles.SecondaryNeutral.patch(shape_line_width=1.2),
    text_style=Styles.DarkBold.patch(text_size=11.0),
    icon=phosphor.plugs_connected,
    icon_style=Styles.SecondaryBold,
    header_variant="filled",
    header_height=8.6,
)
p_right.draw((100.0, 4.0), width=92.0, height=82.0)
rx, rw, rh = p_right.get_content_box((100.0, 4.0), width=92.0, height=82.0, padding=(3.5, 3.0))

cl_right = CardList(
    style=Styles.White,
    text_style=Styles.DarkBold.patch(text_size=10.5),
    description_style=Styles.Dark.patch(text_size=10.0),
    badge_shape="rounded_rect",
    badge_style=Styles.SecondaryNeutral,
    badge_text_style=Styles.DarkBold.patch(text_size=10.0),
    icon_style=Styles.SecondaryBold,
    direction="vertical",
    spacing=2.6,
)
cl_right.add(
    "Psr17Factory・Provider・RequestCreator",
    "PSR-17 ファクトリ自動検出と SAPI リクエスト生成",
    badge_text="P17",
    icon=phosphor.factory,
)
cl_right.add(
    "CallableResolver & AdvancedCallable",
    "'Class:method' 表記および DI サービスの解決",
    badge_text="DI",
    icon=phosphor.code,
    style=Styles.PrimaryNeutral,
)
cl_right.add(
    "MiddlewareDispatcher & Strategies",
    "LIFO 型 PSR-15 スタックと 2 種の呼び出し契約",
    badge_text="P15",
    icon=phosphor.stack,
    style=Styles.AccentFlat,
    text_style=Styles.WhiteBold.patch(text_size=10.5),
    description_style=Styles.White.patch(text_size=10.0),
    badge_style=Styles.White,
    badge_text_style=Styles.DarkBold.patch(text_size=10.0),
    icon_style=Styles.SecondaryBold,
)
cl_right.add(
    "ErrorHandler & ErrorRendererInterface",
    "例外 -> PSR-7 レスポンス変換と MIME 文字列描画",
    badge_text="Err",
    icon=phosphor.shield_warning,
    style=Styles.SecondaryNeutral,
    badge_style=Styles.White.patch(shape_line_color=Colors.Gray4),
    badge_text_style=Styles.DarkBold.patch(text_size=10.0),
)
cl_right.draw(xy=rx, width=rw, height=rh)

save()

Slim\Interfaces\* 全 17 インターフェース一覧表#

from drawlib.canvas import save, setup
from drawlib.icons import phosphor
from drawlib.smartarts import CardList, Panel
from drawlib.styles import Colors, Styles

setup(width=196, height=84, dpi=150)

# Left Panel: 3 Specialized Sub-Interface Extensions
p_left = Panel(
    "サブインターフェース拡張ペア (3 組)",
    "",
    style=Styles.Neutral.patch(shape_r=2.0),
    header_style=Styles.PrimaryNeutral.patch(shape_line_width=1.2),
    text_style=Styles.DarkBold.patch(text_size=11.0),
    icon=phosphor.git_fork,
    icon_style=Styles.PrimaryBold,
    header_variant="filled",
    header_height=8.6,
)
p_left.draw((4.0, 4.0), width=92.0, height=76.0)
lx, lw, lh = p_left.get_content_box((4.0, 4.0), width=92.0, height=76.0, padding=(3.5, 3.0))

cl_left = CardList(
    style=Styles.White,
    text_style=Styles.DarkBold.patch(text_size=10.5),
    description_style=Styles.Dark.patch(text_size=10.0),
    badge_shape="rounded_rect",
    badge_style=Styles.PrimaryNeutral,
    badge_text_style=Styles.PrimaryBold.patch(text_size=10.0),
    icon_style=Styles.PrimaryBold,
    direction="vertical",
    spacing=2.8,
)
cl_left.add(
    "MiddlewareDispatcherInterface",
    "PSR-15 RequestHandlerInterface を継承",
    badge_text="P15",
    icon=phosphor.stack,
    style=Styles.PrimaryFlat,
    text_style=Styles.WhiteBold.patch(text_size=10.5),
    description_style=Styles.White.patch(text_size=10.0),
    badge_style=Styles.White,
    badge_text_style=Styles.PrimaryBold.patch(text_size=10.0),
    icon_style=Styles.PrimaryBold,
)
cl_left.add(
    "AdvancedCallableResolverInterface",
    "CallableResolverInterface を拡張 (+2 メソッド)",
    badge_text="DI",
    icon=phosphor.plugs_connected,
    style=Styles.PrimaryNeutral,
)
cl_left.add(
    "RequestHandlerInvocationStrategy",
    "InvocationStrategyInterface のマーカー拡張",
    badge_text="Tag",
    icon=phosphor.tag,
)
cl_left.draw(xy=lx, width=lw, height=lh)

# Right Panel: Default Kernel Wiring in App::__construct()
p_right = Panel(
    "App::__construct() の既定実装配線",
    "",
    style=Styles.Neutral.patch(shape_r=2.0),
    header_style=Styles.SecondaryNeutral.patch(shape_line_width=1.2),
    text_style=Styles.DarkBold.patch(text_size=11.0),
    icon=phosphor.gear,
    icon_style=Styles.SecondaryBold,
    header_variant="filled",
    header_height=8.6,
)
p_right.draw((100.0, 4.0), width=92.0, height=76.0)
rx, rw, rh = p_right.get_content_box((100.0, 4.0), width=92.0, height=76.0, padding=(3.5, 3.0))

cl_right = CardList(
    style=Styles.White,
    text_style=Styles.DarkBold.patch(text_size=10.5),
    description_style=Styles.Dark.patch(text_size=10.0),
    badge_shape="rounded_rect",
    badge_style=Styles.SecondaryNeutral,
    badge_text_style=Styles.DarkBold.patch(text_size=10.0),
    icon_style=Styles.SecondaryBold,
    direction="vertical",
    spacing=2.8,
    show_arrows=True,
    arrow_style=Styles.DarkBold.patch(line_arrow_head_scale=10, line_width=1.4),
)
cl_right.add(
    "CallableResolverInterface",
    "省略時は new CallableResolver(container) を生成",
    badge_text="W1",
    icon=phosphor.code,
)
cl_right.add(
    "RouteCollector & RouteResolverInterface",
    "省略時は RouteCollector + RouteResolver を生成",
    badge_text="W2",
    icon=phosphor.compass,
    style=Styles.SecondaryNeutral,
)
cl_right.add(
    "MiddlewareDispatcherInterface",
    "RouteRunner を核として PSR-15 オニオンを構成",
    badge_text="W3",
    icon=phosphor.play_circle,
    style=Styles.AccentFlat,
    text_style=Styles.WhiteBold.patch(text_size=10.5),
    description_style=Styles.White.patch(text_size=10.0),
    badge_style=Styles.White,
    badge_text_style=Styles.DarkBold.patch(text_size=10.0),
    icon_style=Styles.SecondaryBold,
)
cl_right.draw(xy=rx, width=rw, height=rh)

save()

interfaceSlim\Interfaces\AdvancedCallableResolverInterface#

• ソースファイル: Slim/Interfaces/AdvancedCallableResolverInterface.php
• 名前空間: Slim\Interfaces
• 継承元 (extends): Slim\Interfaces\CallableResolverInterface
• 既定実装クラス: Slim\CallableResolver
• 主な参照元: Slim\MiddlewareDispatcher, Slim\Routing\Route, Slim\Routing\RouteGroup, Slim\Middleware\ErrorMiddleware, Slim\Handlers\ErrorHandler

CallableResolverInterface を拡張し、呼び出し文脈に応じた解決メソッド（resolveRoute() および resolveMiddleware()）を追加する契約です。:method サフィックスを持たない単一のクラス名やコンテナサービス ID が渡された際、CallableResolver は resolveRoute() では PSR-15 RequestHandlerInterface::handle を、resolveMiddleware() では PSR-15 MiddlewareInterface::process を優先的にバインドします。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

interface AdvancedCallableResolverInterface extends CallableResolverInterface
{
    /**
     * Resolve $toResolve into a callable
     *
     * @param callable|array{class-string, string}|string $toResolve
     */
    public function resolveRoute($toResolve): callable;

    /**
     * Resolve $toResolve into a callable
     *
     * @param callable|array{class-string, string}|string $toResolve
     */
    public function resolveMiddleware($toResolve): callable;
}

メソッド・引数一覧#

使用例#

use Slim\CallableResolver;
use Slim\Interfaces\AdvancedCallableResolverInterface;

/** @var AdvancedCallableResolverInterface $resolver */
$resolver = new CallableResolver($container);

// PSR-15 RequestHandlerInterface 実装クラス名を [$instance, 'handle'] へ解決:
$routeCallable = $resolver->resolveRoute(ShowUserAction::class);

// PSR-15 MiddlewareInterface 実装クラス名を [$instance, 'process'] へ解決:
$middlewareCallable = $resolver->resolveMiddleware(AuthMiddleware::class);

interfaceSlim\Interfaces\CallableResolverInterface#

• ソースファイル: Slim/Interfaces/CallableResolverInterface.php
• 名前空間: Slim\Interfaces
• 拡張先サブインターフェース: Slim\Interfaces\AdvancedCallableResolverInterface
• 既定実装クラス: Slim\CallableResolver

文字列記法（'Class:method'、'Class::method'、または PSR-11 コンテナのサービス識別子）、['Class', 'method'] 配列、または __invoke() を実装したクラスを実行可能な PHP callable へ解決する基底契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

interface CallableResolverInterface
{
    /**
     * Resolve $toResolve into a callable
     *
     * @param callable|array{class-string, string}|string $toResolve
     */
    public function resolve($toResolve): callable;
}

メソッド・引数一覧#

使用例#

use Slim\CallableResolver;
use Slim\Interfaces\CallableResolverInterface;

/** @var CallableResolverInterface $resolver */
$resolver = new CallableResolver($container);

// Slim 固有の 'Class:method' 表記を DI コンテナまたは new HomeController() で解決:
$callable = $resolver->resolve('App\Controller\HomeController:index');

interfaceSlim\Interfaces\DispatcherInterface#

• ソースファイル: Slim/Interfaces/DispatcherInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Routing\Dispatcher
• 主な参照元: Slim\Routing\RouteResolver, Slim\Routing\RoutingResults

内部の URL ルーティングエンジン（FastRoute の FastRouteDispatcher）をラップし、HTTP メソッドと URI パスの照合結果（Slim\Routing\RoutingResults）および対象 URI で許可されている HTTP メソッド一覧を返す契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Slim\Routing\RoutingResults;

interface DispatcherInterface
{
    /**
     * Get routing results for a given request method and uri
     */
    public function dispatch(string $method, string $uri): RoutingResults;

    /**
     * Get allowed methods for a given uri
     *
     * @return string[]
     */
    public function getAllowedMethods(string $uri): array;
}

メソッド・引数一覧#

使用例#

use Slim\Interfaces\DispatcherInterface;
use Slim\Routing\Dispatcher;
use Slim\Routing\RoutingResults;

/** @var DispatcherInterface $dispatcher */
$dispatcher = new Dispatcher($routeCollector);

$results = $dispatcher->dispatch('GET', '/users/42');
if ($results->getRouteStatus() === RoutingResults::FOUND) {
    $routeId = $results->getRouteIdentifier();
    $args = $results->getRouteArguments(); // ['id' => '42']
}

interfaceSlim\Interfaces\ErrorHandlerInterface#

• ソースファイル: Slim/Interfaces/ErrorHandlerInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Handlers\ErrorHandler
• 主な参照元: Slim\Middleware\ErrorMiddleware

ErrorMiddleware に登録される例外ハンドラの呼び出し契約です。捕捉された \Throwable、発生時の PSR-7 ServerRequestInterface、および 3 つの詳細表示・ログ出力フラグを受け取り、エラー応答となる PSR-7 ResponseInterface を返します。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Throwable;

interface ErrorHandlerInterface
{
    public function __invoke(
        ServerRequestInterface $request,
        Throwable $exception,
        bool $displayErrorDetails,
        bool $logErrors,
        bool $logErrorDetails
    ): ResponseInterface;
}

メソッド・引数一覧#

使用例#

use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Slim\Interfaces\ErrorHandlerInterface;
use Throwable;

final class CustomJsonErrorHandler implements ErrorHandlerInterface
{
    private ResponseFactoryInterface $responseFactory;

    public function __construct(ResponseFactoryInterface $responseFactory)
    {
        $this->responseFactory = $responseFactory;
    }

    public function __invoke(
        ServerRequestInterface $request,
        Throwable $exception,
        bool $displayErrorDetails,
        bool $logErrors,
        bool $logErrorDetails
    ): ResponseInterface {
        $response = $this->responseFactory->createResponse(500);
        $payload = ['error' => $displayErrorDetails ? $exception->getMessage() : 'Server Error'];
        $response->getBody()->write(json_encode($payload, JSON_THROW_ON_ERROR));
        return $response->withHeader('Content-Type', 'application/json');
    }
}

interfaceSlim\Interfaces\ErrorRendererInterface#

• ソースファイル: Slim/Interfaces/ErrorRendererInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Error\AbstractErrorRenderer, Slim\Error\Renderers\JsonErrorRenderer, Slim\Error\Renderers\HtmlErrorRenderer, Slim\Error\Renderers\PlainTextErrorRenderer, Slim\Error\Renderers\XmlErrorRenderer
• 主な参照元: Slim\Handlers\ErrorHandler

ErrorHandler の Accept ヘッダ交渉によって選択されたメディアタイプ（HTML・JSON・XML・PlainText 等）に応じ、捕捉された \Throwable をレスポンスボディ文字列へ変換する契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Throwable;

interface ErrorRendererInterface
{
    public function __invoke(Throwable $exception, bool $displayErrorDetails): string;
}

メソッド・引数一覧#

使用例#

use Slim\Interfaces\ErrorRendererInterface;
use Throwable;

final class ProblemDetailsJsonRenderer implements ErrorRendererInterface
{
    public function __invoke(Throwable $exception, bool $displayErrorDetails): string
    {
        return json_encode([
            'type' => 'https://example.com/probs/error',
            'title' => $exception->getMessage(),
            'status' => $exception->getCode() ?: 500,
        ], JSON_THROW_ON_ERROR);
    }
}

interfaceSlim\Interfaces\InvocationStrategyInterface#

• ソースファイル: Slim/Interfaces/InvocationStrategyInterface.php
• 名前空間: Slim\Interfaces
• 拡張先サブインターフェース: Slim\Interfaces\RequestHandlerInvocationStrategyInterface
• 既定実装クラス: Slim\Handlers\Strategies\RequestResponse (既定), Slim\Handlers\Strategies\RequestResponseArgs, Slim\Handlers\Strategies\RequestResponseNamedArgs, Slim\Handlers\Strategies\RequestHandler
• 主な参照元: Slim\Routing\RouteCollector, Slim\Routing\Route

マッチしたルートの callable を、PSR-7 の ServerRequestInterface、ResponseInterface、および FastRoute が抽出した URI プレースホルダ引数配列（array<string, string>）を用いて呼び出すストラテジ契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Defines a contract for invoking a route callable.
 */
interface InvocationStrategyInterface
{
    /**
     * Invoke a route callable.
     *
     * @param callable               $callable       The callable to invoke using the strategy.
     * @param ServerRequestInterface $request        The request object.
     * @param ResponseInterface      $response       The response object.
     * @param array<string, string>  $routeArguments The route's placeholder arguments
     *
     * @return ResponseInterface The response from the callable.
     */
    public function __invoke(
        callable $callable,
        ServerRequestInterface $request,
        ResponseInterface $response,
        array $routeArguments
    ): ResponseInterface;
}

メソッド・引数一覧#

使用例#

use Slim\Handlers\Strategies\RequestResponseArgs;

// ルート引数を位置引数 function ($request, $response, $id, $slug) として展開するストラテジに変更:
$routeCollector = $app->getRouteCollector();
$routeCollector->setDefaultInvocationStrategy(new RequestResponseArgs());

interfaceSlim\Interfaces\MiddlewareDispatcherInterface#

• ソースファイル: Slim/Interfaces/MiddlewareDispatcherInterface.php
• 名前空間: Slim\Interfaces
• 継承元 (extends): Psr\Http\Server\RequestHandlerInterface
• 既定実装クラス: Slim\MiddlewareDispatcher
• 主な参照元: Slim\App, Slim\Factory\AppFactory, Slim\Routing\Route

Slim の Last-In-First-Out（LIFO：後入れ先出し）同心円状 PSR-15 ミドルウェアスタックを管理する契約です。Psr\Http\Server\RequestHandlerInterface を継承しているため、すべての実装は handle(ServerRequestInterface $request): ResponseInterface も提供します。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

/** @api */
interface MiddlewareDispatcherInterface extends RequestHandlerInterface
{
    /**
     * Add a new middleware to the stack
     *
     * Middleware are organized as a stack. That means middleware
     * that have been added before will be executed after the newly
     * added one (last in, first out).
     *
     * @param MiddlewareInterface|string|callable $middleware
     */
    public function add($middleware): self;

    /**
     * Add a new middleware to the stack
     *
     * Middleware are organized as a stack. That means middleware
     * that have been added before will be executed after the newly
     * added one (last in, first out).
     */
    public function addMiddleware(MiddlewareInterface $middleware): self;

    /**
     * Seed the middleware stack with the inner request handler
     */
    public function seedMiddlewareStack(RequestHandlerInterface $kernel): void;
}

メソッド・引数一覧#

使用例#

use Slim\Interfaces\MiddlewareDispatcherInterface;

/** @var MiddlewareDispatcherInterface $dispatcher */
$dispatcher = $app->getMiddlewareDispatcher();
$dispatcher->add(CorrelationIdMiddleware::class);

interfaceSlim\Interfaces\Psr17FactoryInterface#

• ソースファイル: Slim/Interfaces/Psr17FactoryInterface.php
• 名前空間: Slim\Interfaces
• 既定基底実装クラス: Slim\Factory\Psr17\Psr17Factory（SlimPsr17Factory, HttpSoftPsr17Factory, NyholmPsr17Factory, LaminasDiactorosPsr17Factory, GuzzlePsr17Factory, SlimHttpPsr17Factory が継承）
• 主な参照元: Slim\Factory\AppFactory, Slim\Factory\ServerRequestCreatorFactory

ゼロ設定ブートストラップ時に各 PSR-7 / PSR-17 実装パッケージがインストール済みかどうかを検査し（isResponseFactoryAvailable(), isStreamFactoryAvailable(), isServerRequestCreatorAvailable()）、対応する ResponseFactoryInterface、StreamFactoryInterface、ServerRequestCreatorInterface を生成する静的アダプタ契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\StreamFactoryInterface;
use RuntimeException;

interface Psr17FactoryInterface
{
    /**
     * @throws RuntimeException when the factory could not be instantiated
     */
    public static function getResponseFactory(): ResponseFactoryInterface;

    /**
     * @throws RuntimeException when the factory could not be instantiated
     */
    public static function getStreamFactory(): StreamFactoryInterface;

    /**
     * @throws RuntimeException when the factory could not be instantiated
     */
    public static function getServerRequestCreator(): ServerRequestCreatorInterface;

    /**
     * Is the PSR-17 ResponseFactory available
     */
    public static function isResponseFactoryAvailable(): bool;

    /**
     * Is the PSR-17 StreamFactory available
     */
    public static function isStreamFactoryAvailable(): bool;

    /**
     * Is the ServerRequest creator available
     */
    public static function isServerRequestCreatorAvailable(): bool;
}

メソッド・引数一覧#

使用例#

use Slim\Factory\Psr17\NyholmPsr17Factory;

if (NyholmPsr17Factory::isResponseFactoryAvailable()) {
    $responseFactory = NyholmPsr17Factory::getResponseFactory();
}

interfaceSlim\Interfaces\Psr17FactoryProviderInterface#

• ソースファイル: Slim/Interfaces/Psr17FactoryProviderInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Factory\Psr17\Psr17FactoryProvider
• 主な参照元: Slim\Factory\AppFactory, Slim\Factory\ServerRequestCreatorFactory

AppFactory::determineResponseFactory() および ServerRequestCreatorFactory::determineServerRequestCreator() が自動探索する Psr17FactoryInterface 実装クラス名の優先順位リストを管理するレジストリ契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

/** @api */
interface Psr17FactoryProviderInterface
{
    /**
     * @return string[]
     */
    public static function getFactories(): array;

    /**
     * @param string[] $factories
     */
    public static function setFactories(array $factories): void;

    public static function addFactory(string $factory): void;
}

メソッド・引数一覧#

使用例#

use Slim\Factory\Psr17\Psr17FactoryProvider;

// カスタム PSR-17 ファクトリアダプタを最優先として先頭登録:
Psr17FactoryProvider::addFactory(CustomPsr17Factory::class);

interfaceSlim\Interfaces\RequestHandlerInvocationStrategyInterface#

• ソースファイル: Slim/Interfaces/RequestHandlerInvocationStrategyInterface.php
• 名前空間: Slim\Interfaces
• 継承元 (extends): Slim\Interfaces\InvocationStrategyInterface
• 既定実装クラス: Slim\Handlers\Strategies\RequestHandler

PSR-15 の RequestHandlerInterface シグネチャ（callable(ServerRequestInterface): ResponseInterface）でルートハンドラを直接呼び出すストラテジを表すマーカーサブインターフェースです。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

interface RequestHandlerInvocationStrategyInterface extends InvocationStrategyInterface
{
}

メソッド・引数一覧#

使用例#

use Slim\Handlers\Strategies\RequestHandler;
use Slim\Interfaces\RequestHandlerInvocationStrategyInterface;

/** @var RequestHandlerInvocationStrategyInterface $strategy */
$strategy = new RequestHandler(true); // ルート引数を Request 属性として注入
$app->getRouteCollector()->setDefaultInvocationStrategy($strategy);

interfaceSlim\Interfaces\RouteCollectorInterface#

• ソースファイル: Slim/Interfaces/RouteCollectorInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Routing\RouteCollector
• 主な参照元: Slim\App, Slim\Routing\RouteCollectorProxy, Slim\Routing\Dispatcher, Slim\Routing\RouteParser, Slim\Routing\RouteResolver

RouteInterface および RouteGroupInterface の登録・保持、既定の InvocationStrategyInterface の管理、FastRoute キャッシュファイルの設定、およびルート名・内部識別子（route0, route1, ...）による検索を担う中央ルートレジストリ契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use InvalidArgumentException;
use RuntimeException;

/** @api */
interface RouteCollectorInterface
{
    /**
     * Get the route parser
     */
    public function getRouteParser(): RouteParserInterface;

    /**
     * Get default route invocation strategy
     */
    public function getDefaultInvocationStrategy(): InvocationStrategyInterface;

    /**
     * Set default route invocation strategy
     */
    public function setDefaultInvocationStrategy(InvocationStrategyInterface $strategy): RouteCollectorInterface;

    /**
     * Get path to FastRoute cache file
     */
    public function getCacheFile(): ?string;

    /**
     * Set path to FastRoute cache file
     *
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function setCacheFile(string $cacheFile): RouteCollectorInterface;

    /**
     * Get the base path used in pathFor()
     */
    public function getBasePath(): string;

    /**
     * Set the base path used in pathFor()
     */
    public function setBasePath(string $basePath): RouteCollectorInterface;

    /**
     * Get route objects
     *
     * @return RouteInterface[]
     */
    public function getRoutes(): array;

    /**
     * Get named route object
     *
     * @param string $name Route name
     *
     * @throws RuntimeException   If named route does not exist
     */
    public function getNamedRoute(string $name): RouteInterface;

    /**
     * Remove named route
     *
     * @param string $name Route name
     *
     * @throws RuntimeException   If named route does not exist
     */
    public function removeNamedRoute(string $name): RouteCollectorInterface;

    /**
     * Lookup a route via the route's unique identifier
     *
     * @throws RuntimeException   If route of identifier does not exist
     */
    public function lookupRoute(string $identifier): RouteInterface;

    /**
     * Add route group
     * @param string|callable $callable
     */
    public function group(string $pattern, $callable): RouteGroupInterface;

    /**
     * Add route
     *
     * @param string[] $methods Array of HTTP methods
     * @param string $pattern The route pattern
     * @param callable|array{class-string, string}|string $handler The route callable
     */
    public function map(array $methods, string $pattern, $handler): RouteInterface;
}

メソッド・引数一覧#

使用例#

$collector = $app->getRouteCollector();
$collector->setCacheFile(__DIR__ . '/../var/cache/fastroute.php');

$route = $collector->getNamedRoute('users.show');

interfaceSlim\Interfaces\RouteCollectorProxyInterface#

• ソースファイル: Slim/Interfaces/RouteCollectorProxyInterface.php
• 名前空間: Slim\Interfaces
• ジェネリクス型注釈: @template TContainerInterface of (ContainerInterface|null)
• 既定実装クラス: Slim\Routing\RouteCollectorProxy, Slim\App

Slim\App およびルートグループのコールバック引数（$app->group('/v1', function (RouteCollectorProxyInterface $group) { ... })）が共通実装する、利用者向けのルーティング登録ファサード契約です。HTTP メソッド別の短縮メソッド（get(), post(), put(), patch(), delete(), options(), any()）、map()、group()、redirect() を提供します。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\UriInterface;

/**
 * @api
 * @template TContainerInterface of (ContainerInterface|null)
 */
interface RouteCollectorProxyInterface
{
    public function getResponseFactory(): ResponseFactoryInterface;

    public function getCallableResolver(): CallableResolverInterface;

    /**
     * @return TContainerInterface
     */
    public function getContainer(): ?ContainerInterface;

    public function getRouteCollector(): RouteCollectorInterface;

    /**
     * Get the RouteCollectorProxy's base path
     */
    public function getBasePath(): string;

    /**
     * Set the RouteCollectorProxy's base path
     * @return RouteCollectorProxyInterface<TContainerInterface>
     */
    public function setBasePath(string $basePath): RouteCollectorProxyInterface;

    /**
     * Add GET route
     *
     * @param string $pattern The route URI pattern
     * @param callable|array{class-string, string}|string $callable The route callback routine
     */
    public function get(string $pattern, $callable): RouteInterface;

    /**
     * Add POST route
     *
     * @param string $pattern The route URI pattern
     * @param callable|array{class-string, string}|string $callable The route callback routine
     */
    public function post(string $pattern, $callable): RouteInterface;

    /**
     * Add PUT route
     *
     * @param string $pattern The route URI pattern
     * @param callable|array{class-string, string}|string $callable The route callback routine
     */
    public function put(string $pattern, $callable): RouteInterface;

    /**
     * Add PATCH route
     *
     * @param string $pattern The route URI pattern
     * @param callable|array{class-string, string}|string $callable The route callback routine
     */
    public function patch(string $pattern, $callable): RouteInterface;

    /**
     * Add DELETE route
     *
     * @param string $pattern The route URI pattern
     * @param callable|array{class-string, string}|string $callable The route callback routine
     */
    public function delete(string $pattern, $callable): RouteInterface;

    /**
     * Add OPTIONS route
     *
     * @param string $pattern The route URI pattern
     * @param callable|array{class-string, string}|string $callable The route callback routine
     */
    public function options(string $pattern, $callable): RouteInterface;

    /**
     * Add route for any HTTP method
     *
     * @param string $pattern The route URI pattern
     * @param callable|array{class-string, string}|string $callable The route callback routine
     */
    public function any(string $pattern, $callable): RouteInterface;

    /**
     * Add route with multiple methods
     *
     * @param string[] $methods Numeric array of HTTP method names
     * @param string $pattern The route URI pattern
     * @param callable|array{class-string, string}|string $callable The route callback routine
     */
    public function map(array $methods, string $pattern, $callable): RouteInterface;

    /**
     * Route Groups
     *
     * This method accepts a route pattern and a callback. All route
     * declarations in the callback will be prepended by the group(s)
     * that it is in.
     * @param string|callable $callable
     */
    public function group(string $pattern, $callable): RouteGroupInterface;

    /**
     * Add a route that sends an HTTP redirect
     *
     * @param string|UriInterface $to
     */
    public function redirect(string $from, $to, int $status = 302): RouteInterface;
}

メソッド・引数一覧#

使用例#

use Slim\Interfaces\RouteCollectorProxyInterface;

$app->group('/api/v1', function (RouteCollectorProxyInterface $group): void {
    $group->get('/users', ListUsersHandler::class)->setName('users.index');
    $group->post('/users', CreateUserHandler::class)->setName('users.create');
    $group->redirect('/legacy', '/api/v1/users', 301);
});

interfaceSlim\Interfaces\RouteGroupInterface#

• ソースファイル: Slim/Interfaces/RouteGroupInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Routing\RouteGroup
• 主な参照元: Slim\Routing\RouteCollector, Slim\Routing\Route

RouteCollectorProxyInterface::group() が返すルートグループの契約です。add() / addMiddleware() によるグループ単位の PSR-15 ミドルウェア登録と、ルート実行時にそれらのミドルウェアを MiddlewareDispatcher へ連結する appendMiddlewareToDispatcher() を定義します。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Psr\Http\Server\MiddlewareInterface;
use Slim\MiddlewareDispatcher;

/** @api */
interface RouteGroupInterface
{
    public function collectRoutes(): RouteGroupInterface;

    /**
     * Add middleware to the route group
     *
     * @param MiddlewareInterface|string|callable $middleware
     */
    public function add($middleware): RouteGroupInterface;

    /**
     * Add middleware to the route group
     */
    public function addMiddleware(MiddlewareInterface $middleware): RouteGroupInterface;

    /**
     * Append the group's middleware to the MiddlewareDispatcher
     * @param MiddlewareDispatcher<\Psr\Container\ContainerInterface|null> $dispatcher
     */
    public function appendMiddlewareToDispatcher(MiddlewareDispatcher $dispatcher): RouteGroupInterface;

    /**
     * Get the RouteGroup's pattern
     */
    public function getPattern(): string;
}

メソッド・引数一覧#

使用例#

$app->group('/admin', function ($group): void {
    $group->get('/audit-logs', AuditLogAction::class);
})->add(AdminRoleMiddleware::class);

interfaceSlim\Interfaces\RouteInterface#

• ソースファイル: Slim/Interfaces/RouteInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Routing\Route
• 主な参照元: Slim\Routing\RouteCollector, Slim\Routing\RouteRunner, Slim\Routing\RouteContext

個々のルート定義を表す契約です。許可された HTTP メソッド配列、URI パターン、ルートハンドラ、ルート名、内部識別子、抽出された URI パラメータ、ルート固有の InvocationStrategyInterface、および run(ServerRequestInterface $request) で実行されるルート固有の PSR-15 ミドルウェアスタックをカプセル化します。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;

/** @api */
interface RouteInterface
{
    /**
     * Get route invocation strategy
     */
    public function getInvocationStrategy(): InvocationStrategyInterface;

    /**
     * Set route invocation strategy
     */
    public function setInvocationStrategy(InvocationStrategyInterface $invocationStrategy): RouteInterface;

    /**
     * Get route methods
     *
     * @return string[]
     */
    public function getMethods(): array;

    /**
     * Get route pattern
     */
    public function getPattern(): string;

    /**
     * Set route pattern
     */
    public function setPattern(string $pattern): RouteInterface;

    /**
     * Get route callable
     *
     * @return callable|array{class-string, string}|string
     */
    public function getCallable();

    /**
     * Set route callable
     *
     * @param callable|array{class-string, string}|string $callable
     */
    public function setCallable($callable): RouteInterface;

    /**
     * Get route name
     */
    public function getName(): ?string;

    /**
     * Set route name
     *
     * @return static
     */
    public function setName(string $name): RouteInterface;

    /**
     * Get the route's unique identifier
     */
    public function getIdentifier(): string;

    /**
     * Retrieve a specific route argument
     */
    public function getArgument(string $name, ?string $default = null): ?string;

    /**
     * Get route arguments
     *
     * @return array<string, string>
     */
    public function getArguments(): array;

    /**
     * Set a route argument
     *
     * @deprecated 4.14.1 Use a middleware for custom route arguments now.
     */
    public function setArgument(string $name, string $value): RouteInterface;

    /**
     * Replace route arguments
     *
     * @param array<string, string> $arguments
     *
     * @deprecated 4.14.1 Use a middleware for custom route arguments now.
     */
    public function setArguments(array $arguments): self;

    /**
     * @param MiddlewareInterface|string|callable $middleware
     */
    public function add($middleware): self;

    public function addMiddleware(MiddlewareInterface $middleware): self;

    /**
     * Prepare the route for use
     *
     * @param array<string, string> $arguments
     */
    public function prepare(array $arguments): self;

    /**
     * Run route
     *
     * This method traverses the middleware stack, including the route's callable
     * and captures the resultant HTTP response object. It then sends the response
     * back to the Application.
     */
    public function run(ServerRequestInterface $request): ResponseInterface;
}

メソッド・引数一覧#

使用例#

use Slim\Handlers\Strategies\RequestResponseArgs;

$app->get('/orders/{id:[0-9]+}', OrderController::class . ':show')
    ->setName('orders.show')
    ->setInvocationStrategy(new RequestResponseArgs())
    ->add(OrderOwnershipMiddleware::class);

interfaceSlim\Interfaces\RouteParserInterface#

• ソースファイル: Slim/Interfaces/RouteParserInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Routing\RouteParser
• 主な参照元: Slim\Routing\RouteCollector, Slim\Routing\RouteContext, Slim\Middleware\RoutingMiddleware

名前付きルートから、ベースパスを除いた相対パス（relativeUrlFor()）、ベースパスを含む相対 URL（urlFor()）、およびスキームとホスト名を含む完全修飾 URL（fullUrlFor()）を逆引き生成する契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use InvalidArgumentException;
use Psr\Http\Message\UriInterface;
use RuntimeException;

/** @api */
interface RouteParserInterface
{
    /**
     * Build the path for a named route excluding the base path
     *
     * @param string                                           $routeName   Route name
     * @param array<string, string>                            $data        Named argument replacement data
     * @param array<string, string | array<array-key, string>> $queryParams Optional query string parameters
     *
     * @throws RuntimeException         If named route does not exist
     * @throws InvalidArgumentException If required data not provided
     */
    public function relativeUrlFor(string $routeName, array $data = [], array $queryParams = []): string;

    /**
     * Build the path for a named route including the base path
     *
     * @param string                                           $routeName   Route name
     * @param array<string, string>                            $data        Named argument replacement data
     * @param array<string, string | array<array-key, string>> $queryParams Optional query string parameters
     *
     * @throws RuntimeException         If named route does not exist
     * @throws InvalidArgumentException If required data not provided
     */
    public function urlFor(string $routeName, array $data = [], array $queryParams = []): string;

    /**
     * Get fully qualified URL for named route
     *
     * @param UriInterface                                     $uri
     * @param string                                           $routeName   Route name
     * @param array<string, string>                            $data        Named argument replacement data
     * @param array<string, string | array<array-key, string>> $queryParams Optional query string parameters
     */
    public function fullUrlFor(UriInterface $uri, string $routeName, array $data = [], array $queryParams = []): string;
}

メソッド・引数一覧#

使用例#

use Slim\Routing\RouteContext;

$routeParser = RouteContext::fromRequest($request)->getRouteParser();

$relative = $routeParser->relativeUrlFor('orders.show', ['id' => '42']);
$path     = $routeParser->urlFor('orders.show', ['id' => '42'], ['expand' => 'items']);
$fullUrl  = $routeParser->fullUrlFor($request->getUri(), 'orders.show', ['id' => '42']);

interfaceSlim\Interfaces\RouteResolverInterface#

• ソースファイル: Slim/Interfaces/RouteResolverInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Routing\RouteResolver
• 主な参照元: Slim\App, Slim\Middleware\RoutingMiddleware, Slim\Routing\RouteRunner

RoutingMiddleware と DispatcherInterface・RouteCollectorInterface の間を仲介し、リクエスト URI に対する RoutingResults の算出と、マッチしたルート識別子から RouteInterface インスタンスへの解決を行う契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Slim\Routing\RoutingResults;

interface RouteResolverInterface
{
    /**
     * @param string $uri Should be ServerRequestInterface::getUri()->getPath()
     */
    public function computeRoutingResults(string $uri, string $method): RoutingResults;

    public function resolveRoute(string $identifier): RouteInterface;
}

メソッド・引数一覧#

使用例#

$resolver = $app->getRouteResolver();
$results  = $resolver->computeRoutingResults('/users/42', 'GET');
$route    = $resolver->resolveRoute($results->getRouteIdentifier());

interfaceSlim\Interfaces\ServerRequestCreatorInterface#

• ソースファイル: Slim/Interfaces/ServerRequestCreatorInterface.php
• 名前空間: Slim\Interfaces
• 既定実装クラス: Slim\Factory\Psr17\ServerRequestCreator, Slim\Factory\Psr17\SlimHttpServerRequestCreator
• 主な参照元: Slim\App::run(), Slim\Factory\ServerRequestCreatorFactory

App::run() が引数なしで呼び出された際に、PHP の SAPI スーパーグローバル変数群（$_SERVER, $_GET, $_POST, $_COOKIE, $_FILES）から PSR-7 ServerRequestInterface インスタンスを生成する契約です。

PHP インターフェースシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Interfaces;

use Psr\Http\Message\ServerRequestInterface;

interface ServerRequestCreatorInterface
{
    public function createServerRequestFromGlobals(): ServerRequestInterface;
}

メソッド・引数一覧#

使用例#

use Slim\Factory\ServerRequestCreatorFactory;

$creator = ServerRequestCreatorFactory::create();
$request = $creator->createServerRequestFromGlobals();
$app->run($request);