Menu
▾
▴
[Stack-cvs] stack-1-0/api/stackwin/Stack _scripts_stackWin_php.html,NONE,1.1
|
From: Chris S. <san...@us...> - 2005-07-14 18:53:48
|
Update of /cvsroot/stack/stack-1-0/api/stackwin/Stack In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14993/api/stackwin/Stack Added Files: _scripts_stackWin_php.html Log Message: Updated API --- NEW FILE: _scripts_stackWin_php.html --- <?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <!-- template designed by Marco Von Ballmoos --> <title>Docs for page stackWin.php</title> <link rel="stylesheet" href="../../media/stylesheet.css" /> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> <body> <div class="page-body"> <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/scripts/stackWin.php</h2> <a name="sec-description"></a> <div class="info-box"> <div class="info-box-title">Description</div> <div class="nav-bar"> <span class="disabled">Description</span> | <a href="#sec-functions">Functions</a> </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Functions in this file implement a Windows **demonstration** version of the stack server. This is not secure, is not distributed with the main stack code.</p> </div> </div> <a name="sec-functions"></a> <div class="info-box"> <div class="info-box-title">Functions</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Functions</span> </div> <div class="info-box-body"> <a name="functionCPProcessAnsTest" id="functionCPProcessAnsTest"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">CPProcessAnsTest</span> (line <span class="line-number">288</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Directly perform an answer test</p> <ul class="tags"> <li><span class="field">return:</span> An array structure, which is used to build the student's attempt.</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> CPProcessAnsTest </span> (<span class="var-type">string</span> <span class="var-name">$exp1</span>, <span class="var-type">string</span> <span class="var-name">$exp2</span>, <span class="var-type">string</span> <span class="var-name">$test</span>, <span class="var-type">mixed</span> <span class="var-name">$disp</span>, <span class="var-type">mixed</span> <span class="var-name">&$err</span>, <span class="var-type">array</span> <span class="var-name">$options</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$exp1</span><span class="var-description">: A CAS expression, nominally the student's</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$exp2</span><span class="var-description">: A CAS expression, nominally the teachers's</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$test</span><span class="var-description">: Which AnswerTest to apply.</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$options</span><span class="var-description">: The only option needed is the Display, but other answer tests may in the future require their own options.</span> </li> </ul> </div> <a name="functionCPProcessVars" id="functionCPProcessVars"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">CPProcessVars</span> (line <span class="line-number">192</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Instantiate a list of local variables.</p> <p class="description"><p>Possible errors: <ul><li>VARS-UNPACK : request array was empty</li><li>VARS-CODEINST : error instantiating CAS-specific code</li><li>VARS-TIMESTAMP : output from CAS did not match with input</li><li>VARS-PARSE : output from CAS could not be parsed, any variables that could not be instantiated are restored to un-CASed value in $crReturn</li></ul></p></p> <ul class="tags"> <li><span class="field">return:</span> $crReturn contains the instantiated values</li> </ul> <div class="method-signature"> <span class="method-result"><a href="../../lib/Stack/StackResponse.html">StackResponse</a></span> <span class="method-name"> CPProcessVars </span> (<span class="var-type"><a href="../../lib/Stack/StackRequest.html">StackRequest</a></span> <span class="var-name">$varRequest</span>) </div> <ul class="parameters"> <li> <span class="var-type"><a href="../../lib/Stack/StackRequest.html">StackRequest</a></span> <span class="var-name">$varRequest</span><span class="var-description">: $crData contains the list of local variables</span> </li> </ul> </div> <a name="functionstack_latex_to_html" id="functionstack_latex_to_html"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_latex_to_html</span> (line <span class="line-number">21</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Use an external program to convert a LaTeX string to HTML</p> <p class="description"><p>The counterpart of the function stack_latex_to_html</p></p> <ul class="tags"> <li><span class="field">return:</span> The converted HTML string or FALSE if there was an error.</li> <li><span class="field">see:</span> <a href="../../stackwin/Stack/_scripts_stackWin_php.html#functionstack_latex_to_html">stack_latex_to_html()</a></li> </ul> <div class="method-signature"> <span class="method-result">string|boolean</span> <span class="method-name"> stack_latex_to_html </span> (<span class="var-type">mixed</span> <span class="var-name">$strin</span>, <span class="var-type">string</span> <span class="var-name">$tex_string</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$tex_string</span><span class="var-description">: The LaTeX string</span> </li> </ul> </div> <a name="functionstack_maxima_rawsend" id="functionstack_maxima_rawsend"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_maxima_rawsend</span> (line <span class="line-number">79</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Connect directly to the CAS, and return the raw string result.</p> <p class="description"><p>This does not use sockets, but calls a new CAS session each time. Hence, this is not likely to be efficient. Furthermore, since the system gives the webserver execute priviliges to this is insecure.</p></p> <ul class="tags"> <li><span class="field">return:</span> The converted HTML string or FALSE if there was an error.</li> </ul> <div class="method-signature"> <span class="method-result">string|boolean</span> <span class="method-name"> stack_maxima_rawsend </span> (<span class="var-type">string</span> <span class="var-name">$strin</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$strin</span><span class="var-description">: The string of CAS commands to be processed.</span> </li> </ul> </div> <a name="functionstack_process_vars" id="functionstack_process_vars"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_process_vars</span> (line <span class="line-number">156</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Instantiate a list of local variables through the CAS.</p> <p class="description"><p>This function performs the following tasks: <ol><li>Checks each local for a PHP error</li><li>If no errors, sends them to the CAS</li><li>Checks for CAS errors</li></ol></p></p> <ul class="tags"> <li><span class="field">return:</span> List of instantiated local variables.</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> stack_process_vars </span> (<span class="var-type">array</span> <span class="var-name">$locals</span>, <span class="var-type">int</span> <span class="var-name">$seed</span>, <span class="var-type">array</span> <span class="var-name">$options</span>, <span class="var-type">array</span> <span class="var-name">&$err</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$locals</span><span class="var-description">: List of local variables to instantiate.</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$seed</span><span class="var-description">: The random number seed to use</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$options</span><span class="var-description">: STACK options</span> </li> <li> <span class="var-type">array</span> <span class="var-name">&$err</span><span class="var-description">: Repository for errors.</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 14 Jul 2005 19:45:25 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a> </p> </div></body> </html> |
