PHP Class Scientist\Laboratory

The Laboratory is where the magic takes place. Here we define and conduct our experiments.
Afficher le fichier Open project: daylerees/scientist Class Usage Examples

Protected Properties

Свойство Type Description
$journals Scientist\Journals\Journal[] Collection of journals to report to.

Méthodes publiques

Méthode Description
addJournal ( Scientist\Journals\Journal $journal ) Register a new journal.
experiment ( string $name ) : mixed Start a new experiment.
getJournals ( ) : array Retrieve registers journals.
getReport ( Experiment $experiment ) : Report Run an experiment and return the result.
runExperiment ( Experiment $experiment ) : mixed Run an experiment.
setJournals ( array $journals = [] ) Register a collection of journals.

Méthodes protégées

Méthode Description
reportToJournals ( Experiment $experiment, Report $report ) : void Report experiment result to registered journals.

Method Details

addJournal() public méthode

Register a new journal.
public addJournal ( Scientist\Journals\Journal $journal )
$journal Scientist\Journals\Journal

experiment() public méthode

Start a new experiment.
public experiment ( string $name ) : mixed
$name string
Résultat mixed

getJournals() public méthode

Retrieve registers journals.
public getJournals ( ) : array
Résultat array

getReport() public méthode

Run an experiment and return the result.
public getReport ( Experiment $experiment ) : Report
$experiment Experiment
Résultat Report

reportToJournals() protected méthode

Report experiment result to registered journals.
protected reportToJournals ( Experiment $experiment, Report $report ) : void
$experiment Experiment
$report Report
Résultat void

runExperiment() public méthode

Run an experiment.
public runExperiment ( Experiment $experiment ) : mixed
$experiment Experiment
Résultat mixed

setJournals() public méthode

Register a collection of journals.
public setJournals ( array $journals = [] )
$journals array

Property Details

$journals protected_oe property

Collection of journals to report to.
protected Journal[],Scientist\Journals $journals
Résultat Scientist\Journals\Journal[]