class/WorkflowController.php
<?php
/**
* This file is part of Internship Inventory.
*
* Internship Inventory is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* Internship Inventory is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License version 3
* along with Internship Inventory. If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2011-2018 Appalachian State University
*/
namespace Intern;
class WorkflowController {
private $internship;
private $t;
public function __construct(Internship $i, WorkflowTransition $t)
{
$this->internship = $i;
$this->t = $t;
}
public function doTransition($note = null)
{
// Make sure the transition makes sense based on the current state of the internship
$currStateName = $this->internship->getStateName();
$sourceStateName = $this->t->getSourceState();
if(is_array($sourceStateName)){
if(!in_array($currStateName, $sourceStateName)){
throw new \InvalidArgumentException('Invalid transition source state.');
}
}else if($sourceStateName != '*' && $sourceStateName != $currStateName){
throw new \InvalidArgumentException('Invalid transition source state.');
}
if(!$this->t->allowed($this->internship)){
throw new Exception("You do not have permission to set the internship to the requested status.");
}
// Check that the fields required to take this transition have been filled in
// Will throw an exception in the case of any missing data.
$this->t->checkRequiredFields($this->internship);
$sourceState = WorkflowStateFactory::getState($currStateName);
$destStateName = $this->t->getDestState();
if($destStateName == null){
// No destination state, so see if we need to add a note (no state change)
if(!is_null($note)){
$changeHistory = new ChangeHistory($this->internship, \Current_User::getUserObj(), time(), $sourceState, $sourceState, $note);
$changeHistory->save();
}
return;
}
$destState = WorkflowStateFactory::getState($destStateName);
$this->t->onTransition($this->internship);
$this->internship->setState($destState);
$this->internship->save();
$changeHistory = new ChangeHistory($this->internship, \Current_User::getUserObj(), time(), $sourceState, $destState, $note);
$changeHistory->save();
}
public function doNotification($note = null){
$this->t->doNotification($this->internship, $note);
}
}