Workflow.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred;

class Workflow extends \Rsi\Fred\Component{

  protected $_lockItem = 'workflow';

  protected $_workflows = null;

  /**
   * Get workflow data.
   * @param string $id  Workflow ID.
   * @return array
   */
  protected function workflow($id){
    if(!array_key_exists($id,$this->workflows)) throw new \Exception("Unknown workflow '$id'");
    return $this->workflows[$id];
  }
  /**
   * Create a new workflow item.
   * @param string $workflow  Workflow for this item.
   * @param string $id  Unique ID for this item.
   * @param array $data  Data for this item.
   * @param string $status  Initial status for this item.
   * @return Rsi\\Ginger\\Workflow\\Item  Item or false when not authorized.
   */
  public function createItem($workflow,$id,$data = null,$status = 'start'){
    throw new \Exception('Not implemented');
  }
  /**
   * Load an existing workflow item.
   * @param string $id  Item ID.
   * @return Rsi\\Ginger\\Workflow\\Item  Item or false when not found or not authorized.
   */
  public function loadItem($id){
    return false;
  }
  /**
   * Request a lock on a workflow item.
   * @param string $id  Item ID.
   * @return bool  True on success.
   */
  public function lockItem($id){
    return $id && $this->component('lock')->request($this->_lockItem,$id);
  }
  /**
   * Release a lock on a workflow item.
   * @param string $id  Item ID.
   * @return bool  True on success.
   */
  public function unlockItem($id){
    return $id && $this->component('lock')->release($this->_lockItem,$id);
  }
  /**
   * Get all data for an item.
   * @param string $id  Item ID.
   * @return array
   */
  public function getItemData($id){
    return [];
  }
  /**
   * Set (add) data for an item.
   * @param string $id  Item ID.
   * @param array $data
   */
  public function setItemData($id,$data){
  }
  /**
   * Get current status for an item.
   * @param string $id  Item ID.
   * @return string
   */
  public function getItemStatus($id){
    return null;
  }
  /**
   * Set the status for an item.
   * @param string $id  Item ID.
   * @param string $status  New status.
   * @param string $remarks
   * @return bool  True when successful, false when not possible or not authorized.
   */
  public function setItemStatus($id,$status,$remarks = null){
    return false;
  }
  /**
   * Get all possible (authorized) change statuses from the current status.
   * @param string $id  Item ID.
   * @return array  Key = status ID, value = status data (array).
   */
  public function getItemStatuses($id){
    return [];
  }
  /**
   * Push an item into the queue (reschedule to execute as soon as possible).
   * @param string $id  Item ID.
   * @param array $data  Data to add to the item.
   */
  public function push($id,$data = null){
  }
  /**
   * Pause an item (remove from queue).
   * @param string $id  Item ID.
   */
  protected function pause($id){
  }
  /**
   * Shift the first item from the queue.
   * @param bool $lock  Lock the item (or skip if not lockable).
   * @return string  ID or empty when the queue is empty.
   */
  protected function shift($lock = false){
    return null;
  }
  /**
   * Process the queue.
   * @param int $timeout  Maximum execution time (seconds).
   */
  public function execute($timeout = null){
    if($timeout) $timout = time() + $timeout;
    $log = $this->component('log');
    while((!$timeout || ($timeout < time())) && ($id = $this->shift(true))) try{
      $log->debug("Executing workflow item '$id'",__FILE__,__LINE__);
      if(($result = $this->loadItem($id)->execute()) !== false) $log->debug("Workflow item '$id' result = '$result'",__FILE__,__LINE__);
      else{
        $status = $this->getItemStatus($id);
        $log->error("Timeout expired for workflow item '$id', but no action for status '$status'",__FILE__,__LINE__);
        $this->pause($id);
      }
    }
    catch(\Exception $e){
      $log->emergency("Error while executing workflow item '$id': " . $e->getMessage(),$e->getFile(),$e->getLine());
      $this->pause($id);
    }
    finally{
      $this->unlockItem($id);
    }
  }

  protected function getWorkflows(){
    return [];
  }

}