UnderstandBaseHandler::write() - Code Metrics - understand/understand-monolog - Measure and Improve Code Quality continuously with Scrutinizer

UnderstandBaseHandler::write() A
last analyzed 2016-01-13 17:07 UTC

↳ Parent: UnderstandBaseHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
rs	9.4286
cc	1
eloc	4
nc	1
nop	1

<?php namespace UnderstandMonolog\Handler;

use UnderstandMonolog\Exception\HandlerException;
use UnderstandMonolog\Formatter\UnderstandFormatter;

use Monolog\Handler\AbstractProcessingHandler;
use Monolog\Logger;

abstract class UnderstandBaseHandler extends AbstractProcessingHandler
{

    /**
     * Input token
     *
     * @var string
     */
    protected $inputToken;

    /**
     * API url
     *
     * @var string
     */
    protected $apiUrl;

    /**
     * Specifies whether logger should throw an exception of issues detected
     *
     * @var bool
     */
    protected $silent = true;

    /**
     * SSL CA bundle path
     *
     * @var string
     */
    protected $sslBundlePath;

    /**
     * Last handler error
     *
     * @var string
     */
    protected $lastError;

    /**
     * @param string $inputToken
     * @param string $apiUrl
     * @param boolean $silent
     * @param string $sslBundlePath
     * @param integer $level
     * @param boolean $bubble
     */
    public function __construct($inputToken, $apiUrl = 'https://api.understand.io', $silent = true, $sslBundlePath = false, $level = Logger::DEBUG, $bubble = true)
    {
        if ($sslBundlePath === false)
        {
            $this->sslBundlePath = __DIR__ . DIRECTORY_SEPARATOR . 'ca_bundle.crt';
        }
        else
        {
            $this->sslBundlePath = $sslBundlePath;
        }

        $this->inputToken = $inputToken;
        $this->apiUrl = $apiUrl;
        $this->silent = $silent;


        parent::__construct($level, $bubble);
    }

    /**
     * Send data to storage
     *
     * @param string $data
     * @return string
     */
    abstract protected function send($data);

    /**
     * Serialize data and send to storage
     *
     * @param array $record
     * @return void
     */
    public function write(array $record)
    {
        $requestData = $record['formatted'];

        $response = $this->send($requestData);

        $this->parseResponse($response, $requestData);
    }

    /**
     * Return endpoint
     *
     * @return string
     */
    protected function getEndpoint()
    {
        return implode('/', [$this->apiUrl, $this->inputToken]);
    }

    /**
     * Parse respnse into array
     *
     * @param string $response
     * @param string $requestData
     * @return array
     */
    protected function parseResponse($response, $requestData)
    {
        $responseArr = json_decode($response, true);

        if ( ! $this->silent && empty($responseArr['count']))
        {
            $this->handleError($responseArr, $requestData);
        }

        return $responseArr;
    }

    /**
     * Transform error respopnse into exception
     *
     * @param string $responseArr
     * @param string $requestData
     * @throws HandlerException
     */
    protected function handleError($responseArr, $requestData)
    {
        if ( ! $responseArr)
        {
            throw new HandlerException('Cannot create connection to ' . $this->apiUrl . ' ' . $this->lastError);
        }

        if (isset($responseArr['error']))
        {
            throw new HandlerException($responseArr['error']);
        }

        throw new HandlerException('Error. ' . ' Request data: ' . json_encode($requestData));
    }

    /**
     * Gets the default formatter.
     *
     * @return FormatterInterface
     */
    protected function getDefaultFormatter()
    {
        return new UnderstandFormatter();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}

1			<?php namespace UnderstandMonolog\Handler;
2
3			use UnderstandMonolog\Exception\HandlerException;
4			use UnderstandMonolog\Formatter\UnderstandFormatter;
5
6			use Monolog\Handler\AbstractProcessingHandler;
7			use Monolog\Logger;
8
9			abstract class UnderstandBaseHandler extends AbstractProcessingHandler
10			{
11
12			/**
13			* Input token
14			*
15			* @var string
16			*/
17			protected $inputToken;
18
19			/**
20			* API url
21			*
22			* @var string
23			*/
24			protected $apiUrl;
25
26			/**
27			* Specifies whether logger should throw an exception of issues detected
28			*
29			* @var bool
30			*/
31			protected $silent = true;
32
33			/**
34			* SSL CA bundle path
35			*
36			* @var string
37			*/
38			protected $sslBundlePath;
39
40			/**
41			* Last handler error
42			*
43			* @var string
44			*/
45			protected $lastError;
46
47			/**
48			* @param string $inputToken
49			* @param string $apiUrl
50			* @param boolean $silent
51			* @param string $sslBundlePath
52			* @param integer $level
53			* @param boolean $bubble
54			*/
55			public function __construct($inputToken, $apiUrl = 'https://api.understand.io', $silent = true, $sslBundlePath = false, $level = Logger::DEBUG, $bubble = true)
56			{
57			if ($sslBundlePath === false)
58			{
59			$this->sslBundlePath = __DIR__ . DIRECTORY_SEPARATOR . 'ca_bundle.crt';
60			}
61			else
62			{
63			$this->sslBundlePath = $sslBundlePath;
64			}
65
66			$this->inputToken = $inputToken;
67			$this->apiUrl = $apiUrl;
68			$this->silent = $silent;
69
70
71			parent::__construct($level, $bubble);
72			}
73
74			/**
75			* Send data to storage
76			*
77			* @param string $data
78			* @return string
79			*/
80			abstract protected function send($data);
81
82			/**
83			* Serialize data and send to storage
84			*
85			* @param array $record
86			* @return void
87			*/
88			public function write(array $record)
89			{
90			$requestData = $record['formatted'];
91
92			$response = $this->send($requestData);
93
94			$this->parseResponse($response, $requestData);
95			}
96
97			/**
98			* Return endpoint
99			*
100			* @return string
101			*/
102			protected function getEndpoint()
103			{
104			return implode('/', [$this->apiUrl, $this->inputToken]);
105			}
106
107			/**
108			* Parse respnse into array
109			*
110			* @param string $response
111			* @param string $requestData
112			* @return array
113			*/
114			protected function parseResponse($response, $requestData)
115			{
116			$responseArr = json_decode($response, true);
117
118			if ( ! $this->silent && empty($responseArr['count']))
119			{
120			$this->handleError($responseArr, $requestData);
121			}
122
123			return $responseArr;
124			}
125
126			/**
127			* Transform error respopnse into exception
128			*
129			* @param string $responseArr
130			* @param string $requestData
131			* @throws HandlerException
132			*/
133			protected function handleError($responseArr, $requestData)
134			{
135			if ( ! $responseArr)
136			{
137			throw new HandlerException('Cannot create connection to ' . $this->apiUrl . ' ' . $this->lastError);
138			}
139
140			if (isset($responseArr['error']))
141			{
142			throw new HandlerException($responseArr['error']);
143			}
144
145			throw new HandlerException('Error. ' . ' Request data: ' . json_encode($requestData));
146			}
147
148			/**
149			* Gets the default formatter.
150			*
151			* @return FormatterInterface
152			*/
153			protected function getDefaultFormatter()
154			{
155			return new UnderstandFormatter();
			0 ignored issues – show Bug Best Practice introduced 2016-01-13 17:07 UTC by Report Bug Copy Issue Report The return type of `return new \UnderstandMo...\UnderstandFormatter();` (`UnderstandMonolog\Formatter\UnderstandFormatter`) is incompatible with the return type of the parent method `Monolog\Handler\Abstract...er::getDefaultFormatter` of type `Monolog\Formatter\LineFormatter`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
156			}
157			}

understand / understand-monolog

UnderstandBaseHandler::write() A last analyzed 2016-01-13 17:07 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UnderstandBaseHandler::write() A
last analyzed 2016-01-13 17:07 UTC