libpairtwo/src/Interfaces/ReaderInterface.php

44 lines
976 B
PHP
Raw Normal View History

<?php
/**
* Interface ReaderInterface
*
* Sets the methods a reader needs to implement
*
* @author Jeroen De Meerleer <schaak@jeroened.be>
* @category Main
* @package Libpairtwo
* @copyright Copyright (c) 2018-2019 Jeroen De Meerleer <schaak@jeroened.be>
*/
namespace JeroenED\Libpairtwo\Interfaces;
use JeroenED\Libpairtwo\Tournament;
/**
* Interface ReaderInterface
*
* Sets the methods a reader needs to implement
*
* @author Jeroen De Meerleer <schaak@jeroened.be>
* @category Main
* @package Libpairtwo
* @copyright Copyright (c) 2018-2019 Jeroen De Meerleer <schaak@jeroened.be>
*/
interface ReaderInterface
{
/**
* Reads out $filename
*
* @param $filename
* @return ReaderInterface
*/
public function read(string $filename): ReaderInterface;
/**
* Gets the tournament out of $filename
*
* @return Tournament
*/
public function getTournament(): Tournament;
}