emlynwest / changelog

src/IO/File.php

<?php

/**

 * @category Library

 * @license MIT http://opensource.org/licenses/MIT

 * @link https://github.com/emlynwest/changelog

 */


namespace ChangeLog\IO;


use ChangeLog\AbstractIO;

use InvalidArgumentException;


/**

 * Allows change logs to be loaded from the file system.

 *

 * Config can contain the keys 'file' and 'line_separator'. 'file' is not optional.

 */

class File extends AbstractIO

{


	protected $configDefaults = [

		'line_separator' => "\n",

	];


	/**

	 * {@inheritdoc}

	 *

	 * @throws InvalidArgumentException

	 */

	public function getContent()

	{

		$file = $this->getFileLocation();


		$content = file_get_contents($file);


		return explode(

			$this->getConfig('line_separator'),

It seems like $this->getConfig('line_separator') can also be of type array; however, parameter $separator of explode() does only seem to accept string, maybe add an additional type check?

			$content

		);

	}


	/**

	 * {@inheritdoc}

	 */

	public function setContent($content)

	{

		$file = $this->getFileLocation();

		file_put_contents($file, $content);

	}


	/**

	 * Gets the file location from the config.

	 *

	 * @return string

	 */

	protected function getFileLocation()

	{

		$file = $this->getConfig('file');


		if ( ! $file)

		{

			throw new InvalidArgumentException('File not specified.');

		}


		return $file;

The expression return $file also could return the type array which is incompatible with the documented return type string.

	}


}