SimplePie::setMiddlewareStack() - Code Metrics - Inspection of "Re-threaded the logger throughout the codebase." - simplepie/simplepie-ng - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 80d940...616322 )

by Ryan

created 2017-12-10 03:36 UTC

SimplePie::setMiddlewareStack() A

↳ Parent: SimplePie

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
c	0
b	0
f	0
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

<?php

/**
 * Copyright (c) 2017 Ryan Parman <http://ryanparman.com>.
 * Copyright (c) 2017 Contributors.
 *
 * http://opensource.org/licenses/Apache2.0
 */

declare(strict_types=1);

namespace SimplePie;

use Psr\Http\Message\StreamInterface;
use Psr\Log\NullLogger;
use SimplePie\Configuration\SetLoggerInterface;
use SimplePie\Middleware\Xml\Atom;
use SimplePie\Mixin as T;
use SimplePie\Parser\Xml as XmlParser;

\define('SIMPLEPIE_ROOT', __DIR__);

/**
 * `SimplePie\SimplePie` is the primary entry point for SimplePie NG.
 */
class SimplePie implements SetLoggerInterface
{
    use T\LoggerTrait;

    /**
     * Bitwise libxml options to use for parsing XML.
     *
     * @var int
     */
    protected $libxml;

    /**
     * The handler stack which contains registered middleware.
     *
     * @var HandlerStackInterface
     */
    protected $middleware;

    /**
     * Constructs a new instance of this class.
     */
    public function __construct()
    {
        // Default logger
        $this->logger = new NullLogger();

        // Default middleware stack
        $this->middleware = new HandlerStack();
        $this->middleware->setLogger($this->getLogger());
        $this->middleware->append(new Atom(), 'atom');

        // Default libxml2 settings
        $this->libxml = LIBXML_HTML_NOIMPLIED // Required, or things crash.
            | LIBXML_BIGLINES
            | LIBXML_COMPACT
            | LIBXML_HTML_NODEFDTD
            | LIBXML_NOBLANKS
            | LIBXML_NOENT
            | LIBXML_NOXMLDECL
            | LIBXML_NSCLEAN
            | LIBXML_PARSEHUGE;
    }

    //--------------------------------------------------------------------------

    /**
     * Sets the libxml value to use for parsing XML.
     *
     * @param int $libxml
     *
     * @return int

     */
    public function setLibxml(int $libxml)
    {
        $this->libxml = $libxml;

        // What are the libxml2 configurations?
        $this->logger->debug(\sprintf(
            'Libxml configuration has a bitwise value of `%s`.%s',
            $this->libxml,
            (4792582 === $this->libxml)
                ? ' (This is the default configuration.)'
                : ''
        ));

        return $this;
    }

    /**
     * Gets the libxml value to use for parsing XML.
     *
     * @return int
     */
    public function getLibxml(): int
    {
        return $this->libxml;
    }

    /**
     * Sets the handler stack which contains registered middleware.
     *
     * @param HandlerStackInterface $handlerStack
     *
     * @return self
     */
    public function setMiddlewareStack(HandlerStackInterface $handlerStack)
    {
        $this->middleware = $handlerStack;
        $this->middleware->setLogger($this->getLogger());

        return $this;
    }

    /**
     * Gets the handler stack which contains registered middleware.
     *
     * @return HandlerStackInterface
     */
    public function getMiddlewareStack(): HandlerStackInterface
    {
        return $this->middleware;
    }

    //--------------------------------------------------------------------------

    /**
     * Parses content which is known to be valid XML and is encoded as UTF-8.
     *
     * @param StreamInterface $stream                  A PSR-7 `StreamInterface` which is typically returned by the
     *                                                 `getBody()` method of a `ResponseInterface` class.
     * @param bool            $handleHtmlEntitiesInXml Whether or not SimplePie should pre-parse the XML as HTML to
     *                                                 resolve the entities. A value of `true` means that SimplePie
     *                                                 should inject the entity definitions. A value of `false` means
     *                                                 that SimplePie should NOT inject the entity definitions. The
     *                                                 default value is `false`.
     *
     * @return XmlParser
     */
    public function parseXml(StreamInterface $stream, bool $handleHtmlEntitiesInXml = false): XmlParser
    {
        $parser = new XmlParser(
            $stream,
            $this->logger,
            $this->middleware,
            $this->libxml,
            $handleHtmlEntitiesInXml
        );

        return $parser;
    }

    /**
     * Parses content which is known to be valid JSON and is encoded as UTF-8.
     *
     * @param StreamInterface $stream A PSR-7 `StreamInterface` which is typically returned by the
     *                                `getBody()` method of a `ResponseInterface` class.
     *
     * @return JsonParser

     */
    public function parseJson(StreamInterface $stream)
    {
        return $stream->getContents();
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-08-29 22:30 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 20 and the first side effect is on line 20. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* Copyright (c) 2017 Ryan Parman <http://ryanparman.com>.
4			* Copyright (c) 2017 Contributors.
5			*
6			* http://opensource.org/licenses/Apache2.0
7			*/
8
9			declare(strict_types=1);
10
11			namespace SimplePie;
12
13			use Psr\Http\Message\StreamInterface;
14			use Psr\Log\NullLogger;
15			use SimplePie\Configuration\SetLoggerInterface;
16			use SimplePie\Middleware\Xml\Atom;
17			use SimplePie\Mixin as T;
18			use SimplePie\Parser\Xml as XmlParser;
19
20			\define('SIMPLEPIE_ROOT', __DIR__);
21
22			/**
23			* `SimplePie\SimplePie` is the primary entry point for SimplePie NG.
24			*/
25			class SimplePie implements SetLoggerInterface
26			{
27			use T\LoggerTrait;
28
29			/**
30			* Bitwise libxml options to use for parsing XML.
31			*
32			* @var int
33			*/
34			protected $libxml;
35
36			/**
37			* The handler stack which contains registered middleware.
38			*
39			* @var HandlerStackInterface
40			*/
41			protected $middleware;
42
43			/**
44			* Constructs a new instance of this class.
45			*/
46			public function __construct()
47			{
48			// Default logger
49			$this->logger = new NullLogger();
50
51			// Default middleware stack
52			$this->middleware = new HandlerStack();
53			$this->middleware->setLogger($this->getLogger());
54			$this->middleware->append(new Atom(), 'atom');
55
56			// Default libxml2 settings
57			$this->libxml = LIBXML_HTML_NOIMPLIED // Required, or things crash.
58			\| LIBXML_BIGLINES
59			\| LIBXML_COMPACT
60			\| LIBXML_HTML_NODEFDTD
61			\| LIBXML_NOBLANKS
62			\| LIBXML_NOENT
63			\| LIBXML_NOXMLDECL
64			\| LIBXML_NSCLEAN
65			\| LIBXML_PARSEHUGE;
66			}
67
68			//--------------------------------------------------------------------------
69
70			/**
71			* Sets the libxml value to use for parsing XML.
72			*
73			* @param int $libxml
74			*
75			* @return int
			0 ignored issues – show Documentation introduced 2017-12-10 03:48 UTC by Report Bug Copy Issue Report Should the return type not be `SimplePie`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
76			*/
77			public function setLibxml(int $libxml)
78			{
79			$this->libxml = $libxml;
80
81			// What are the libxml2 configurations?
82			$this->logger->debug(\sprintf(
83			'Libxml configuration has a bitwise value of `%s`.%s',
84			$this->libxml,
85			(4792582 === $this->libxml)
86			? ' (This is the default configuration.)'
87			: ''
88			));
89
90			return $this;
91			}
92
93			/**
94			* Gets the libxml value to use for parsing XML.
95			*
96			* @return int
97			*/
98			public function getLibxml(): int
99			{
100			return $this->libxml;
101			}
102
103			/**
104			* Sets the handler stack which contains registered middleware.
105			*
106			* @param HandlerStackInterface $handlerStack
107			*
108			* @return self
109			*/
110			public function setMiddlewareStack(HandlerStackInterface $handlerStack)
111			{
112			$this->middleware = $handlerStack;
113			$this->middleware->setLogger($this->getLogger());
114
115			return $this;
116			}
117
118			/**
119			* Gets the handler stack which contains registered middleware.
120			*
121			* @return HandlerStackInterface
122			*/
123			public function getMiddlewareStack(): HandlerStackInterface
124			{
125			return $this->middleware;
126			}
127
128			//--------------------------------------------------------------------------
129
130			/**
131			* Parses content which is known to be valid XML and is encoded as UTF-8.
132			*
133			* @param StreamInterface $stream A PSR-7 `StreamInterface` which is typically returned by the
134			* `getBody()` method of a `ResponseInterface` class.
135			* @param bool $handleHtmlEntitiesInXml Whether or not SimplePie should pre-parse the XML as HTML to
136			* resolve the entities. A value of `true` means that SimplePie
137			* should inject the entity definitions. A value of `false` means
138			* that SimplePie should NOT inject the entity definitions. The
139			* default value is `false`.
140			*
141			* @return XmlParser
142			*/
143			public function parseXml(StreamInterface $stream, bool $handleHtmlEntitiesInXml = false): XmlParser
144			{
145			$parser = new XmlParser(
146			$stream,
147			$this->logger,
148			$this->middleware,
149			$this->libxml,
150			$handleHtmlEntitiesInXml
151			);
152
153			return $parser;
154			}
155
156			/**
157			* Parses content which is known to be valid JSON and is encoded as UTF-8.
158			*
159			* @param StreamInterface $stream A PSR-7 `StreamInterface` which is typically returned by the
160			* `getBody()` method of a `ResponseInterface` class.
161			*
162			* @return JsonParser
			0 ignored issues – show Documentation introduced 2017-08-29 22:30 UTC by Report Bug Copy Issue Report Should the return type not be `string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
163			*/
164			public function parseJson(StreamInterface $stream)
165			{
166			return $stream->getContents();
167			}
168			}
169

simplepie / simplepie-ng

Push — master ( 80d940...616322 )

SimplePie::setMiddlewareStack() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like