Maslosoft Mangan API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Traits;
use Maslosoft\Mangan\Interfaces\ScenariosInterface;
/**
* This trait provides implementation of scenarios feature. It works with
* `ScenarioManager`, but only if class using it
* also implements `ScenariosInterface`.
*
* Use this to enchance models with scenarios, this allows triggering different
* validators depending on scenario, or to be used with any custom feature.
*
*
* @see ScenariosInterface
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
trait ScenariosTrait
{
private $_scenario = ScenariosInterface::Insert;
/**
* Get current scenario
* @return string
* @Ignored
*/
public function getScenario()
{
return $this->_scenario;
}
/**
* Set current scenario
* @param string $scenario
* @Ignored
*/
public function setScenario($scenario)
{
$this->_scenario = $scenario;
}
}
API documentation generated by ApiGen