| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593 |
- <?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 Class assignment_sloodleobject_submission</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- <script src="../media/lib/classTree.js"></script>
- <script language="javascript" type="text/javascript">
- var imgPlus = new Image();
- var imgMinus = new Image();
- imgPlus.src = "../media/images/plus.png";
- imgMinus.src = "../media/images/minus.png";
-
- function showNode(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- var oImg = document.layers["img" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- var oImg = document.all["img" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- var oImg = document.getElementById("img" + Node);
- break;
- }
- oImg.src = imgMinus.src;
- oTable.style.display = "block";
- }
-
- function hideNode(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- var oImg = document.layers["img" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- var oImg = document.all["img" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- var oImg = document.getElementById("img" + Node);
- break;
- }
- oImg.src = imgPlus.src;
- oTable.style.display = "none";
- }
-
- function nodeIsVisible(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- break;
- }
- return (oTable && oTable.style.display == "block");
- }
-
- function toggleNodeVisibility(Node){
- if (nodeIsVisible(Node)){
- hideNode(Node);
- }else{
- showNode(Node);
- }
- }
- </script>
- </head>
- <body>
- <div class="page-body">
- <h2 class="class-name"><img src="../media/images/Class_logo.png"
- alt=" Class"
- title=" Class"
- style="vertical-align: middle"> assignment_sloodleobject_submission</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Defines a submission for a Sloodle assignment.</p>
- <p class="notes">
- Located in <a class="field" href="_mod---primdrop-1.0---sloodleobject---assignment.class.php.html">/mod/primdrop-1.0/sloodleobject/assignment.class.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a201">201</a></span>)
- </p>
-
-
- <pre></pre>
-
- </div>
- </div>
- <a name="sec-var-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Variable Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <div class="var-summary">
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">bool</span>
- <a href="#$is_loaded" title="details" class="var-name">$is_loaded</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">int</span>
- <a href="#$num_prims" title="details" class="var-name">$num_prims</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">string</span>
- <a href="#$obj_name" title="details" class="var-name">$obj_name</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">string</span>
- <a href="#$primdrop_name" title="details" class="var-name">$primdrop_name</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">string</span>
- <a href="#$primdrop_pos" title="details" class="var-name">$primdrop_pos</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">string</span>
- <a href="#$primdrop_region" title="details" class="var-name">$primdrop_region</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">string</span>
- <a href="#$primdrop_uuid" title="details" class="var-name">$primdrop_uuid</a>
- </div>
- </div>
- </div>
- </div>
- <a name="sec-method-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Method Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
-
- |
- <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
- </div>
- <div class="info-box-body">
- <div class="method-summary">
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">float</span>
- <a href="#get_x" title="details" class="method-name">get_x</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">float</span>
- <a href="#get_y" title="details" class="method-name">get_y</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">float</span>
- <a href="#get_z" title="details" class="method-name">get_z</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#load_submission" title="details" class="method-name">load_submission</a>
- (<span class="var-type"></span> <span class="var-name">$submission</span>)
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#set_pos" title="details" class="method-name">set_pos</a>
- (<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">float</span> <span class="var-name">$z</span>)
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#text_summary" title="details" class="method-name">text_summary</a>
- ([<span class="var-type">bool</span> <span class="var-name">$return</span> = <span class="var-default">true</span>])
- </div>
- </div>
- </div>
- </div>
- <a name="sec-vars"></a>
- <div class="info-box">
- <div class="info-box-title">Variables</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
-
-
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
-
- <a name="var$is_loaded" id="$is_loaded"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">bool</span>
- <span class="var-name">$is_loaded</span>
- = <span class="var-default"> false</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a208">208</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Indicates whether or not a submission is loaded</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$num_prims" id="$num_prims"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">int</span>
- <span class="var-name">$num_prims</span>
- = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a222">222</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Number of prims in the object which has been submitted</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$obj_name" id="$obj_name"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$obj_name</span>
- = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a215">215</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Name of the object which has been submitted.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$primdrop_name" id="$primdrop_name"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$primdrop_name</span>
- = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a229">229</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Name of the PrimDrop object into which this object was submitted.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$primdrop_pos" id="$primdrop_pos"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$primdrop_pos</span>
- = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a250">250</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Position where this object was submitted (as a vector, "<x,y,z>")</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$primdrop_region" id="$primdrop_region"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$primdrop_region</span>
- = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a243">243</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Name of the region where this object was submitted</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$primdrop_uuid" id="$primdrop_uuid"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$primdrop_uuid</span>
- = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a236">236</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">UUID of the PrimDrop object into which this object was submitted.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
-
-
-
- </div>
-
- </div>
- </div>
-
- <a name="sec-methods"></a>
- <div class="info-box">
- <div class="info-box-title">Methods</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
-
- </div>
- <div class="info-box-body">
- <A NAME='method_detail'></A>
- <a name="methodget_x" id="get_x"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_x</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a296">296</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the X coordinate of the position</p>
- <ul class="tags">
- <li><span class="field">return:</span> The X coordinate of the position</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">float</span>
- <span class="method-name">
- get_x
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodget_y" id="get_y"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_y</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a307">307</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the Y coordinate of the position</p>
- <ul class="tags">
- <li><span class="field">return:</span> The Y coordinate of the position</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">float</span>
- <span class="method-name">
- get_y
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodget_z" id="get_z"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_z</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a318">318</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the Z coordinate of the position</p>
- <ul class="tags">
- <li><span class="field">return:</span> The Z coordinate of the position</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">float</span>
- <span class="method-name">
- get_z
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodload_submission" id="load_submission"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">load_submission</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a257">257</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Parses the data from a Submission database record object.</p>
- <ul class="tags">
- <li><span class="field">var:</span> The submission database record object.</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- load_submission
- </span>
- (<span class="var-type"></span> <span class="var-name">$submission</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type"></span>
- <span class="var-name">$submission</span> </li>
- </ul>
-
-
- </div>
- <a name="methodset_pos" id="set_pos"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">set_pos</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a287">287</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Sets the position as 3 components.</p>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- set_pos
- </span>
- (<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">float</span> <span class="var-name">$z</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">float</span>
- <span class="var-name">$x</span><span class="var-description">: x The X coordinate</span> </li>
- <li>
- <span class="var-type">float</span>
- <span class="var-name">$y</span><span class="var-description">: y The Y coordinate</span> </li>
- <li>
- <span class="var-type">float</span>
- <span class="var-name">$z</span><span class="var-description">: z The Z coordinate</span> </li>
- </ul>
-
-
- </div>
- <a name="methodtext_summary" id="text_summary"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">text_summary</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a330">330</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Construct a text summary of this submission.</p>
- <ul class="tags">
- <li><span class="field">return:</span> If parameter $return was TRUE, then it returns the string. Otherwise, an empty string.</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- text_summary
- </span>
- ([<span class="var-type">bool</span> <span class="var-name">$return</span> = <span class="var-default">true</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">bool</span>
- <span class="var-name">$return</span><span class="var-description">: If TRUE (default) then the text will be submitted instead of printed.</span> </li>
- </ul>
-
-
- </div>
-
- </div>
- </div>
-
- <p class="notes" id="credit">
- Documentation generated on Mon, 07 Jul 2008 12:32:13 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </div></body>
- </html>
|