Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

72 lines (64 sloc) 2.749 kb
<?php
/**
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace ZendDiagnostics\Runner\Reporter;
use ArrayObject;
use ZendDiagnostics\Check\CheckInterface;
use ZendDiagnostics\Result\ResultInterface;
use ZendDiagnostics\Result\Collection as ResultsCollection;
/**
* Interface for a Reporter that can be attached to Runner.
*
* A Reporter is responsible for gathering information on Checks and their results
* as they are being invoked by the Runner. Some methods can be also be used to
* stop the Runner in the middle of testing.
*
* @see \ZendDiagnostics\Runner\Runner::run()
*/
interface ReporterInterface
{
/**
* This method is called right after Reporter starts running, via Runner::run()
*
* @param ArrayObject $checks A collection of Checks that will be performed
* @param array $runnerConfig Complete Runner configuration, obtained via Runner::getConfig()
* @return void
*/
public function onStart(ArrayObject $checks, $runnerConfig);
/**
* This method is called before each individual Check is performed. If this
* method returns false, the Check will not be performed (will be skipped).
*
* @param CheckInterface $check Check instance that is about to be performed.
* @param string|null $checkAlias The alias for the check that is about to be performed
* @return bool|void Return false to prevent check from happening
*/
public function onBeforeRun(CheckInterface $check, $checkAlias = null);
/**
* This method is called every time a Check has been performed. If this method
* returns false, the Runner will not perform any additional checks and stop
* its run.
*
* @param CheckInterface $check A Check instance that has just finished running
* @param ResultInterface $result Result for that particular check instance
* @param string|null $checkAlias The alias for the check that has just finished
* @return bool|void Return false to prevent from running additional Checks
*/
public function onAfterRun(CheckInterface $check, ResultInterface $result, $checkAlias = null);
/**
* This method is called when Runner has been aborted and could not finish the
* whole run().
*
* @param ResultsCollection $results Collection of Results for performed Checks.
* @return void
*/
public function onStop(ResultsCollection $results);
/**
* This method is called when Runner has finished its run.
*
* @param ResultsCollection $results Collection of Results for performed Checks.
* @return void
*/
public function onFinish(ResultsCollection $results);
}
Jump to Line
Something went wrong with that request. Please try again.