vendor/craue/formflow-bundle/Storage/DataManager.php line 118

Open in your IDE?
  1. <?php
  3. namespace Craue\FormFlowBundle\Storage;
  5. use Craue\FormFlowBundle\Form\FormFlowInterface;
  7. /**
  8.  * Manages data of flows and their steps.
  9.  *
  10.  * It uses the following data structure with {@link DataManagerInterface::STORAGE_ROOT} as name of the root element within the storage:
  11.  * <code>
  12.  *     DataManagerInterface::STORAGE_ROOT => [
  13.  *         name of the flow => [
  14.  *             instance id of the flow => [
  15.  *                 'data' => [] // the actual step data
  16.  *             ]
  17.  *         ]
  18.  *     ]
  19.  * </code>
  20.  *
  21.  * @author Christian Raue <christian.raue@gmail.com>
  22.  * @copyright 2011-2021 Christian Raue
  23.  * @license http://opensource.org/licenses/mit-license.php MIT License
  24.  */
  25. class DataManager implements ExtendedDataManagerInterface {
  27.     /**
  28.      * @var string Key for the actual step data.
  29.      */
  30.     const DATA_KEY = 'data';
  32.     /**
  33.      * @var StorageInterface
  34.      */
  35.     private $storage;
  37.     /**
  38.      * @param StorageInterface $storage
  39.      */
  40.     public function __construct(StorageInterface $storage) {
  41.         $this->storage = $storage;
  42.     }
  44.     /**
  45.      * {@inheritDoc}
  46.      */
  47.     public function getStorage() {
  48.         return $this->storage;
  49.     }
  51.     /**
  52.      * {@inheritDoc}
  53.      */
  54.     public function save(FormFlowInterface $flow, array $data) {
  55.         // handle file uploads
  56.         if ($flow->isHandleFileUploads()) {
  57.             array_walk_recursive($data, function(&$value, $key) {
  58.                 if (SerializableFile::isSupported($value)) {
  59.                     $value = new SerializableFile($value);
  60.                 }
  61.             });
  62.         }
  64.         // drop old data
  65.         $this->drop($flow);
  67.         // save new data
  68.         $savedFlows = $this->storage->get(DataManagerInterface::STORAGE_ROOT, []);
  70.         $savedFlows = array_merge_recursive($savedFlows, [
  71.             $flow->getName() => [
  72.                 $flow->getInstanceId() => [
  73.                     self::DATA_KEY => $data,
  74.                 ],
  75.             ],
  76.         ]);
  78.         $this->storage->set(DataManagerInterface::STORAGE_ROOT, $savedFlows);
  79.     }
  81.     /**
  82.      * {@inheritDoc}
  83.      */
  84.     public function load(FormFlowInterface $flow) {
  85.         $data = [];
  87.         // try to find data for the given flow
  88.         $savedFlows = $this->storage->get(DataManagerInterface::STORAGE_ROOT, []);
  89.         if (isset($savedFlows[$flow->getName()][$flow->getInstanceId()][self::DATA_KEY])) {
  90.             $data = $savedFlows[$flow->getName()][$flow->getInstanceId()][self::DATA_KEY];
  91.         }
  93.         // handle file uploads
  94.         if ($flow->isHandleFileUploads()) {
  95.             $tempDir = $flow->getHandleFileUploadsTempDir();
  96.             array_walk_recursive($data, function(&$value, $key) use ($tempDir) {
  97.                 if ($value instanceof SerializableFile) {
  98.                     $value = $value->getAsFile($tempDir);
  99.                 }
  100.             });
  101.         }
  103.         return $data;
  104.     }
  106.     /**
  107.      * {@inheritDoc}
  108.      */
  109.     public function exists(FormFlowInterface $flow) {
  110.         $savedFlows = $this->storage->get(DataManagerInterface::STORAGE_ROOT, []);
  111.         return isset($savedFlows[$flow->getName()][$flow->getInstanceId()][self::DATA_KEY]);
  112.     }
  114.     /**
  115.      * {@inheritDoc}
  116.      */
  117.     public function drop(FormFlowInterface $flow) {
  118.         $savedFlows = $this->storage->get(DataManagerInterface::STORAGE_ROOT, []);
  120.         // remove data for only this flow instance
  121.         unset($savedFlows[$flow->getName()][$flow->getInstanceId()]);
  123.         $this->storage->set(DataManagerInterface::STORAGE_ROOT, $savedFlows);
  124.     }
  126.     /**
  127.      * {@inheritDoc}
  128.      */
  129.     public function listFlows() {
  130.         return array_keys($this->storage->get(DataManagerInterface::STORAGE_ROOT, []));
  131.     }
  133.     /**
  134.      * {@inheritDoc}
  135.      */
  136.     public function listInstances($name) {
  137.         $savedFlows = $this->storage->get(DataManagerInterface::STORAGE_ROOT, []);
  139.         if (array_key_exists($name, $savedFlows)) {
  140.             return array_keys($savedFlows[$name]);
  141.         }
  143.         return [];
  144.     }
  146.     /**
  147.      * {@inheritDoc}
  148.      */
  149.     public function dropAll() {
  150.         $this->storage->remove(DataManagerInterface::STORAGE_ROOT);
  151.     }
  153. }