tao-test/app/taoResultServer/models/Collection/VariableStorableCollection.php

<?php

/**
 * This program 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; under version 2
 * of the License (non-upgradable).
 *
 * This program 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
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2017 (original work) Open Assessment Technologies SA;
 */

namespace oat\taoResultServer\models\Collection;

use oat\taoResultServer\models\Entity\ItemVariableStorable;
use oat\taoResultServer\models\Entity\TestVariableStorable;
use oat\taoResultServer\models\Entity\VariableStorable;

class VariableStorableCollection
{
    /** @var  string */
    private $identifier;

    /** @var \oat\taoResultServer\models\Entity\VariableStorable[] */
    private $variables = [];

    /**
     * @param $identifier
     * @param \oat\taoResultServer\models\Entity\VariableStorable[] $variables
     */
    public function __construct($identifier, array $variables)
    {
        $this->identifier = $identifier;
        $this->variables  = $variables;
    }

    /**
     * @param $callIdTest
     * @param $deliveryResultIdentifier
     * @param $testIdentifier
     * @param \taoResultServer_models_classes_Variable[] $testVariables
     *
     * @return VariableStorableCollection
     */
    public static function createTestVariableCollection($callIdTest, $deliveryResultIdentifier, $testIdentifier, array $testVariables)
    {
        $storableVariables = [];

        foreach ($testVariables as $testVariable) {
            if (!($testVariable->isSetEpoch())) {
                $testVariable->setEpoch(microtime());
            }

            $storableVariables[] = new TestVariableStorable($deliveryResultIdentifier, $testIdentifier, $testVariable, $callIdTest);
        }

        return new self($callIdTest, $storableVariables);
    }

    /**
     * @param $callIdItem
     * @param $item
     * @param $deliveryResultIdentifier
     * @param $testIdentifier
     * @param \taoResultServer_models_classes_Variable[] $testVariables
     *
     * @return VariableStorableCollection
     */
    public static function createItemVariableCollection($callIdItem, $item, $deliveryResultIdentifier, $testIdentifier, array $testVariables)
    {
        $storableVariables = [];

        foreach ($testVariables as $testVariable) {
            if (!($testVariable->isSetEpoch())) {
                $testVariable->setEpoch(microtime());
            }

            $storableVariables[] = new ItemVariableStorable($deliveryResultIdentifier, $testIdentifier, $testVariable, $item, $callIdItem);
        }

        return new self($callIdItem, $storableVariables);
    }

    /**
     * @param $deliveryResultIdentifier
     * @param array $variables
     * @return VariableStorableCollection
     */
    public static function createFromArray($deliveryResultIdentifier, array $variables)
    {
        $storableVariables = [];

        foreach ($variables as $variable) {
            $variable = json_decode($variable, true);
            if (isset($variable['callIdTest'])) {
                $variableObj = TestVariableStorable::createFromArray($variable);
            } elseif (isset($variable['callIdItem'])) {
                $variableObj = ItemVariableStorable::createFromArray($variable);
            } else {
                continue;
            }

            $storableVariables[] = $variableObj;
        }

        return new self($deliveryResultIdentifier, $storableVariables);
    }

    /**
     * @return string
     */
    public function getIdentifier()
    {
        return $this->identifier;
    }

    /**
     * @return array
     */
    public function toStorableArray()
    {
        $data = [];

        foreach ($this->variables as $variable) {
            $data[$variable->getIdentifier()] = json_encode([
               $variable
            ]);
        }

        return $data;
    }
}