tao-test/app/vendor/oat-sa/lib-tao-qti/helpers/class.AbstractStateOutput.php

81 lines
2.4 KiB
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) 2014 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
*
*/
use qtism\common\datatypes\QtiPair;
use qtism\common\enums\BaseType;
use qtism\common\enums\Cardinality;
use qtism\runtime\common\Variable;
use qtism\common\datatypes\QtiPoint;
/**
* This helper class gives a way to build a State (a collection of variables)
* to be transmitted to the client-side.
*
* The result output can be accessed with the tao_helpers_StateOutput::getOutput() method
* which returns an associative array, that can be transformed as needed for transmission
* to the client-side.
*
* @author Jérôme Bogaerts <jerome@taotesting.com>
*
*/
abstract class taoQtiCommon_helpers_AbstractStateOutput {
/**
* The output associative array output.
*
* @var array
*/
private $output;
/**
* Create a new tao_helpers_AbstractStateOutput object.
*
*/
public function __construct() {
$this->setOutput(array());
}
/**
* Set the output array.
*
* @param array $output An array.
*/
protected function setOutput(array $output) {
$this->output = $output;
}
/**
* Get the output array.
*
* @return array An array of QTI Variables and their values formatted.
*/
public function &getOutput() {
return $this->output;
}
/**
* Add a variable to the State that has to be built for the client-side. The final output
* array is available through the tao_helpers_StateOutput::getOutput() method.
*
* @param Variable $variable A QTI Runtime Variable
*/
abstract public function addVariable(Variable $variable);
}