ServiceProvider::publishPhpRenderer() - Code Metrics - Inspection of "View: Simplifying component." - valkyrjaio/valkyrja - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6b1ebf...63457f )

by Melech

created 2025-07-03 05:33 UTC

ServiceProvider::publishPhpRenderer() A

↳ Parent: ServiceProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	10
dl	0
loc	16
rs	9.9332
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Valkyrja Framework package.
 *
 * (c) Melech Mizrachi <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valkyrja\View\Provider;

use Twig\Environment;
use Twig\Error\LoaderError;
use Twig\Extension\ExtensionInterface as TwigExtensionInterface;
use Twig\Loader\FilesystemLoader;
use Valkyrja\Application\Env;
filter:
    dependency_paths: ["lib/*"]
use Valkyrja\Container\Contract\Container;
use Valkyrja\Container\Support\Provider;
use Valkyrja\Http\Message\Factory\Contract\ResponseFactory as HttpMessageResponseFactory;
use Valkyrja\View\Contract\Renderer;
use Valkyrja\View\Factory\Contract\ResponseFactory;
use Valkyrja\View\OrkaRenderer;
use Valkyrja\View\PhpRenderer;
use Valkyrja\View\TwigRenderer;

/**
 * Class ServiceProvider.
 *
 * @author Melech Mizrachi
 */
final class ServiceProvider extends Provider
{
    /**
     * @inheritDoc
     */
    public static function publishers(): array
    {
        return [
            Renderer::class        => [self::class, 'publishRenderer'],
            PhpRenderer::class     => [self::class, 'publishPhpRenderer'],
            OrkaRenderer::class    => [self::class, 'publishOrkaRenderer'],
            TwigRenderer::class    => [self::class, 'publishTwigRenderer'],
            Environment::class     => [self::class, 'publishTwigEnvironment'],
            ResponseFactory::class => [self::class, 'publishResponseFactory'],
        ];
    }

    /**
     * @inheritDoc
     */
    public static function provides(): array
    {
        return [
            Renderer::class,
            PhpRenderer::class,
            OrkaRenderer::class,
            TwigRenderer::class,
            Environment::class,
            ResponseFactory::class,
        ];
    }

    /**
     * Publish the renderer service.
     */
    public static function publishRenderer(Container $container): void
    {
        $container->setSingleton(
            Renderer::class,
            $container->getSingleton(PhpRenderer::class)
        );
    }

    /**
     * Publish the renderer service.
     */
    public static function publishPhpRenderer(Container $container): void
    {
        $env = $container->getSingleton(Env::class);
        /** @var non-empty-string $dir */
        $dir = $env::VIEW_PHP_DIR;
        /** @var non-empty-string $fileExtension */
        $fileExtension = $env::VIEW_PHP_FILE_EXTENSION;
        /** @var array<string, string> $paths */
        $paths = $env::VIEW_PHP_PATHS;

        $container->setSingleton(
            PhpRenderer::class,
            new PhpRenderer(
                dir: $dir,
                fileExtension: $fileExtension,
                paths: $paths
            ),
        );
    }

    /**
     * Publish the renderer service.
     */
    public static function publishOrkaRenderer(Container $container): void
    {
        $env = $container->getSingleton(Env::class);
        /** @var bool $debug */
        $debug = $env::APP_DEBUG_MODE;
        /** @var non-empty-string $dir */
        $dir = $env::VIEW_ORKA_DIR;
        /** @var non-empty-string $fileExtension */
        $fileExtension = $env::VIEW_ORKA_FILE_EXTENSION;
        /** @var array<string, string> $paths */
        $paths = $env::VIEW_ORKA_PATHS;

        $container->setSingleton(
            OrkaRenderer::class,
            new OrkaRenderer(
                dir: $dir,
                fileExtension: $fileExtension,
                paths: $paths,
                debug: $debug
            ),
        );
    }

    /**
     * Publish the renderer service.
     */
    public static function publishTwigRenderer(Container $container): void
    {
        $container->setSingleton(
            TwigRenderer::class,
            new TwigRenderer(
                $container->getSingleton(Environment::class),
            ),
        );
    }

    /**
     * Publish the renderer service.
     *
     * @throws LoaderError
     */
    public static function publishTwigEnvironment(Container $container): void
    {
        $env = $container->getSingleton(Env::class);
        /** @var bool $debug */
        $debug = $env::APP_DEBUG_MODE;
        /** @var array<string, string> $paths */
        $paths = $env::VIEW_TWIG_PATHS;
        /** @var class-string<TwigExtensionInterface>[] $extensions */
        $extensions = $env::VIEW_TWIG_EXTENSIONS;
        /** @var non-empty-string $compiledDir */
        $compiledDir = $env::VIEW_TWIG_COMPILED_DIR;

        // Get the twig filesystem loader
        $loader = new FilesystemLoader();

        // Iterate through the dirs and add each as a path in the twig loader
        foreach ($paths as $namespace => $dir) {
            $loader->addPath($dir, $namespace);
        }

        // Create a new twig environment
        $twig = new Environment(
            $loader,
            [
                'cache'   => $compiledDir,
                'debug'   => $debug,
                'charset' => 'utf-8',
            ]
        );

        // Iterate through the extensions
        foreach ($extensions as $extension) {
            // And add each extension to the twig environment
            $twig->addExtension(new $extension());
        }

        $container->setSingleton(
            Environment::class,
            $twig,
        );
    }

    /**
     * Publish the response factory service.
     */
    public static function publishResponseFactory(Container $container): void
    {
        $container->setSingleton(
            ResponseFactory::class,
            new \Valkyrja\View\Factory\ResponseFactory(
                $container->getSingleton(HttpMessageResponseFactory::class),
                $container->getSingleton(Renderer::class)
            )
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Valkyrja Framework package.
7			*
8			* (c) Melech Mizrachi <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Valkyrja\View\Provider;
15
16			use Twig\Environment;
17			use Twig\Error\LoaderError;
18			use Twig\Extension\ExtensionInterface as TwigExtensionInterface;
19			use Twig\Loader\FilesystemLoader;
20			use Valkyrja\Application\Env;
			0 ignored issues – show Bug introduced 2025-07-02 03:57 UTC by Report Bug Copy Issue Report The type `Valkyrja\Application\Env` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21			use Valkyrja\Container\Contract\Container;
22			use Valkyrja\Container\Support\Provider;
23			use Valkyrja\Http\Message\Factory\Contract\ResponseFactory as HttpMessageResponseFactory;
24			use Valkyrja\View\Contract\Renderer;
25			use Valkyrja\View\Factory\Contract\ResponseFactory;
26			use Valkyrja\View\OrkaRenderer;
27			use Valkyrja\View\PhpRenderer;
28			use Valkyrja\View\TwigRenderer;
29
30			/**
31			* Class ServiceProvider.
32			*
33			* @author Melech Mizrachi
34			*/
35			final class ServiceProvider extends Provider
36			{
37			/**
38			* @inheritDoc
39			*/
40			public static function publishers(): array
41			{
42			return [
43			Renderer::class => [self::class, 'publishRenderer'],
44			PhpRenderer::class => [self::class, 'publishPhpRenderer'],
45			OrkaRenderer::class => [self::class, 'publishOrkaRenderer'],
46			TwigRenderer::class => [self::class, 'publishTwigRenderer'],
47			Environment::class => [self::class, 'publishTwigEnvironment'],
48			ResponseFactory::class => [self::class, 'publishResponseFactory'],
49			];
50			}
51
52			/**
53			* @inheritDoc
54			*/
55			public static function provides(): array
56			{
57			return [
58			Renderer::class,
59			PhpRenderer::class,
60			OrkaRenderer::class,
61			TwigRenderer::class,
62			Environment::class,
63			ResponseFactory::class,
64			];
65			}
66
67			/**
68			* Publish the renderer service.
69			*/
70			public static function publishRenderer(Container $container): void
71			{
72			$container->setSingleton(
73			Renderer::class,
74			$container->getSingleton(PhpRenderer::class)
75			);
76			}
77
78			/**
79			* Publish the renderer service.
80			*/
81			public static function publishPhpRenderer(Container $container): void
82			{
83			$env = $container->getSingleton(Env::class);
84			/** @var non-empty-string $dir */
85			$dir = $env::VIEW_PHP_DIR;
86			/** @var non-empty-string $fileExtension */
87			$fileExtension = $env::VIEW_PHP_FILE_EXTENSION;
88			/** @var array<string, string> $paths */
89			$paths = $env::VIEW_PHP_PATHS;
90
91			$container->setSingleton(
92			PhpRenderer::class,
93			new PhpRenderer(
94			dir: $dir,
95			fileExtension: $fileExtension,
96			paths: $paths
97			),
98			);
99			}
100
101			/**
102			* Publish the renderer service.
103			*/
104			public static function publishOrkaRenderer(Container $container): void
105			{
106			$env = $container->getSingleton(Env::class);
107			/** @var bool $debug */
108			$debug = $env::APP_DEBUG_MODE;
109			/** @var non-empty-string $dir */
110			$dir = $env::VIEW_ORKA_DIR;
111			/** @var non-empty-string $fileExtension */
112			$fileExtension = $env::VIEW_ORKA_FILE_EXTENSION;
113			/** @var array<string, string> $paths */
114			$paths = $env::VIEW_ORKA_PATHS;
115
116			$container->setSingleton(
117			OrkaRenderer::class,
118			new OrkaRenderer(
119			dir: $dir,
120			fileExtension: $fileExtension,
121			paths: $paths,
122			debug: $debug
123			),
124			);
125			}
126
127			/**
128			* Publish the renderer service.
129			*/
130			public static function publishTwigRenderer(Container $container): void
131			{
132			$container->setSingleton(
133			TwigRenderer::class,
134			new TwigRenderer(
135			$container->getSingleton(Environment::class),
136			),
137			);
138			}
139
140			/**
141			* Publish the renderer service.
142			*
143			* @throws LoaderError
144			*/
145			public static function publishTwigEnvironment(Container $container): void
146			{
147			$env = $container->getSingleton(Env::class);
148			/** @var bool $debug */
149			$debug = $env::APP_DEBUG_MODE;
150			/** @var array<string, string> $paths */
151			$paths = $env::VIEW_TWIG_PATHS;
152			/** @var class-string<TwigExtensionInterface>[] $extensions */
153			$extensions = $env::VIEW_TWIG_EXTENSIONS;
154			/** @var non-empty-string $compiledDir */
155			$compiledDir = $env::VIEW_TWIG_COMPILED_DIR;
156
157			// Get the twig filesystem loader
158			$loader = new FilesystemLoader();
159
160			// Iterate through the dirs and add each as a path in the twig loader
161			foreach ($paths as $namespace => $dir) {
162			$loader->addPath($dir, $namespace);
163			}
164
165			// Create a new twig environment
166			$twig = new Environment(
167			$loader,
168			[
169			'cache' => $compiledDir,
170			'debug' => $debug,
171			'charset' => 'utf-8',
172			]
173			);
174
175			// Iterate through the extensions
176			foreach ($extensions as $extension) {
177			// And add each extension to the twig environment
178			$twig->addExtension(new $extension());
179			}
180
181			$container->setSingleton(
182			Environment::class,
183			$twig,
184			);
185			}
186
187			/**
188			* Publish the response factory service.
189			*/
190			public static function publishResponseFactory(Container $container): void
191			{
192			$container->setSingleton(
193			ResponseFactory::class,
194			new \Valkyrja\View\Factory\ResponseFactory(
195			$container->getSingleton(HttpMessageResponseFactory::class),
196			$container->getSingleton(Renderer::class)
197			)
198			);
199			}
200			}
201

valkyrjaio / valkyrja

Push — master ( 6b1ebf...63457f )

ServiceProvider::publishPhpRenderer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like