moodle/lib/mathslib.php
2007-05-26 13:11:54 +00:00

87 lines
2.4 KiB
PHP

<?php
require_once $CFG->dirroot.'/lib/evalmath/evalmath.class.php';
/**
* This class abstracts evaluation of spreadsheet formulas.
* See unit tests in lib/simpletest/testmathslib.php for sample usage.
*
* @author Petr Skoda (skodak)
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/
class calc_formula {
// private properties
var $_em;
var $_nfx = false; // postfix notation
var $_error = false; // last error
/**
* Constructor for spreadsheet formula with optional parameters
*
* @param string $formula with leading =
* @param array $params associative array of parameters used in formula. All parameter names must be lowercase!
*/
function calc_formula($formula, $params=false) {
$this->_em = new EvalMath();
$this->_em->suppress_errors = true;
if (strpos($formula, '=') !== 0) {
$this->_error = "missing leading '='";
return;
}
$formula = substr($formula, 1);
if (strpos($formula, '=') !== false) {
$this->_error = "too many '='";
return;
}
$this->_nfx = $this->_em->nfx($formula);
if ($this->_nfx == false) {
$this->_error = $this->_em->last_error;
return;
}
if ($params != false) {
$this->set_params($params);
}
}
/**
* Raplace parameters used in existing formula,
* parameter names must contain only lowercase [a-z] letters, no other characters are allowed!
*
* @param array $params associative array of parameters used in formula
*/
function set_params($params) {
$this->_em->v = $params;
}
/**
* Evaluate formula
*
* @return mixed number if ok, false if error
*/
function evaluate() {
if ($this->_nfx == false) {
return false;
}
$res = $this->_em->pfx($this->_nfx);
if ($res === false) {
$this->_error = $this->_em->last_error;
return false;
} else {
$this->_error = false;
return $res;
}
}
/**
* Get last error.
* TODO: localize the strings from contructor and EvalMath library
*
* @return mixed string with last error description or false if ok
*/
function get_error() {
return $this->_error;
}
}
?>