Lazzard\FtpBridge\Response\ResponseParser

Complexity

Total Complexity

9

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	parseMessage()	0	9	2
A	parseToArray()	0	6	1
A	__construct()	0	3	1
A	parseCode()	0	13	3
A	isMultiline()	0	14	2

<?php

/*
 * This file is part of the Lazzard/ftp-bridge package.
 *
 * (c) El Amrani Chakir <elamrani.sv.laza@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Lazzard\FtpBridge\Response;

use Lazzard\FtpBridge\Exception\ResponseParserException;

/**
 * Provides methods to parse a raw FTP response string.
 */
class ResponseParser
{
    /** @var string */
    protected $raw;

    const MATCHES = [
        'code'      => '/^\d+/',
        'message'   => '/[A-z ]+.*/',
        'multiline' => '/^\d{2,}-/',
    ];

    /**
     * @param string $raw
     */
    public function __construct($raw)
    {
        $this->raw = $raw;
    }

    /**
     * Parses a raw FTP response string into an array representation.
     *
     * @return array
     */
    public function parseToArray()
    {
        return array(
            'code'      => $this->parseCode(),
            'message'   => $this->parseMessage(),
            'multiline' => $this->isMultiline(),
        );
    }

    /**
     * @return false|int
     */
    protected function parseCode()
    {
        $result = preg_match(self::MATCHES['code'], $this->raw, $matches);

        if ($result === false) {
            throw new ResponseParserException("Failed to match " . self::MATCHES['code'] . " pattern.");
        }

        if (count($matches) > 0) {
            return (int)$matches[0];
        }

        return false;
    }

    /**
     * @return string
     */
    protected function parseMessage()
    {
        $result = preg_match(self::MATCHES['message'], $this->raw, $matches);

        if ($result === false) {
            throw new ResponseParserException("Failed to match " . self::MATCHES['message'] . " pattern.");
        }

        return str_replace("\r",'',$matches[0]);  // remove the carriage return from the end
    }

    /**
     * @return bool
     */
    protected function isMultiline()
    {
        // according to RFC959, an FTP replay may consists of multiple lines and at least one line,
        // to check weather if a replay consists of multiple lines or not the RFC959 sets a convention,
        // for multiple lines replies the first line must be on a special format, the replay code
        // must immediately followed by a minus "-" character.
        //@link https://tools.ietf.org/html/rfc959#section-4
        $match = preg_match(self::MATCHES['multiline'], $this->raw);

        if ($match === false) {
            throw new ResponseParserException("Failed to match the response multiline pattern.");
        }

        return $match === 1;
    }
}