jkuchar / BigFileTools

src/BigFileTools.php

<?php

namespace BigFileTools;
use BigFileTools\Driver\SizeDriverAggregator;
use BigFileTools\Driver\ComDriver;
use BigFileTools\Driver\CurlDriver;
use BigFileTools\Driver\ExecDriver;
use BigFileTools\Driver\ISizeDriver;
use BigFileTools\Driver\NativeSeekDriver;
use BigFileTools\Driver\SizeDriverFactory;

/**
 * @author Honza Kuchař
 * @license New BSD
 * @encoding UTF-8
 * @copyright Copyright (c) 2016, Jan Kuchař
 */
class BigFileTools {

	/**
	 * Create BigFileTools from $path
	 * @param string $path
	 * @return File
	 * @deprecated
	 */
	static function fromPath($path) {

It is generally recommended to explicitly declare the visibility for methods.

		return static::createDefault()->getFile($path);
	}

	/**
	 * @var SizeDriverAggregator
	 */
	private $sizeDriver;

	/**
	 * Create new instance of BigFileTools by providing list of drivers.
	 * Those that cannot be initialized on given platform will be skipped.
	 * @param string[] $drivers
	 * @return static
	 */
	public static function createFrom(array $drivers) {
		return new static(
			new SizeDriverAggregator(
				(new SizeDriverFactory($drivers))->getInitializedDrivers()
			)
		);
	}

	/**
	 * Create new instance of BigFileTools using default configuration.
	 * This uses default drivers ordered by speed.
	 * @return static
	 */
	public static function createDefault() {
		return static::createFrom([
			CurlDriver::class,
			NativeSeekDriver::class,
			ComDriver::class,
			ExecDriver::class,
			//NativeReadDriver::class,
		]);
	}

	/**
	 * Constructor - do not call directly
	 * @param ISizeDriver $sizeDriver
	 */
	function __construct(ISizeDriver $sizeDriver)
	{
		$this->sizeDriver = $sizeDriver;

$sizeDriver is of type object<BigFileTools\Driver\ISizeDriver>, but the property $sizeDriver was declared to be of type object<BigFileTools\Driver\SizeDriverAggregator>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

	}

	/**
	 * Get file resource for further manipulation
	 * @param string $path **full** path to file
	 * @return File
	 */
	public function getFile($path)
	{
		return new File($path, $this->sizeDriver);
	}
}