Menu
▾
▴
[Stack-cvs] stack-1-0/api/scripts/Stack _scripts_CASpool_startsocket_php.html,1.2,1.3 _scripts_CASpool_stopsocket_php.html,1.2,1.3 _scripts_stackAuthor_php.html,1.2,1.3 _scripts_stackData_php.html,1.2,1.3 _scripts_stackQuestion_php.html,1.2,1.3 _scripts_stackQuiz_php.html,NONE,1.1 _scripts_stackSocketSend_php.html,1.2,1.3 _scripts_stackUser_php.html,1.2,1.3 _scripts_stackUtility_php.html,1.2,1.3 _scripts_stackXML_php.html,1.2,1.3
|
From: Chris S. <san...@us...> - 2005-07-14 18:53:56
|
Update of /cvsroot/stack/stack-1-0/api/scripts/Stack In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14993/api/scripts/Stack Added Files: _scripts_CASpool_startsocket_php.html _scripts_CASpool_stopsocket_php.html _scripts_stackAuthor_php.html _scripts_stackData_php.html _scripts_stackQuestion_php.html _scripts_stackQuiz_php.html _scripts_stackSocketSend_php.html _scripts_stackUser_php.html _scripts_stackUtility_php.html _scripts_stackXML_php.html Log Message: Updated API --- NEW FILE: _scripts_stackQuiz_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 stackQuiz.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/stackQuiz.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">This file contains most functions which deal with quizzes.</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="functionstack_quiz_student_select" id="functionstack_quiz_student_select"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_quiz_student_select</span> (line <span class="line-number">37</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Displays the student quiz selection screen</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_quiz_student_select </span> (<span class="var-type">mixed</span> <span class="var-name">$quiz_store</span>, <span class="var-type">$user</span> <span class="var-name">$user</span>, <span class="var-type">array</span> <span class="var-name">$quize_store</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$quize_store</span><span class="var-description">: The list of quizzes</span> </li> <li> <span class="var-type">$user</span> <span class="var-name">$user</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 14 Jul 2005 19:45:22 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a> </p> </div></body> </html> --- NEW FILE: _scripts_stackAuthor_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 stackAuthor.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/stackAuthor.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 which deal with authoring questions and quizzes. These only need to be loaded when an edit page needs to be generated.</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="functionstack_options_edit_form" id="functionstack_options_edit_form"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_options_edit_form</span> (line <span class="line-number">72</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Build the form to edit a list of STACK options.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_options_edit_form </span> (<span class="var-type">array</span> <span class="var-name">$options_headings</span>, <span class="var-type">array</span> <span class="var-name">$options_list</span>, <span class="var-type">array</span> <span class="var-name">$options</span>, <span class="var-type">string</span> <span class="var-name">$fieldname</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$options_headings</span><span class="var-description">: The headings under which the options should be displayed</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$options_list</span><span class="var-description">: The list of options to display</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$options</span><span class="var-description">: Their current values</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$fieldname</span><span class="var-description">: The name of the field in the form</span> </li> </ul> </div> <a name="functionstack_question_edit_dispoptionfield" id="functionstack_question_edit_dispoptionfield"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_dispoptionfield</span> (line <span class="line-number">21</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Display the name of a option field, in a link generating a popup window.</p> <ul class="tags"> <li><span class="field">return:</span> The link to the popup window</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> stack_question_edit_dispoptionfield </span> (<span class="var-type">string</span> <span class="var-name">$field</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The field name</span> </li> </ul> </div> <a name="functionstack_question_edit_dispquestionfield" id="functionstack_question_edit_dispquestionfield"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_dispquestionfield</span> (line <span class="line-number">383</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Display the name of a questionField, in a link generating a popup window.</p> <ul class="tags"> <li><span class="field">return:</span> The link to the popup window</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> stack_question_edit_dispquestionfield </span> (<span class="var-type">string</span> <span class="var-name">$field</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The field name</span> </li> </ul> </div> <a name="functionstack_question_edit_form" id="functionstack_question_edit_form"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_form</span> (line <span class="line-number">116</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Build the form to edit a STACK question.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_question_edit_form </span> (<span class="var-type">array</span> <span class="var-name">$question</span>, <span class="var-type">array</span> <span class="var-name">&$errors</span>, [<span class="var-type">string</span> <span class="var-name">$PostTo</span> = <span class="var-default">''</span>]) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$question</span><span class="var-description">: The STACK question</span> </li> <li> <span class="var-type">array</span> <span class="var-name">&$errors</span><span class="var-description">: Repository for errors</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$PostTo</span><span class="var-description">: Where to send the form</span> </li> </ul> </div> <a name="functionstack_question_edit_form_field" id="functionstack_question_edit_form_field"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_form_field</span> (line <span class="line-number">335</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Build a field of the STACK question edit form</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_question_edit_form_field </span> (<span class="var-type">string</span> <span class="var-name">$f</span>, <span class="var-type">string</span> <span class="var-name">$qf</span>, <span class="var-type">array</span> <span class="var-name">$errors</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$f</span><span class="var-description">: The field name</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$qf</span><span class="var-description">: The contents of the field</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$errors</span><span class="var-description">: Respository for errors</span> </li> </ul> </div> <a name="functionstack_question_edit_form_substance" id="functionstack_question_edit_form_substance"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_form_substance</span> (line <span class="line-number">143</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Build the substance of the form to edit a STACK question.</p> <p class="description"><p>This needs to be wrapped in a <form> </form> structure.</p></p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_question_edit_form_substance </span> (<span class="var-type">array</span> <span class="var-name">$question</span>, <span class="var-type">array</span> <span class="var-name">&$errors</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$question</span><span class="var-description">: The STACK question</span> </li> <li> <span class="var-type">array</span> <span class="var-name">&$errors</span><span class="var-description">: Repository for errors</span> </li> </ul> </div> <a name="functionstack_question_edit_input_stringfield" id="functionstack_question_edit_input_stringfield"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_input_stringfield</span> (line <span class="line-number">531</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generates a text input box.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_question_edit_input_stringfield </span> (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">array</span> <span class="var-name">$arin</span>, <span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">int</span> <span class="var-name">$sz</span>, [<span class="var-type">int</span> <span class="var-name">$minsz</span> = <span class="var-default">0</span>]) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$name</span><span class="var-description">: The base name to be handed to the $_POST variable</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$arin</span><span class="var-description">: The array from which the value is taken</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The field name</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$sz</span><span class="var-description">: The size of the text box. If this is negative, this will be subtracted from the length of the string already in the field.</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$minsz</span><span class="var-description">: The minimum size of a box, only used when a box is automatically sized using the above.</span> </li> </ul> </div> <a name="functionstack_question_edit_input_textfield" id="functionstack_question_edit_input_textfield"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_input_textfield</span> (line <span class="line-number">515</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generates a textfield block.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_question_edit_input_textfield </span> (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$strin</span>, <span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">int</span> <span class="var-name">$sz</span>, [<span class="var-type">int</span> <span class="var-name">$colspan</span> = <span class="var-default">'1'</span>]) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$name</span><span class="var-description">: The base name to be handed to the $_POST variable</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$strin</span><span class="var-description">: The string containing the value of the field</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The field name</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$sz</span><span class="var-description">: The size of the text box</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$colspan</span><span class="var-description">: The number of columns the field spand</span> </li> </ul> </div> <a name="functionstack_question_edit_option_form" id="functionstack_question_edit_option_form"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_option_form</span> (line <span class="line-number">40</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generates the portion of the HTML question edit form for editing an option</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_question_edit_option_form </span> (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$opt</span>, <span class="var-type">mixed</span> <span class="var-name">$optval</span>, [<span class="var-type">int</span> <span class="var-name">$sz</span> = <span class="var-default">8</span>]) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$name</span><span class="var-description">: The name of the field in the form</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$opt</span><span class="var-description">: The option key</span> </li> <li> <span class="var-type">mixed</span> <span class="var-name">$optval</span><span class="var-description">: The currently set value</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$sz</span><span class="var-description">: The size of the answer boxes</span> </li> </ul> </div> <a name="functionstack_question_edit_potresp" id="functionstack_question_edit_potresp"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_potresp</span> (line <span class="line-number">401</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generate a line in a table to display and edit a potential resoponse.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_question_edit_potresp </span> (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">array</span> <span class="var-name">$potresp</span>, <span class="var-type">int</span> <span class="var-name">$npr</span>, <span class="var-type">array</span> <span class="var-name">&$errors</span>) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$key</span><span class="var-description">: The array key of this potential response</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$potresp</span><span class="var-description">: The potential response itself</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$npr</span><span class="var-description">: The total number of PRs in the question</span> </li> <li> <span class="var-type">array</span> <span class="var-name">&$errors</span><span class="var-description">: Repository for errors</span> </li> </ul> </div> <a name="functionstack_question_edit_potresp_branch" id="functionstack_question_edit_potresp_branch"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_question_edit_potresp_branch</span> (line <span class="line-number">548</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generates a branch of a potential response processing tree.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_question_edit_potresp_branch </span> (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">array</span> <span class="var-name">$branchvals</span>, <span class="var-type">int</span> <span class="var-name">$npr</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$name</span><span class="var-description">: The base name of the branch</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$branchvals</span><span class="var-description">: The values for this branch</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$npr</span><span class="var-description">: The total number of potential responses</span> </li> </ul> </div> <a name="functionstack_quiz_edit" id="functionstack_quiz_edit"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_quiz_edit</span> (line <span class="line-number">700</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Process the incoming $_POST['quiz'] fields.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_quiz_edit </span> (<span class="var-type">array</span> <span class="var-name">&$quiz</span>, <span class="var-type">array</span> <span class="var-name">&$errors</span>, <span class="var-type">string</span> <span class="var-name">$PostTo</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$quiz</span><span class="var-description">: The STACK quiz</span> </li> <li> <span class="var-type">array</span> <span class="var-name">&$errors</span><span class="var-description">: Repository for errors</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$PostTo</span><span class="var-description">: Where to send the form</span> </li> </ul> </div> <a name="functionstack_quiz_edit_form" id="functionstack_quiz_edit_form"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_quiz_edit_form</span> (line <span class="line-number">607</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Build the form to edit a STACK question.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_quiz_edit_form </span> (<span class="var-type">array</span> <span class="var-name">$quiz</span>, <span class="var-type">array</span> <span class="var-name">&$errors</span>, [<span class="var-type">string</span> <span class="var-name">$PostTo</span> = <span class="var-default">''</span>]) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$quiz</span><span class="var-description">: The STACK quiz</span> </li> <li> <span class="var-type">array</span> <span class="var-name">&$errors</span><span class="var-description">: Repository for errors</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$PostTo</span><span class="var-description">: Where to send the form</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 14 Jul 2005 19:45:16 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a> </p> </div></body> </html> --- NEW FILE: _scripts_CASpool_startsocket_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 startsocket.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/CASpool/startsocket.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-includes">Includes</a> </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Starts the STACK socket to provide the connection between the web client and the CAS.</p> <ul class="tags"> <li><span class="field">see:</span> <a href="../../lib/Stack/StackSocket.html">StackSocket</a></li> </ul> </div> </div> <a name="sec-includes"></a> <div class="info-box"> <div class="info-box-title">Includes</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Includes</span> </div> <div class="info-box-body"> <a name="_$stack_logfiles_CASkeywords_php"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">include</span> (<span class="include-name">$stack_logfiles.'CASkeywords.php'</span>) (line <span class="line-number">29</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> </div> <a name="_{$stack_root}/scripts/maxima/initmaxima_php"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">include</span> (<span class="include-name">"{$stack_root}/scripts/maxima/initmaxima.php"</span>) (line <span class="line-number">26</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> </div> <a name="_{$stack_root}/scripts/CASpool/stackSocket_php"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">include_once</span> (<span class="include-name">"{$stack_root}/scripts/CASpool/stackSocket.php"</span>) (line <span class="line-number">21</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> </div> <a name="_{$stack_root}/scripts/stackSocketSend_php"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">include_once</span> (<span class="include-name">"{$stack_root}/scripts/stackSocketSend.php"</span>) (line <span class="line-number">23</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> </div> <a name="_stackstd_php"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">require</span> (<span class="include-name">"stackstd.php"</span>) (line <span class="line-number">17</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">MOVE this file, out of the view of the web server and edit the line below to give a direct path.</p> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 14 Jul 2005 19:45:26 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a> </p> </div></body> </html> --- NEW FILE: _scripts_stackData_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 stackData.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/stackData.php</h2> <a name="sec-description"></a> <div class="info-box"> <div class="info-box-title">Description</div> <div class="nav-bar"> </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">This file is no longer needed.</p> <p class="description"><p>It will be deleted in the next release, but cannot now without Current installs changing stackstd.php</p></p> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 14 Jul 2005 19:45:18 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a> </p> </div></body> </html> --- NEW FILE: _scripts_stackUtility_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 stackUtility.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/stackUtility.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-includes">Includes</a> | <a href="#sec-functions">Functions</a> </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Important utility functions for dealing with strings and stack data structures in PHP.</p> </div> </div> <a name="sec-includes"></a> <div class="info-box"> <div class="info-box-title">Includes</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Includes</span> | <a href="#sec-functions">Functions</a> </div> <div class="info-box-body"> <a name="_{$stack_root}/frontend_general/frontend_util_php"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">require_once</span> (<span class="include-name">"{$stack_root}/frontend_general/frontend_util.php"</span>) (line <span class="line-number">23</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> </div> <a name="_{$stack_root}/scripts/stackUser_php"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">require_once</span> (<span class="include-name">"{$stack_root}/scripts/stackUser.php"</span>) (line <span class="line-number">22</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> </div> <a name="_{$stack_root}/scripts/stackQuiz_php"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">require_once</span> (<span class="include-name">"{$stack_root}/scripts/stackQuiz.php"</span>) (line <span class="line-number">21</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> </div> <a name="_{$stack_root}/scripts/moodlelib_php"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Page.png" alt=" " /> <span class="include-title"> <span class="include-type">require_once</span> (<span class="include-name">"{$stack_root}/scripts/moodlelib.php"</span>) (line <span class="line-number">19</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">TO DO: these should go in stackstd.php. They are in stackstd.php.dist</p> </div> </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> | <a href="#sec-includes">Includes</a> | <span class="disabled">Functions</span> </div> <div class="info-box-body"> <a name="functiongetmicrotime" id="functiongetmicrotime"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">getmicrotime</span> (line <span class="line-number">87</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Formats the results of the PHP microtime() function to four decimal places. Used to calculate page processing time.</p> <div class="method-signature"> <span class="method-result">float</span> <span class="method-name"> getmicrotime </span> () </div> </div> <a name="functionkeyval_rawkeyval" id="functionkeyval_rawkeyval"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">keyval_rawkeyval</span> (line <span class="line-number">289</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Take an array of locals, and return it to the a string form.</p> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> keyval_rawkeyval </span> (<span class="var-type">array</span> <span class="var-name">$locs</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$locs</span> </li> </ul> </div> <a name="functionnsf" id="functionnsf"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">nsf</span> (line <span class="line-number">72</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Check for the field $field, in the array $arr Don't apply sf()!</p> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> nsf </span> (<span class="var-type">array</span> <span class="var-name">$arr</span>, <span class="var-type">mixed</span> <span class="var-name">$field</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$arr</span><span class="var-description">: The input array.</span> </li> </ul> </div> <a name="functionrawkeyval_keyval" id="functionrawkeyval_keyval"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">rawkeyval_keyval</span> (line <span class="line-number">238</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Takes a string of rawkeyval and returns a parsed array. Used for form input and output</p> <ul class="tags"> <li><span class="field">return:</span> The parsed array</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> rawkeyval_keyval </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 to parse</span> </li> </ul> </div> <a name="functionsf" id="functionsf"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">sf</span> (line <span class="line-number">56</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Check for, then apply stack_s() to the field $field, in the array $arr</p> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> sf </span> (<span class="var-type">array</span> <span class="var-name">$arr</span>, <span class="var-type">mixed</span> <span class="var-name">$field</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$arr</span><span class="var-description">: The input array.</span> </li> </ul> </div> <a name="functionshow_array" id="functionshow_array"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">show_array</span> (line <span class="line-number">33</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Displays the contents of an array for HTML display.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> show_array </span> (<span class="var-type">array</span> <span class="var-name">$instr</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$instr</span><span class="var-description">: The array to display.</span> </li> </ul> </div> <a name="functionstack_casstring_to_display" id="functionstack_casstring_to_display"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_casstring_to_display</span> (line <span class="line-number">520</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Formats a casstring for the supplied display method.</p> <p class="description"><p>Display methods supported: <ul><li>LaTeX</li><li>LaTeX Source (code used to generate LaTeX display</li><li>MathML</li><li>All other formats displayed as plain text strings</li></ul></p></p> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> stack_casstring_to_display </span> (<span class="var-type">string</span> <span class="var-name">$varin</span>, <span class="var-type">string</span> <span class="var-name">$display</span>, [<span class="var-type">string</span> <span class="var-name">$wrap</span> = <span class="var-default">'#NONE#'</span>]) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$varin</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$display</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$wrap</span><span class="var-description">: The characters required to enclose the display (e.g. $$ for LaTeX). Set to #NONE# by default.</span> </li> </ul> </div> <a name="functionstack_castext_inst" id="functionstack_castext_inst"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_castext_inst</span> (line <span class="line-number">647</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Displays a block of castext after all variables have been instantiated by the CAS.</p> <ul class="tags"> <li><span class="field">return:</span> The display string</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> stack_castext_inst </span> (<span class="var-type">string</span> <span class="var-name">$castext</span>, <span class="var-type">array</span> <span class="var-name">$locals</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">string</span> <span class="var-name">$castext</span><span class="var-description">: The castext input</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$locals</span><span class="var-description">: Local variables from the question</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$options</span><span class="var-description">: Stack options set</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> <a name="functionstack_castext_to_display" id="functionstack_castext_to_display"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_castext_to_display</span> (line <span class="line-number">729</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Formats a castext block for the supplied display method.</p> <p class="description"><p>Display methods supported: <ul><li>LaTeX</li><li>LaTeX Source (code used to generate LaTeX display</li><li>MathML</li><li>All other formats displayed as plain text strings</li></ul></p></p> <ul class="tags"> <li><span class="field">return:</span> The xhtml display string</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> stack_castext_to_display </span> (<span class="var-type">string</span> <span class="var-name">$strin</span>, <span class="var-type">array</span> <span class="var-name">&$locals</span>, <span class="var-type">string</span> <span class="var-name">$display</span>, <span class="var-type">mixed</span> <span class="var-name">&$errs</span>, <span class="var-type">array</span> <span class="var-name">&$errr</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$strin</span><span class="var-description">: LaTeX castext in which all implicit locals have been substitued for dummy strings.</span> </li> <li> <span class="var-type">array</span> <span class="var-name">&$locals</span><span class="var-description">: Instantiated local variables</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$display</span><span class="var-description">: Display method to use (see above)</span> </li> <li> <span class="var-type">array</span> <span class="var-name">&$errr</span><span class="var-description">: String for any errors.</span> </li> </ul> </div> <a name="functionstack_check_for_error" id="functionstack_check_for_error"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_check_for_error</span> (line <span class="line-number">102</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Checks for the presence of a $field kind of error in $error</p> <div class="method-signature"> <span class="method-result">boolean</span> <span class="method-name"> stack_check_for_error </span> (<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">array</span> <span class="var-name">$error</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$field</span><span class="var-description">: The field name of the error to be checked for.</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$error</span><span class="var-description">: The array containing any errors.</span> </li> </ul> </div> <a name="functionstack_generate_guid" id="functionstack_generate_guid"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_generate_guid</span> (line <span class="line-number">994</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generate a GUID from</p> <p class="description"><p>(1) the time, including microseconds, (2) the PID of the process, and (3) a server based prefix string. eg $stack_web_url This is all hashed into a 32-character hexadecimal character with md5()</p></p> <ul class="tags"> <li><span class="field">return:</span> The GUID, returned as a CHAR(32)</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> stack_generate_guid </span> (<span class="var-type">string</span> <span class="var-name">$prefix</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$prefix</span><span class="var-description">: a server based prefix string.</span> </li> </ul> </div> <a name="functionstack_lang_filename" id="functionstack_lang_filename"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_lang_filename</span> (line <span class="line-number">182</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Create the a filename, given the current options.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_lang_filename </span> (<span class="var-type">mixed</span> <span class="var-name">$options</span>, <span class="var-type">mixed</span> <span class="var-name">$fn</span>) </div> </div> <a name="functionstack_mail_error" id="functionstack_mail_error"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_mail_error</span> (line <span class="line-number">1009</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Sends a warning in the mail of an event which should not have occured.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_mail_error </span> (<span class="var-type">string</span> <span class="var-name">$errmsgsub</span>, <span class="var-type">string</span> <span class="var-name">$errmsg</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$errmsgsub</span><span class="var-description">: The subject of the error message.</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$errmsg</span><span class="var-description">: The error message to be sent.</span> </li> </ul> </div> <a name="functionstack_microtime_float" id="functionstack_microtime_float"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_microtime_float</span> (line <span class="line-number">926</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generates a time as a float.</p> <div class="method-signature"> <span class="method-result">float</span> <span class="method-name"> stack_microtime_float </span> () </div> </div> <a name="functionstack_page_footer" id="functionstack_page_footer"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_page_footer</span> (line <span class="line-number">969</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generate an HTML page footer if $stack_stand_alone is true.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_page_footer </span> () </div> </div> <a name="functionstack_page_header" id="functionstack_page_header"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_page_header</span> (line <span class="line-number">941</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Generate an HTML page header if $stack_stand_alone is true.</p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_page_header </span> (<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$optdisp</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$title</span><span class="var-description">: The value to use for the title.</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$optdisp</span><span class="var-description">: The display option</span> </li> </ul> </div> <a name="functionstack_reorder" id="functionstack_reorder"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_reorder</span> (line <span class="line-number">853</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Re-order an array, based on the values in the field 'order'</p> <ul class="tags"> <li><span class="field">return:</span> Contains any errors</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> stack_reorder </span> (<span class="var-type">array</span> <span class="var-name">&$arin</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">&$arin</span><span class="var-description">: The unordered array</span> </li> </ul> </div> <a name="functionstack_reorder_subfun" id="functionstack_reorder_subfun"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_reorder_subfun</span> (line <span class="line-number">910</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Calculates the difference between the order values of two arrays.</p> <ul class="tags"> <li><span class="field">return:</span> The difference between the order values of the two arrays.</li> </ul> <div class="method-signature"> <span class="method-result">float</span> <span class="method-name"> stack_reorder_subfun </span> (<span class="var-type">array</span> <span class="var-name">$a</span>, <span class="var-type">array</span> <span class="var-name">$b</span>) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$a</span><span class="var-description">: The first array. Must contain a field ['order'].</span> </li> <li> <span class="var-type">array</span> <span class="var-name">$b</span><span class="var-description">: The second array. Must contain a field ['order'].</span> </li> </ul> </div> <a name="functionstack_s" id="functionstack_s"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_s</span> (line <span class="line-number">43</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Synonym for the PHP function htmlspecialchars. See the Moodle function s(.)</p> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> stack_s </span> (<span class="var-type">string</span> <span class="var-name">$str</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$str</span><span class="var-description">: The input string.</span> </li> </ul> </div> <a name="functionstack_trans" id="functionstack_trans"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_trans</span> (line <span class="line-number">208</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Translates a string taken as output from Maxima.</p> <p class="description"><p>This function takes a variable number of arguments, the first of which is assumed to be the identifier of the string to be translated.</p></p> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> stack_trans </span> () </div> </div> <a name="functionstack_util_grabbetween" id="functionstack_util_grabbetween"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">stack_util_grabbetween</span> (line <span class="line-number">120</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Gets the string between two specified characters.</p> <ul class="tags"> <li><span class="field">return:</span> Field [0] contains the string between the two characters, Field [1] contains the start position of -1 if it does not exist and Field [2] contains the end position of -1 if there was no match.</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> stack_util_grabbetween </span> (<span class="var-type">mixed</span> <span class="var-name">$strin</span>, <span class="var-type">char</span> <span class="var-name">$leftc</span>, <span class="var-type">char</span> <span class="var-name">$rightc</span>, <span class="var-type">int</span> <span class="var-name">$start</span>) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$start</span><span class="var-description">: The position of the string to start searching at.</span> </li> <li> <span class="var-type">char</span> <span class="var-name">$leftc</span><span class="var-description">: Finds the first occurence of this character</span> </li> <li> <span class="var-type">char</span> <span class="var-name">$rightc</span><span class="var-description">: Finds the first occurence of this character after $leftc</span> </li> </ul> </div> <a name="functionstring_to_locvars" id="functionstring_to_locvars"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">string_to_locvars</span> (line <span class="line-number">610</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Takes a castext string, and takes out all the implicit locals variables.</p> <ul class="tags"> <li><span class="field">return:</span> Field [0] contains the string with implicit local replacements, and field [1] contains the array of implicit locals.</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> string_to_locvars </span> (<span class="var-type">string</span> <span class="var-name">$strin</span>, <span class="var-type">string</span> <span class="var-name">$vn</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$strin</span><span class="var-description">: The string input.</span> </li> <li> <span class="var-type">string</span> <span class="var-name">$vn</span><span class="var-description">: The variable name to append to each local variable</span> </li> </ul> </div> <a name="functionvalidate_casstring" id="functionvalidate_casstring"><!-- --></a> <div class="oddrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">validate_casstring</span> (line <span class="line-number">325</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Validates a string containing CAS functions before sending it to the CAS. A casstring is identified by text between @ and @ signs.</p> <p class="description"><p>NOTE: THIS IS A SYSTEM CRITICAL FUNCTION, WHICH IS PIVOTAL IN SYSTEM SECURITY.</p><p>This function checks for the following types of validation errors: <ol><li>Check if any forbidden keywords occur in the string.</li><li>We should only allow certain strings in student's answers. These are kept in $stack_cas['studentAllow']</li><li>Check that brackets match</li><li>Use regular expression matches to try to spot syntax errors before they get sent to the CAS.</li><li>Check for missing *'s</li></ol> This function may change the $strin, depending on the $options.</p></p> <ul class="tags"> <li><span class="field">return:</span> Contains any errors found (null if none).</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> validate_casstring </span> (<span class="var-type">string</span> <span class="var-name">&$strin</span>, [<span class="var-type">char</span> <span class="var-name">$seclevel</span> = <span class="var-default">'s'</span>]) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">&$strin</span><span class="var-description">: The string to validate, which may be changed by the function, depending on the $options.</span> </li> <li> <span class="var-type">char</span> <span class="var-name">$seclevel</span><span class="var-description">: The security level, 's' (default) indicates a student, and 't' a teacher. Students are only permitted to enter certain strings, teachers are trusted more.</span> </li> </ul> </div> <a name="functionvalidate_castext" id="functionvalidate_castext"><!-- --></a> <div class="evenrow"> <div> <img src="../../media/images/Function.png" /> <span class="method-title">validate_castext</span> (line <span class="line-number">565</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Used to validate a string which may contain multiple casstrings.</p> <ul class="tags"> <li><span class="field">return:</span> Contains details of errors generated.</li> <li><span class="field">see:</span> <a href="../../scripts/Stack/_scripts_stackUtility_php.html#functionvalidate_casstring">validate_casstring()</a></li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> validate_castext </span> (<span class="var-type">string</span> <span class="var-name">$strin</span>, [<span class="var-type">char</span> <span class="var-name">$seclevel</span> = <span class="var-default">'s'</span>]) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$strin</span><span class="var-description">: The castext block</span> </li> <li> <span class="var-type">char</span> <span class="var-name">$seclevel</span><span class="var-description">: Security Level (student or teacher). Default value is 's' for student.</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Thu, 14 Jul 2005 19:45:24 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a> </p> </div></body> </html> --- NEW FILE: _scripts_stackXML_php.html --- <?xm... [truncated message content] |
