Resolver::config() - Code Metrics - Inspection of "Adds ability to render basic opengraph metadata ta..." - journeygroup/vssl-render - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 278516...ea5609 )

by Justin

created 2017-03-03 02:22 UTC

Resolver::config() A

↳ Parent: Resolver

Complexity

Conditions	4
Paths	4

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	12
cts	12
cp	1
rs	9.2
c	0
b	0
f	0
cc	4
eloc	12
nc	4
nop	1
crap	4

<?php

namespace Vssl\Render;

use GuzzleHttp\Client;
use Journey\Cache\Adapters\LocalAdapter;
use Journey\Cache\CacheAdapterInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

class Resolver
{
    /**
     * The request object.
     *
     * @var \Psr\Http\Message\ServerRequestInterface
     */
    protected $request;

    /**
     * Configuration array.
     *
     * @var array
     */
    protected $config;

    /**
     * The page api object.
     *
     * @var \Vssl\Render\PageApi
     */
    protected $api;

    /**
     * Initialize a new Resolver
     */
    public function __construct(ServerRequestInterface $request, $config = false)
    {
        $this->request = $request;
        $this->config = is_array($config) ? static::config($config) : static::config();
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if (!$this->config['cache'] instanceof CacheAdapterInterface) {
            throw new ResolverException('Cache must implement \Journey\Cache\CacheAdapterInterface.');
        }
        $this->api = new PageApi($request, $this->config);
    }

    /**
     * Get a modified request message.
     *
     * @return \Psr\Http\Message\ServerRequestInterface
     */
    public function getRequest()
    {
        return $this->request->withAttribute('vssl-page', $this->resolve());
    }

    /**
     * Resolve the current page from WebStories. Returns a render able page or
     * false.
     *
     * @return array
     */
    public function resolve()
    {
        $response = $this->api->getPage($this->request->getUri()->getPath());
        if ($response && ($page = $this->decodePage($response))) {
            $status = $response->getStatusCode();
            return [
                'status' => $status,
                'data' => $page,
                'page' => (is_array($page) && $status == 200) ? new Renderer($this->config, $page) : $page,
                'opengraph' => (is_array($page) && $status == 200) ? new Metadata($this->config, $page) : $page,
                'type' => !empty($page['type']) ? $page['type'] : false
            ];
        }
        return [
            'status' => false,
            'error' => 'An unknown error occurred',
            'data' => []
        ];
    }

    /**
     * Decode the body of a particular request.
     *
     * @return mixed
     */
    public function decodePage(ResponseInterface $response)
    {
        $body = (string) $response->getBody();
        if ($response->getHeaderLine('Content-Type') == "application/json") {
            $page = json_decode($body, true);
            return !empty($page['exists']) ? $page['page'] : false;
        }
        return false;
    }

    /**
     * Configure the resolver.
     *
     * @return void
     */
    public static function config($assign = false)
    {
        static $config;

        if (is_array($assign) || !$config) {
            $config = array_merge([
                'cache' => null,
                'base_uri' => 'https://pages.vssl.io/',
                'required_fields' => [
                    'id',
                    'title',
                    'stripes'
                ],
                // 'templates' => 'your-directory'

            ], $assign);
        }
        return $config ?: [];
    }
}


1		<?php
2
3		namespace Vssl\Render;
4
5		use GuzzleHttp\Client;
6		use Journey\Cache\Adapters\LocalAdapter;
7		use Journey\Cache\CacheAdapterInterface;
8		use Psr\Http\Message\ResponseInterface;
9		use Psr\Http\Message\ServerRequestInterface;
10
11		class Resolver
12		{
13		/**
14		* The request object.
15		*
16		* @var \Psr\Http\Message\ServerRequestInterface
17		*/
18		protected $request;
19
20		/**
21		* Configuration array.
22		*
23		* @var array
24		*/
25		protected $config;
26
27		/**
28		* The page api object.
29		*
30		* @var \Vssl\Render\PageApi
31		*/
32		protected $api;
33
34		/**
35		* Initialize a new Resolver
36		*/
37	4	public function __construct(ServerRequestInterface $request, $config = false)
38		{
39	4	$this->request = $request;
40	4	$this->config = is_array($config) ? static::config($config) : static::config();
		0 ignored issues – show Documentation introduced 2017-02-10 04:34 UTC by Report Bug Copy Issue Report `$config` is of type `array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
41	4	if (!$this->config['cache'] instanceof CacheAdapterInterface) {
42		throw new ResolverException('Cache must implement \Journey\Cache\CacheAdapterInterface.');
43		}
44	4	$this->api = new PageApi($request, $this->config);
45	4	}
46
47		/**
48		* Get a modified request message.
49		*
50		* @return \Psr\Http\Message\ServerRequestInterface
51		*/
52	4	public function getRequest()
53		{
54	4	return $this->request->withAttribute('vssl-page', $this->resolve());
55		}
56
57		/**
58		* Resolve the current page from WebStories. Returns a render able page or
59		* false.
60		*
61		* @return array
62		*/
63	4	public function resolve()
64		{
65	4	$response = $this->api->getPage($this->request->getUri()->getPath());
66	4	if ($response && ($page = $this->decodePage($response))) {
67	3	$status = $response->getStatusCode();
68		return [
69	3	'status' => $status,
70	3	'data' => $page,
71	3	'page' => (is_array($page) && $status == 200) ? new Renderer($this->config, $page) : $page,
72	3	'opengraph' => (is_array($page) && $status == 200) ? new Metadata($this->config, $page) : $page,
73	3	'type' => !empty($page['type']) ? $page['type'] : false
74	3	];
75		}
76		return [
77	1	'status' => false,
78	1	'error' => 'An unknown error occurred',
79	1	'data' => []
80	1	];
81		}
82
83		/**
84		* Decode the body of a particular request.
85		*
86		* @return mixed
87		*/
88	3	public function decodePage(ResponseInterface $response)
89		{
90	3	$body = (string) $response->getBody();
91	3	if ($response->getHeaderLine('Content-Type') == "application/json") {
92	3	$page = json_decode($body, true);
93	3	return !empty($page['exists']) ? $page['page'] : false;
94		}
95		return false;
96		}
97
98		/**
99		* Configure the resolver.
100		*
101		* @return void
102		*/
103	16	public static function config($assign = false)
104		{
105	16	static $config;
106
107	16	if (is_array($assign) \|\| !$config) {
108	10	$config = array_merge([
109	10	'cache' => null,
110	10	'base_uri' => 'https://pages.vssl.io/',
111		'required_fields' => [
112	10	'id',
113	10	'title',
114		'stripes'
115	10	],
116		// 'templates' => 'your-directory'
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-10 04:34 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
117	10	], $assign);
118	10	}
119	16	return $config ?: [];
120		}
121		}
122

journeygroup / vssl-render

Push — master ( 278516...ea5609 )

Resolver::config() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like