vendor/contao-community-alliance/dc-general/src/Event/AbstractModelAwareEvent.php line 33

Open in your IDE?
  1. <?php
  3. /**
  4.  * This file is part of contao-community-alliance/dc-general.
  5.  *
  6.  * (c) 2013-2019 Contao Community Alliance.
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  *
  11.  * This project is provided in good faith and hope to be usable by anyone.
  12.  *
  13.  * @package    contao-community-alliance/dc-general
  14.  * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
  15.  * @author     Tristan Lins <tristan.lins@bit3.de>
  16.  * @author     Sven Baumann <baumann.sv@gmail.com>
  17.  * @copyright  2013-2019 Contao Community Alliance.
  18.  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  19.  * @filesource
  20.  */
  22. namespace ContaoCommunityAlliance\DcGeneral\Event;
  24. use ContaoCommunityAlliance\DcGeneral\Data\ModelInterface;
  25. use ContaoCommunityAlliance\DcGeneral\EnvironmentInterface;
  26. use ContaoCommunityAlliance\DcGeneral\ModelAwareInterface;
  28. /**
  29.  * Abstract base class for an event that need an environment and a model.
  30.  *
  31.  * @SuppressWarnings(PHPMD.NumberOfChildren)
  32.  */
  33. class AbstractModelAwareEvent extends AbstractEnvironmentAwareEvent implements ModelAwareInterface
  34. {
  35.     /**
  36.      * The model attached to the event.
  37.      *
  38.      * @var ModelInterface
  39.      */
  40.     protected $model;
  42.     /**
  43.      * Create a new model aware event.
  44.      *
  45.      * @param EnvironmentInterface $environment The environment.
  46.      * @param ModelInterface       $model       The model attached to the event.
  47.      */
  48.     public function __construct(EnvironmentInterface $environment, ModelInterface $model)
  49.     {
  50.         parent::__construct($environment);
  51.         $this->model = $model;
  52.     }
  54.     /**
  55.      * {@inheritdoc}
  56.      */
  57.     public function getModel()
  58.     {
  59.         return $this->model;
  60.     }
  61. }