M1\Env\Parser

Complexity

Total Complexity

11

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	parseLine()	0	14	2
A	parseKeyValue()	0	16	2
A	parse()	0	10	2
A	parseContent()	0	17	4

<?php

/**
 * This file is part of the m1\env library
 *
 * (c) m1 <hello@milescroxford.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package     m1/env
 * @version     1.0.0
 * @author      Miles Croxford <hello@milescroxford.com>
 * @copyright   Copyright (c) Miles Croxford <hello@milescroxford.com>
 * @license     http://github.com/m1/env/blob/master/LICENSE.md
 * @link        http://github.com/m1/env/blob/master/README.md Documentation
 */

namespace M1\Env;

use M1\Env\Exception\ParseException;
use M1\Env\Parser\AbstractParser;
use M1\Env\Parser\ValueParser;
use M1\Env\Parser\KeyParser;

/**
 * The .env parser
 *
 * @since 0.1.0
 */
class Parser extends AbstractParser
{
    /**
     * The Env key parser
     *
     * @var \M1\Env\Parser\KeyParser $key_parser
     */
    private $key_parser;

    /**
     * The Env value parser
     *
     * @var \M1\Env\Parser\ValueParser $value_parser
     */
    private $value_parser;

    /**
     * The parser constructor
     *
     * @param string $file             The .env to parse
     * @param bool   $origin_exception Whether or not to throw ParseException in the .env
     */
    public function __construct($file, $origin_exception = false)
    {
        parent::__construct($file, $origin_exception);

        $this->key_parser = new KeyParser($file, $origin_exception);
        $this->value_parser = new ValueParser($file, $origin_exception);
    }

    /**
     * Opens the .env, parses it then returns the contents
     *
     * @return array The .env contents
     */
    public function parse()
    {
        $raw_content = file($this->file, FILE_IGNORE_NEW_LINES);

        if (!$raw_content) {

The expression $raw_content of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return array();
        }

        return $this->parseContent($raw_content);
    }

    /**
     * Parses the .env line by line
     *
     * @param array $raw_content The raw content of the file
     *
     * @throws \M1\Env\Exception\ParseException If the file does not have a key=value structure
     *
     * @return array The .env contents
     */
    public function parseContent(array $raw_content)
    {
        $lines = array();
        $line_num = 0;

        foreach ($raw_content as $raw_line) {
            $line_num++;

            if ($this->startsWith('#', $raw_line) || !$raw_line) {
                continue;
            }

            $lines = $this->parseLine($raw_line, $line_num, $lines);
        }

        return $lines;
    }

    /**
     * Parses a line of the .env
     *
     * @param string $raw_line The raw content of the line
     * @param int    $line_num The line number of the line
     * @param array  $lines    The parsed lines
     *
     * @return array The parsed lines
     */
    private function parseLine($raw_line, $line_num, $lines)
    {
        list($key, $value) = $this->parseKeyValue($raw_line, $line_num);

        $key = $this->key_parser->parse($key, $line_num);

        if (!is_string($key)) {
            return $lines;
        }

        $lines[$key] = $this->value_parser->parse($value, $lines, $line_num);

        return $lines;
    }

    /**
     * Gets the key = value items from the line
     *
     * @param string $raw_line The raw content of the line
     * @param int    $line_num The line number of the line
     *
     * @throws \M1\Env\Exception\ParseException If the line does not have a key=value structure
     *
     * @return array The parsed lines
     */
    private function parseKeyValue($raw_line, $line_num)
    {
        $key_value = explode("=", $raw_line, 2);

        if (count($key_value) !== 2) {
            throw new ParseException(
                'You must have a key = value',
                $this->origin_exception,
                $this->file,
                $raw_line,
                $line_num
            );
        }

        return $key_value;
    }
}