Engine::loadExtension() - Code Metrics - Inspection of "Engine API" - thephpleague/plates - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#213)

unknown

created 2018-01-26 20:38 UTC

Engine::loadExtension() A

↳ Parent: Engine

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	3
ccs	0
cts	3
cp	0
crap	2
rs	10
c	1
b	0
f	0

<?php

namespace League\Plates;

/** API for the Plates system. This wraps the container and allows extensions to add methods for syntactic sugar. */
final class Engine
{
    private $container;

    public function __construct(Util\Container $container = null) {
        $this->container = $container ?: Util\Container::create(['engine_methods' => []]);
    }

    /** Create a configured engine and set the base dir and extension optionally */
    public static function create($base_dir, $ext = null) {
        return self::createWithConfig(array_filter([
            'base_dir' => $base_dir,
            'ext' => $ext
        ]));
    }

    /** Create a configured engine and pass in an array to configure after extension registration */
    public static function createWithConfig(array $config = []) {
        $plates = new self();

        $plates->register(new PlatesExtension());
        $plates->register(new Extension\Data\DataExtension());
        $plates->register(new Extension\Path\PathExtension());
        $plates->register(new Extension\RenderContext\RenderContextExtension());
        $plates->register(new Extension\LayoutSections\LayoutSectionsExtension());
        $plates->register(new Extension\Folders\FoldersExtension());

        $plates->addConfig($config);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        return $plates;
    }

    /** @return string */
    public function render($template_name, array $data = [], array $attributes = []) {
        return $this->container->get('renderTemplate')->renderTemplate(new Template(
            $template_name,
            $data,
            $attributes
        ));
    }

    public function addMethods(array $methods) {
        $this->container->merge('engine_methods', $methods);
    }
    public function __call($method, array $args) {
        $methods = $this->container->get('engine_methods');
        if (isset($methods[$method])) {
            return $methods[$method]($this, ...$args);
        }

        throw new \BadMethodCallException("No method {$method} found for engine.");
    }

    /** @deprecated kept for bc */
    public function loadExtension(Extension $extension) {
        $this->register($extension);
    }
    public function register(Extension $extension) {
        $extension->register($this);
    }

    public function getContainer() {
        return $this->container;
    }
}


1		<?php
2
3		namespace League\Plates;
4
5		/** API for the Plates system. This wraps the container and allows extensions to add methods for syntactic sugar. */
6		final class Engine
7		{
8		private $container;
9
10	20	public function __construct(Util\Container $container = null) {
11	20	$this->container = $container ?: Util\Container::create(['engine_methods' => []]);
12	20	}
13
14		/** Create a configured engine and set the base dir and extension optionally */
15	8	public static function create($base_dir, $ext = null) {
16	8	return self::createWithConfig(array_filter([
17	8	'base_dir' => $base_dir,
18	8	'ext' => $ext
19		]));
20		}
21
22		/** Create a configured engine and pass in an array to configure after extension registration */
23	20	public static function createWithConfig(array $config = []) {
24	20	$plates = new self();
25
26	20	$plates->register(new PlatesExtension());
27	20	$plates->register(new Extension\Data\DataExtension());
28	20	$plates->register(new Extension\Path\PathExtension());
29	20	$plates->register(new Extension\RenderContext\RenderContextExtension());
30	20	$plates->register(new Extension\LayoutSections\LayoutSectionsExtension());
31	20	$plates->register(new Extension\Folders\FoldersExtension());
32
33	20	$plates->addConfig($config);
		0 ignored issues – show Documentation Bug introduced 2018-01-26 20:50 UTC by Report Bug Copy Issue Report The method `addConfig` does not exist on `object<League\Plates\Engine>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
34
35	20	return $plates;
36		}
37
38		/** @return string */
39	20	public function render($template_name, array $data = [], array $attributes = []) {
40	20	return $this->container->get('renderTemplate')->renderTemplate(new Template(
41	20	$template_name,
42	20	$data,
43	20	$attributes
44		));
45		}
46
47	20	public function addMethods(array $methods) {
48	20	$this->container->merge('engine_methods', $methods);
49	20	}
50	20	public function __call($method, array $args) {
51	20	$methods = $this->container->get('engine_methods');
52	20	if (isset($methods[$method])) {
53	20	return $methods[$method]($this, ...$args);
54		}
55
56		throw new \BadMethodCallException("No method {$method} found for engine.");
57		}
58
59		/** @deprecated kept for bc */
60		public function loadExtension(Extension $extension) {
61		$this->register($extension);
62		}
63	20	public function register(Extension $extension) {
64	20	$extension->register($this);
65	20	}
66
67	20	public function getContainer() {
68	20	return $this->container;
69		}
70		}
71

thephpleague / plates

Pull Request — master (#213)

Engine::loadExtension() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like