emlynwest / changelog

src/IO/Flysystem.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;

use League\Flysystem\Filesystem;


/**

 * Allows change logs to be loaded via a Flysystem adaptor.

 *

 * Config can contain the keys 'file', 'filesystem' and 'line_separator'. 'file' and 'filesystem' are not optional.

 */

class Flysystem extends AbstractIO

{


	protected $configDefaults = [

		'line_separator' => "\n",

	];


	/**

	 * {@inheritdoc}

	 *

	 * @throws InvalidArgumentException

	 */

	public function getContent()

	{

		$file = $this->getFileLocation();

		$filesystem = $this->getFilesystem();


		$content = $filesystem->read($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();

		$filesystem = $this->getFilesystem();


		$filesystem->put($file, $content);

The method put() does not exist on League\Flysystem\Filesystem.

	}


	/**

	 * 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.

	}


	/**

	 * @return Filesystem

	 */

	protected function getFilesystem()

	{

		$adaptor = $this->getConfig('filesystem');


		if ( ! $adaptor)

		{

			throw new InvalidArgumentException('Filesystem object not specified.');

		}


		return $adaptor;

The expression return $adaptor returns the type array|string which is incompatible with the documented return type League\Flysystem\Filesystem.

	}


}