BufferedIO - Code Metrics - webmozart/console - Measure and Improve Code Quality continuously with Scrutinizer

BufferedIO A
last analyzed 2016-08-15 15:54 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	1	Features	3

Metric	Value
wmc	9
c	5
b	1
f	3
lcom	1
cbo	6
dl	0
loc	82
ccs	26
cts	26
cp	1
rs	10

8 Methods

Rating	Name	Size	Complexity
A	setInput()	4	1
A	appendInput()	4	1
A	clearInput()	4	1
A	fetchOutput()	4	1
A	clearOutput()	4	1
A	fetchErrors()	4	1
A	clearErrors()	4	1
A	__construct()	9	2

<?php

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

namespace Webmozart\Console\IO;

use Webmozart\Console\Api\Formatter\Formatter;
use Webmozart\Console\Api\IO\Input;
use Webmozart\Console\Api\IO\IO;
use Webmozart\Console\Api\IO\Output;
use Webmozart\Console\Formatter\PlainFormatter;
use Webmozart\Console\IO\InputStream\StringInputStream;
use Webmozart\Console\IO\OutputStream\BufferedOutputStream;

/**
 * An I/O that reads from and writes to a buffer.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 */
class BufferedIO extends IO
{
    /**
     * Creates the I/O.
     *
     * @param string    $inputData The data to return from the input.
     * @param Formatter $formatter The formatter to use.

     */
    public function __construct($inputData = '', Formatter $formatter = null)
    {
        $formatter = $formatter ?: new PlainFormatter();
        $input = new Input(new StringInputStream($inputData));
        $output = new Output(new BufferedOutputStream(), $formatter);
        $errorOutput = new Output(new BufferedOutputStream(), $formatter);

        parent::__construct($input, $output, $errorOutput);
    }

    /**
     * Sets the contents of the input buffer.
     *
     * @param string $data The input data.
     */
    public function setInput($data)
    {
        $this->getInput()->getStream()->set($data);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Appends data to the input buffer.
     *
     * @param string $data The input data to append.
     */
    public function appendInput($data)
    {
        $this->getInput()->getStream()->append($data);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Clears the input buffer.
     */
    public function clearInput()
    {
        $this->getInput()->getStream()->clear();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Returns the contents of the output buffer.
     *
     * @return string The output data.
     */
    public function fetchOutput()
    {
        return $this->getOutput()->getStream()->fetch();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Clears the output buffer.
     */
    public function clearOutput()
    {
        $this->getOutput()->getStream()->clear();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Returns the contents of the error output buffer.
     *
     * @return string The data of the error output.
     */
    public function fetchErrors()
    {
        return $this->getErrorOutput()->getStream()->fetch();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Clears the error output buffer.
     */
    public function clearErrors()
    {
        $this->getErrorOutput()->getStream()->clear();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1		<?php
2
3		/*
4		* This file is part of the webmozart/console package.
5		*
6		* (c) Bernhard Schussek <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Webmozart\Console\IO;
13
14		use Webmozart\Console\Api\Formatter\Formatter;
15		use Webmozart\Console\Api\IO\Input;
16		use Webmozart\Console\Api\IO\IO;
17		use Webmozart\Console\Api\IO\Output;
18		use Webmozart\Console\Formatter\PlainFormatter;
19		use Webmozart\Console\IO\InputStream\StringInputStream;
20		use Webmozart\Console\IO\OutputStream\BufferedOutputStream;
21
22		/**
23		* An I/O that reads from and writes to a buffer.
24		*
25		* @since 1.0
26		*
27		* @author Bernhard Schussek <[email protected]>
28		*/
29		class BufferedIO extends IO
30		{
31		/**
32		* Creates the I/O.
33		*
34		* @param string $inputData The data to return from the input.
35		* @param Formatter $formatter The formatter to use.
		0 ignored issues – show Documentation introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report Should the type for parameter `$formatter` not be `null\|Formatter`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
36		*/
37	158	public function __construct($inputData = '', Formatter $formatter = null)
38		{
39	158	$formatter = $formatter ?: new PlainFormatter();
40	158	$input = new Input(new StringInputStream($inputData));
41	158	$output = new Output(new BufferedOutputStream(), $formatter);
42	158	$errorOutput = new Output(new BufferedOutputStream(), $formatter);
43
44	158	parent::__construct($input, $output, $errorOutput);
45	158	}
46
47		/**
48		* Sets the contents of the input buffer.
49		*
50		* @param string $data The input data.
51		*/
52	3	public function setInput($data)
53		{
54	3	$this->getInput()->getStream()->set($data);
		0 ignored issues – show Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Webmozart\Console\Api\IO\InputStream` as the method `set()` does only exist in the following implementations of said interface: `Webmozart\Console\IO\InputStream\StringInputStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
55	3	}
56
57		/**
58		* Appends data to the input buffer.
59		*
60		* @param string $data The input data to append.
61		*/
62	1	public function appendInput($data)
63		{
64	1	$this->getInput()->getStream()->append($data);
		0 ignored issues – show Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Webmozart\Console\Api\IO\InputStream` as the method `append()` does only exist in the following implementations of said interface: `Webmozart\Console\IO\InputStream\StringInputStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
65	1	}
66
67		/**
68		* Clears the input buffer.
69		*/
70	1	public function clearInput()
71		{
72	1	$this->getInput()->getStream()->clear();
		0 ignored issues – show Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Webmozart\Console\Api\IO\InputStream` as the method `clear()` does only exist in the following implementations of said interface: `Webmozart\Console\IO\InputStream\StringInputStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
73	1	}
74
75		/**
76		* Returns the contents of the output buffer.
77		*
78		* @return string The output data.
79		*/
80	93	public function fetchOutput()
81		{
82	93	return $this->getOutput()->getStream()->fetch();
		0 ignored issues – show Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Webmozart\Console\Api\IO\OutputStream` as the method `fetch()` does only exist in the following implementations of said interface: `Webmozart\Console\IO\Out...am\BufferedOutputStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
83		}
84
85		/**
86		* Clears the output buffer.
87		*/
88	1	public function clearOutput()
89		{
90	1	$this->getOutput()->getStream()->clear();
		0 ignored issues – show Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Webmozart\Console\Api\IO\OutputStream` as the method `clear()` does only exist in the following implementations of said interface: `Webmozart\Console\IO\Out...am\BufferedOutputStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
91	1	}
92
93		/**
94		* Returns the contents of the error output buffer.
95		*
96		* @return string The data of the error output.
97		*/
98	6	public function fetchErrors()
99		{
100	6	return $this->getErrorOutput()->getStream()->fetch();
		0 ignored issues – show Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Webmozart\Console\Api\IO\OutputStream` as the method `fetch()` does only exist in the following implementations of said interface: `Webmozart\Console\IO\Out...am\BufferedOutputStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
101		}
102
103		/**
104		* Clears the error output buffer.
105		*/
106	1	public function clearErrors()
107		{
108	1	$this->getErrorOutput()->getStream()->clear();
		0 ignored issues – show Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Webmozart\Console\Api\IO\OutputStream` as the method `clear()` does only exist in the following implementations of said interface: `Webmozart\Console\IO\Out...am\BufferedOutputStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
109	1	}
110		}
111

webmozart / console

BufferedIO A last analyzed 2016-08-15 15:54 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

BufferedIO A
last analyzed 2016-08-15 15:54 UTC