Plasma\Drivers\MySQL\Messages\ErrResponseMessage

Complexity

Total Complexity

7

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Test Coverage

Coverage

69.57%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getParser()	0	2	1
A	__construct()	0	2	1
A	setParserState()	0	2	1
A	getID()	0	2	1
A	parseMessage()	0	19	3

<?php
/**
 * Plasma Driver MySQL component
 * Copyright 2018-2019 PlasmaPHP, All Rights Reserved
 *
 * Website: https://github.com/PlasmaPHP
 * License: https://github.com/PlasmaPHP/driver-mysql/blob/master/LICENSE
*/

namespace Plasma\Drivers\MySQL\Messages;

/**
 * Represents an Error Response Message.
 */
class ErrResponseMessage implements \Plasma\Drivers\MySQL\Messages\MessageInterface {
    /**
     * Error code.
     * @var int
     */
    public $errorCode;
    
    /**
     * SQL State marker, if any.
     * @var string|null
     */
    public $sqlStateMarker;
    
    /**
     * SQL State, if any.
     * @var string|null
     */
    public $sqlState;
    
    /**
     * Error message.
     * @var string
     */
    public $errorMessage;
    
    /**
     * @var \Plasma\Drivers\MySQL\ProtocolParser
     * @internal
     */
    protected $parser;
    
    /**
     * Constructor.
     * @param \Plasma\Drivers\MySQL\ProtocolParser  $parser
     * @internal
     */
    function __construct(\Plasma\Drivers\MySQL\ProtocolParser $parser) {
        $this->parser = $parser;
    }
    
    /**
     * Get the identifier for the packet.
     * @return string
     * @internal
     */
    static function getID(): string {
        return "\xFF";
    }
    
    /**
     * Parses the message, once the complete string has been received.
     * Returns false if not enough data has been received, or the remaining buffer.
     * @param \Plasma\BinaryBuffer  $buffer
     * @return bool
     * @throws \Plasma\Drivers\MySQL\Messages\ParseException
     * @internal
     */
    function parseMessage(\Plasma\BinaryBuffer $buffer): bool {
        $this->errorCode = $buffer->readInt2();
        
        $handshake = $this->parser->getHandshakeMessage();
        if(!$handshake || $this->parser->getState() == \Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE) {
            $exception = new \Plasma\Drivers\MySQL\Messages\ParseException($buffer->getContents(), $this->errorCode);
            $exception->setState(\Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE_ERROR);
            $exception->setBuffer('');
            
            $buffer->clear();
            throw $exception;
        }
        
        $this->sqlStateMarker = $buffer->readStringLength(1);
        $this->sqlState = $buffer->readStringLength(5);
        $this->errorMessage = $buffer->getContents();
        
        $buffer->clear();
        return true;
    }
    
    /**
     * Get the parser which created this message.
     * @return \Plasma\Drivers\MySQL\ProtocolParser
     * @internal
     */
    function getParser(): \Plasma\Drivers\MySQL\ProtocolParser {
        return $this->parser;
    }
    
    /**
     * Sets the parser state, if necessary. If not, return `-1`.
     * @return int
     * @internal
     */
    function setParserState(): int {
        return \Plasma\Drivers\MySQL\ProtocolParser::STATE_OK;
    }
}