1	<?php declare(strict_types = 1);
2	/*
3	* Copyright (c) 2019, Josef Kufner  <josef@kufner.cz>
4	*
5	* Licensed under the Apache License, Version 2.0 (the "License");
6	* you may not use this file except in compliance with the License.
7	* You may obtain a copy of the License at
8	*
9	*     http://www.apache.org/licenses/LICENSE-2.0
10	*
11	* Unless required by applicable law or agreed to in writing, software
12	* distributed under the License is distributed on an "AS IS" BASIS,
13	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14	* See the License for the specific language governing permissions and
15	* limitations under the License.
16	*
17	*/
18
19	namespace Smalldb\StateMachine\Transition;
20
21	use Smalldb\StateMachine\Definition\TransitionDefinition;
22	use Smalldb\StateMachine\ReferenceInterface;
23
24
25	/**
26	* Interface TransitionGuard
27	*
28	* A transition guard tells the transition implementation decorator
29	* whether it may or may not allow a transition.
30	*
31	* Guard before the transition: Is the given transition valid and allowed
32	*     on a given state machine?
33	*
34	* Assert after the transition: Is the new state machine state one
35	*     of the states expected after the transition?
36	*/
37	interface TransitionGuard
38	{
39
40	/**
41	* A simple and cost-effective check whether the transition can
42	* be invoked. This check is called when we want to know wheter or not
43	* we can invoke the transition, but we have no intention of invoking
44	* the transition right now (e.g., when rendering a menu with available
45	* transitions).
46	*/
47	public function isTransitionAllowed(ReferenceInterface $ref, TransitionDefinition $transition): bool;
48
49	}