SilverStripeSentry\Adaptor\RavenClient

Complexity

Total Complexity

13

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	3
A	getSDK()	0	4	1
B	setData()	0	20	5
A	getLevel()	0	6	2
A	send()	0	7	2

<?php

/**
 * Class: RavenClient.
 *
 * @author  Russell Michell 2017 <russ@theruss.com>
 * @package phptek/sentry
 */

namespace SilverStripeSentry\Adaptor;

use SilverStripeSentry\Adaptor\SentryClientAdaptor;
use SilverStripeSentry\Exception\SentryLogWriterException;

/**
 * The RavenClient class simply acts as a bridge between the Raven PHP SDK and
 * the SentryLogWriter class itself. Any {@link SentryClientAdaptor} subclass
 * should be able to be swapped-out and used at any point.
 */

class RavenClient extends SentryClientAdaptor
{
    
    /**
     * It's an ERROR unless proven otherwise!
     * 
     * @var    string
     * @config
     */
    private static $default_error_level = 'ERROR';
    
    /**
     *
     * @var Raven_Client
     */
    protected $client;
    
    /**
     * A mapping of log-level values between Zend_Log => Raven_Client
     * 
     * @var array
     */
    protected $logLevels = [
        'NOTICE'    => \Raven_Client::INFO,
        'WARN'      => \Raven_Client::WARNING,
        'ERR'       => \Raven_Client::ERROR,
        'EMERG'     => \Raven_Client::FATAL
    ];
    
    /**
     * @throws SentryLogWriterException
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct()
    {        
        if (!$dsn = $this->getOpts('dsn')) {
            $msg = sprintf("%s requires a DSN string to be set in config.", __CLASS__);
            throw new SentryLogWriterException($msg);
        }
        
        $this->client = new \Raven_Client($dsn);

It seems like new \Raven_Client($dsn) of type object<Raven_Client> is incompatible with the declared type object<SilverStripeSentry\Adaptor\Raven_Client> of property $client.

        
        // Installs all available PHP error handlers when set
        if ($this->config()->install === true) {
            $this->client->install();
        }
    }

    /**
     * Used in unit tests.
     *
     * @return Raven_Client
     */
    public function getSDK()
    {
        return $this->client;
    }

    /**
     * @inheritdoc
     */
    public function setData($field, $data)
    {
        switch($field) {
            case 'env':
                $this->client->setEnvironment($data);
                break;
            case 'tags':
                $this->client->tags_context($data);
                break;
            case 'user':
                $this->client->user_context($data);
                break;
            case 'extra':
                $this->client->extra_context($data);
                break;
            default:
                $msg = sprintf('Unknown field %s passed to %s.', $field, __FUNCTION__);
                throw new SentryLogWriterException($msg);
        }
    }
    
    /**
     * @inheritdoc
     */
    public function getLevel($level)
    {
        return isset($this->client->logLevels[$level]) ?
            $this->client->logLevels[$level] : 
            $this->client->logLevels[self::$default_error_level];
    }
    
    /**
     * @inheritdoc
     */
    public function send($message, $extras = [], $data, $trace)
    {
        // Raven_Client::captureMessage() returns an ID to identify each message
        $eventId = $this->client->captureMessage($message, $extras, $data, $trace);
        
        return $eventId ?: false;
    }

}