1: <?php
 2: /**
 3:  * PHP version 5
 4:  * @package    generalDriver
 5:  * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
 6:  * @author     Stefan Heimes <stefan_heimes@hotmail.com>
 7:  * @author     Tristan Lins <tristan.lins@bit3.de>
 8:  * @copyright  The MetaModels team.
 9:  * @license    LGPL.
10:  * @filesource
11:  */
12: 
13: namespace DcGeneral\EnvironmentPopulator;
14: 
15: use DcGeneral\EnvironmentInterface;
16: 
17: /**
18:  * This interface describes a generic environment populator.
19:  *
20:  * It only consists of a single "populate" method which will create instances of objects and push them into the
21:  * environment.
22:  *
23:  * @package DcGeneral\EnvironmentPopulator
24:  */
25: interface EnvironmentPopulatorInterface
26: {
27:     /**
28:      * Create all needed objects the populator knows to create and put them into the environment.
29:      *
30:      * @param EnvironmentInterface $environment The environment to populate.
31:      *
32:      * @return void
33:      */
34:     public function populate(EnvironmentInterface $environment);
35: }
36: