Home Explore Help
Register Sign In
Ayuda_Virtual
/
sloodle_website
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
sloodle_webs...
/
webroot
/
docs
/
wiki
/
articles
/
s
/
l
/
o
/
SloodleLSLRequest.html

SloodleLSLRequest.html 32 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
    3. 

  3.   <head>
    4. 

  4.     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    5. 

  5. 	<!-- headlinks removed -->
    6. 

  6. 	<link rel="shortcut icon" href="../../../../misc/favicon.ico"/>
    7. 

  7.     <title>SloodleLSLRequest - SLIS Second Life Wiki</title>
    8. 

  8.     <style type="text/css">/*<![CDATA[*/ @import "../../../../skins/offline/main.css"; /*]]>*/</style>
    9. 

  9.     <link rel="stylesheet" type="text/css" media="print" href="../../../../skins/common/commonPrint.css" />
    10. 

  10.     <!--[if lt IE 5.5000]><style type="text/css">@import "../../../../skins/monobook/IE50Fixes.css";</style><![endif]-->
    11. 

  11.     <!--[if IE 5.5000]><style type="text/css">@import "../../../../skins/monobook/IE55Fixes.css";</style><![endif]-->
    12. 

  12.     <!--[if IE 6]><style type="text/css">@import "../../../../skins/monobook/IE60Fixes.css";</style><![endif]-->
    13. 

  13.     <!--[if IE]><script type="text/javascript" src="../../../../skins/common/IEFixes.js"></script>
    14. 

  14.     <meta http-equiv="imagetoolbar" content="no" /><![endif]-->
    15. 

  15.     <script type="text/javascript" src="../../../../skins/common/wikibits.js"></script>
    16. 

  16.     <script type="text/javascript" src="../../../../skins/offline/md5.js"></script>
    17. 

  17.     <script type="text/javascript" src="../../../../skins/offline/utf8.js"></script>
    18. 

  18.     <script type="text/javascript" src="../../../../skins/offline/lookup.js"></script>
    19. 

  19.                       </head>
    20. 

  20.   <body
    21. 

  21.     class="ns-0 ns-subject page-SloodleLSLRequest">
    22. 

  22.     <div id="globalWrapper">
    23. 

  23.       <div id="column-content">
    24. 

  24. 	<div id="content">
    25. 

  25. 	  <a name="top" id="contentTop"></a>
    26. 

  26. 	        <h1 class="firstHeading">SloodleLSLRequest</h1>
    27. 

  27. 	  <div id="bodyContent">
    28. 

  28. 	    <h3 id="siteSub">From SLIS Second Life Wiki</h3>
    29. 

  29. 	    <div id="contentSub"></div>
    30. 

  30. 	    	    	    <!-- start content -->
    31. 

  31. 	    <div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><table id="toc" class="toc"><tr><td><div id="toctitle"><h2>Contents</h2></div>
    32. 

  32. <ul>
    33. 

  33. <li class="toclevel-1 tocsection-1"><a href="#Declaration"><span class="tocnumber">1</span> <span class="toctext">Declaration</span></a></li>
    34. 

  34. <li class="toclevel-1 tocsection-2"><a href="#Summary"><span class="tocnumber">2</span> <span class="toctext">Summary</span></a></li>
    35. 

  35. <li class="toclevel-1 tocsection-3"><a href="#Compatibility"><span class="tocnumber">3</span> <span class="toctext">Compatibility</span></a></li>
    36. 

  36. <li class="toclevel-1 tocsection-4"><a href="#Data"><span class="tocnumber">4</span> <span class="toctext">Data</span></a>
    37. 

  37. <ul>
    38. 

  38. <li class="toclevel-2 tocsection-5"><a href="#Status_Data"><span class="tocnumber">4.1</span> <span class="toctext">Status Data</span></a>
    39. 

  39. <ul>
    40. 

  40. <li class="toclevel-3 tocsection-6"><a href="#var_.24request_data_processed"><span class="tocnumber">4.1.1</span> <span class="toctext">var $request_data_processed</span></a></li>
    41. 

  41. <li class="toclevel-3 tocsection-7"><a href="#var_.24auth_status"><span class="tocnumber">4.1.2</span> <span class="toctext">var $auth_status</span></a></li>
    42. 

  42. </ul>
    43. 

  43. </li>
    44. 

  44. <li class="toclevel-2 tocsection-8"><a href="#Request_Data"><span class="tocnumber">4.2</span> <span class="toctext">Request Data</span></a>
    45. 

  45. <ul>
    46. 

  46. <li class="toclevel-3 tocsection-9"><a href="#var_.24password"><span class="tocnumber">4.2.1</span> <span class="toctext">var $password</span></a></li>
    47. 

  47. <li class="toclevel-3 tocsection-10"><a href="#var_.24login_zone_pos"><span class="tocnumber">4.2.2</span> <span class="toctext">var $login_zone_pos</span></a></li>
    48. 

  48. <li class="toclevel-3 tocsection-11"><a href="#var_.24course_id"><span class="tocnumber">4.2.3</span> <span class="toctext">var $course_id</span></a></li>
    49. 

  49. <li class="toclevel-3 tocsection-12"><a href="#var_.24module_id"><span class="tocnumber">4.2.4</span> <span class="toctext">var $module_id</span></a></li>
    50. 

  50. <li class="toclevel-3 tocsection-13"><a href="#var_.24avatar_uuid"><span class="tocnumber">4.2.5</span> <span class="toctext">var $avatar_uuid</span></a></li>
    51. 

  51. <li class="toclevel-3 tocsection-14"><a href="#var_.24avatar_name"><span class="tocnumber">4.2.6</span> <span class="toctext">var $avatar_name</span></a></li>
    52. 

  52. <li class="toclevel-3 tocsection-15"><a href="#var_.24login_security_token"><span class="tocnumber">4.2.7</span> <span class="toctext">var $login_security_token</span></a></li>
    53. 

  53. </ul>
    54. 

  54. </li>
    55. 

  55. <li class="toclevel-2 tocsection-16"><a href="#Utility_Objects"><span class="tocnumber">4.3</span> <span class="toctext">Utility Objects</span></a>
    56. 

  56. <ul>
    57. 

  57. <li class="toclevel-3 tocsection-17"><a href="#var_.24response"><span class="tocnumber">4.3.1</span> <span class="toctext">var $response</span></a></li>
    58. 

  58. <li class="toclevel-3 tocsection-18"><a href="#var_.24user"><span class="tocnumber">4.3.2</span> <span class="toctext">var $user</span></a></li>
    59. 

  59. </ul>
    60. 

  60. </li>
    61. 

  61. </ul>
    62. 

  62. </li>
    63. 

  63. <li class="toclevel-1 tocsection-19"><a href="#Functions"><span class="tocnumber">5</span> <span class="toctext">Functions</span></a>
    64. 

  64. <ul>
    65. 

  65. <li class="toclevel-2 tocsection-20"><a href="#Passive_Accessors"><span class="tocnumber">5.1</span> <span class="toctext">Passive Accessors</span></a>
    66. 

  66. <ul>
    67. 

  67. <li class="toclevel-3 tocsection-21"><a href="#is_request_data_processed.28.29"><span class="tocnumber">5.1.1</span> <span class="toctext">is_request_data_processed()</span></a></li>
    68. 

  68. <li class="toclevel-3 tocsection-22"><a href="#get_auth_status.28.29"><span class="tocnumber">5.1.2</span> <span class="toctext">get_auth_status()</span></a></li>
    69. 

  69. <li class="toclevel-3 tocsection-23"><a href="#is_authenticated.28.29"><span class="tocnumber">5.1.3</span> <span class="toctext">is_authenticated()</span></a></li>
    70. 

  70. <li class="toclevel-3 tocsection-24"><a href="#is_auth_failed.28.29"><span class="tocnumber">5.1.4</span> <span class="toctext">is_auth_failed()</span></a></li>
    71. 

  71. <li class="toclevel-3 tocsection-25"><a href="#set_response.28.24response.29"><span class="tocnumber">5.1.5</span> <span class="toctext">set_response($response)</span></a></li>
    72. 

  72. <li class="toclevel-3 tocsection-26"><a href="#set_user.28.24user.29"><span class="tocnumber">5.1.6</span> <span class="toctext">set_user($user)</span></a></li>
    73. 

  73. </ul>
    74. 

  74. </li>
    75. 

  75. <li class="toclevel-2 tocsection-27"><a href="#Active_Accessors"><span class="tocnumber">5.2</span> <span class="toctext">Active Accessors</span></a>
    76. 

  76. <ul>
    77. 

  77. <li class="toclevel-3 tocsection-28"><a href="#get_password.28.29"><span class="tocnumber">5.2.1</span> <span class="toctext">get_password()</span></a></li>
    78. 

  78. <li class="toclevel-3 tocsection-29"><a href="#get_course_id.28.29"><span class="tocnumber">5.2.2</span> <span class="toctext">get_course_id()</span></a></li>
    79. 

  79. <li class="toclevel-3 tocsection-30"><a href="#get_module_id.28.29"><span class="tocnumber">5.2.3</span> <span class="toctext">get_module_id()</span></a></li>
    80. 

  80. <li class="toclevel-3 tocsection-31"><a href="#get_avatar_uuid.28.29"><span class="tocnumber">5.2.4</span> <span class="toctext">get_avatar_uuid()</span></a></li>
    81. 

  81. <li class="toclevel-3 tocsection-32"><a href="#get_avatar_name.28.29"><span class="tocnumber">5.2.5</span> <span class="toctext">get_avatar_name()</span></a></li>
    82. 

  82. <li class="toclevel-3 tocsection-33"><a href="#get_login_security_token.28.29"><span class="tocnumber">5.2.6</span> <span class="toctext">get_login_security_token()</span></a></li>
    83. 

  83. <li class="toclevel-3 tocsection-34"><a href="#get_response.28.29"><span class="tocnumber">5.2.7</span> <span class="toctext">get_response()</span></a></li>
    84. 

  84. <li class="toclevel-3 tocsection-35"><a href="#get_user.28.29"><span class="tocnumber">5.2.8</span> <span class="toctext">get_user()</span></a></li>
    85. 

  85. </ul>
    86. 

  86. </li>
    87. 

  87. <li class="toclevel-2 tocsection-36"><a href="#Construction"><span class="tocnumber">5.3</span> <span class="toctext">Construction</span></a>
    88. 

  88. <ul>
    89. 

  89. <li class="toclevel-3 tocsection-37"><a href="#SloodleLSLRequest.28.26.24response.2C_.26.24user.29"><span class="tocnumber">5.3.1</span> <span class="toctext">SloodleLSLRequest(&amp;$response, &amp;$user)</span></a></li>
    90. 

  90. </ul>
    91. 

  91. </li>
    92. 

  92. <li class="toclevel-2 tocsection-38"><a href="#Other_Functions"><span class="tocnumber">5.4</span> <span class="toctext">Other Functions</span></a>
    93. 

  93. <ul>
    94. 

  94. <li class="toclevel-3 tocsection-39"><a href="#process_request_data.28.24force_.3D_FALSE.29"><span class="tocnumber">5.4.1</span> <span class="toctext">process_request_data($force = FALSE)</span></a></li>
    95. 

  95. <li class="toclevel-3 tocsection-40"><a href="#authenticate_request.28.24require_.3D_TRUE.29"><span class="tocnumber">5.4.2</span> <span class="toctext">authenticate_request($require = TRUE)</span></a></li>
    96. 

  96. <li class="toclevel-3 tocsection-41"><a href="#get_course_record.28.24require_.3D_TRUE.29"><span class="tocnumber">5.4.3</span> <span class="toctext">get_course_record($require = TRUE)</span></a></li>
    97. 

  97. <li class="toclevel-3 tocsection-42"><a href="#get_course_module_instance.28.24type_.3D_.27.27.2C_.24require_.3D_TRUE.29"><span class="tocnumber">5.4.4</span> <span class="toctext">get_course_module_instance($type = '', $require = TRUE)</span></a></li>
    98. 

  98. <li class="toclevel-3 tocsection-43"><a href="#required_param.28.24parname.2C_.24type.3DPARAM_RAW.29"><span class="tocnumber">5.4.5</span> <span class="toctext">required_param($parname, $type=PARAM_RAW)</span></a></li>
    99. 

  99. </ul>
    100. 

  100. </li>
    101. 

  101. </ul>
    102. 

  102. </li>
    103. 

  103. </ul>
    104. 

  104. </td></tr></table>
    105. 

  105. <h2> <span class="mw-headline" id="Declaration"> Declaration </span></h2>
    106. 

  106. <p><font size="5"><code>class SloodleLSLRequest</code></font><br />
    107. 

  107. Defined in: <a href="../../../../articles/f/i/l/File:File.gif.html" class="image"><img alt="File.gif" src="../../../../images/a/2F/a/a/af/File.gif" width="16" height="16" /></a>  <a href="../../../../articles/l/i/b/Fileref:lib/sl_iolib.php.html" title="Fileref:lib/sl iolib.php">lib/sl_iolib.php</a> <br />
    108. 

  108. Contained by: <a href="../../../../articles/s/l/o/SloodleLSLHandler.html" title="SloodleLSLHandler">SloodleLSLHandler</a><br />
    109. 

  109. </p><p><br />
    110. 

  110. </p>
    111. 

  111. <h2> <span class="mw-headline" id="Summary"> Summary </span></h2>
    112. 

  112. <p>This PHP class is created to simplify and automated much of the handling of HTTP requests from LSL scripts. With a single function call, it will fetch and store all of the standard Sloodle parameters, and perform basic functionality. It will also manipulate a <a href="../../../../articles/s/l/o/SloodleUser.html" title="SloodleUser">SloodleUser</a> object and a <a href="../../../../articles/s/l/o/SloodleLSLResponse.html" title="SloodleLSLResponse">SloodleLSLResponse</a> object to reflect the input data (both of these objects can be provided in the constructor, which is handled automatically by the <a href="../../../../articles/s/l/o/SloodleLSLHandler.html" title="SloodleLSLHandler">SloodleLSLHandler</a> class).
    113. 

  113. </p><p>Additional functions allow further processing on the input data, as well as the ability to fetch custom parameters. It is also capable of terminating the script and automatically outputting an error message if an error occurs.
    114. 

  114. </p>
    115. 

  115. <div class="center"><div class="floatnone"><a href="../../../../articles/s/l/o/File:Sloodle_api_uml_highlight_request.jpg.html" class="image"><img alt="Sloodle api uml highlight request.jpg" src="../../../../images/f/2F/f/f/f8/Sloodle_api_uml_highlight_request.jpg" width="798" height="277" /></a></div></div>
    116. 

  116. <p><br />
    117. 

  117. </p>
    118. 

  118. <h2> <span class="mw-headline" id="Compatibility"> Compatibility </span></h2>
    119. 

  119. <p>This class conforms to PHP4 syntax, and so scope visibility qualifiers (public, private, protected) are not available. All of the data should be considered <b>private</b>, with access via appropriate accessor functions.
    120. 

  120. </p><p><br />
    121. 

  121. </p>
    122. 

  122. <h2> <span class="mw-headline" id="Data"> Data </span></h2>
    123. 

  123. <p>All data should be considered <b>private</b>.
    124. 

  124. </p>
    125. 

  125. <h3> <span class="mw-headline" id="Status_Data"> Status Data </span></h3>
    126. 

  126. <p>These data members represent general status information about the request.
    127. 

  127. </p>
    128. 

  128. <h5> <span class="mw-headline" id="var_.24request_data_processed">var $request_data_processed</span></h5>
    129. 

  129. <p>This member will always be a boolean, initially FALSE, indicating whether or not the request data has been processed yet. Use the "process_request_data(..)" function to process the data.
    130. 

  130. </p>
    131. 

  131. <h5> <span class="mw-headline" id="var_.24auth_status">var $auth_status</span></h5>
    132. 

  132. <p>This member indicates the status of authentication of the request (i.e. the success or failure of the password). It will take on one of the following values: <a href="../../../../articles/s/l/o/SLOODLE_AUTH_UNKNOWN.html" title="SLOODLE AUTH UNKNOWN">SLOODLE_AUTH_UNKNOWN</a> (default), <a href="../../../../articles/s/l/o/SLOODLE_AUTH_OK.html" title="SLOODLE AUTH OK">SLOODLE_AUTH_OK</a>, or <a href="../../../../articles/s/l/o/SLOODLE_AUTH_FAILED.html" title="SLOODLE AUTH FAILED">SLOODLE_AUTH_FAILED</a>. These represent "authentication not attempted, "authentication succeeded", and "authentication failed" respectively.
    133. 

  133. </p><p>You can check authentication by calling the "authenticate_request()" member function.
    134. 

  134. </p>
    135. 

  135. <h3> <span class="mw-headline" id="Request_Data"> Request Data </span></h3>
    136. 

  136. <p>These data members represent data which has been passed-in via HTTP parameter. If a value is NULL (default) and the request data <i>has</i> been processed, then that value was not specified in the request.
    137. 

  137. </p>
    138. 

  138. <h5> <span class="mw-headline" id="var_.24password">var $password</span></h5>
    139. 

  139. <p>The security password provided by an object in the "<i>sloodlepwd</i>" parameter. This can either be the site-wide <a href="../../../../articles/p/r/i/Prim_Password.html" title="Prim Password">Prim Password</a>, or an object-specific session key (if using <a href="../../../../articles/o/b/j/Object_Authorization.html" title="Object Authorization">Object Authorization</a>).
    140. 

  140. </p>
    141. 

  141. <h5> <span class="mw-headline" id="var_.24login_zone_pos">var $login_zone_pos</span></h5>
    142. 

  142. <p>Contains an array vector {x,y,z} giving the position of a LoginZone, as reported in HTTP parameter "<i>sloodleloginzonepos</i>".
    143. 

  143. </p>
    144. 

  144. <h5> <span class="mw-headline" id="var_.24course_id">var $course_id</span></h5>
    145. 

  145. <p>Integer identifying a Moodle course, as specified in HTTP parameter "<i>sloodlecourseid</i>".
    146. 

  146. </p>
    147. 

  147. <h5> <span class="mw-headline" id="var_.24module_id">var $module_id</span></h5>
    148. 

  148. <p>Integer identifying a Moodle course module instance, as specified in HTTP parameter "<i>sloodlemoduleid</i>".
    149. 

  149. </p>
    150. 

  150. <h5> <span class="mw-headline" id="var_.24avatar_uuid">var $avatar_uuid</span></h5>
    151. 

  151. <p>A string containing the UUID of an SL avatar, as specified in HTTP parameter "<i>sloodleuuid</i>". When processing takes place, this value is automatically passed-on to the <i>$response</i> object.
    152. 

  152. </p>
    153. 

  153. <h5> <span class="mw-headline" id="var_.24avatar_name">var $avatar_name</span></h5>
    154. 

  154. <p>A string containing the name of an SL avatar, as specified in HTTP parameter "<i>sloodleavname</i>". Note that this is the full name separated by a space -- i.e. "firstname lastname".
    155. 

  155. </p>
    156. 

  156. <h5> <span class="mw-headline" id="var_.24login_security_token">var $login_security_token</span></h5>
    157. 

  157. <p>A string containing the login security token for the user registration attempt, as given in HTTP parameter "<i>sloodlelst</i>".
    158. 

  158. </p><p><br />
    159. 

  159. </p>
    160. 

  160. <h3> <span class="mw-headline" id="Utility_Objects"> Utility Objects </span></h3>
    161. 

  161. <p>These members are references to other objects which are used/manipulated by this object. They may be passed-in from outside, either via the constructor or via accessor. However, if none are passed-in, then the class creates them itself. (Note: the <a href="../../../../articles/s/l/o/SloodleLSLHandler.html" title="SloodleLSLHandler">SloodleLSLHandler</a> class automatically provides its own objects for this purpose).
    162. 

  162. </p>
    163. 

  163. <h5> <span class="mw-headline" id="var_.24response">var $response</span></h5>
    164. 

  164. <p>Reference to a <a href="../../../../articles/s/l/o/SloodleLSLResponse.html" title="SloodleLSLResponse">SloodleLSLResponse</a> object, to which appropriate response data is automatically written during request processing. Additionally, this object is used for output purposes if an error occurs.
    165. 

  165. </p>
    166. 

  166. <h5> <span class="mw-headline" id="var_.24user">var $user</span></h5>
    167. 

  167. <p>References to a <a href="../../../../articles/s/l/o/SloodleUser.html" title="SloodleUser">SloodleUser</a> object, to which appropriate user data is automatically written during request processing. If an avatar is identified in the request data, then their Sloodle user data is fetched (if it exists). Additionally, if it is linked to a Moodle account, then that data is fetched as well.
    168. 

  168. </p><p><br />
    169. 

  169. </p>
    170. 

  170. <h2> <span class="mw-headline" id="Functions"> Functions </span></h2>
    171. 

  171. <h3> <span class="mw-headline" id="Passive_Accessors"> Passive Accessors </span></h3>
    172. 

  172. <p>These functions are used to get/set data which is otherwise private. No other processing is done in these functions.
    173. 

  173. </p>
    174. 

  174. <h5> <span class="mw-headline" id="is_request_data_processed.28.29">is_request_data_processed()</span></h5>
    175. 

  175. <p>Returns the value of member <i>$request_data_processed</i>, indicating whether or not basic request processing has already been done.
    176. 

  176. </p>
    177. 

  177. <h5> <span class="mw-headline" id="get_auth_status.28.29">get_auth_status()</span></h5>
    178. 

  178. <p>Returns the value of member <i>$auth_status</i>, indicating if request authentication has been attempted, and whether or not it was successful.
    179. 

  179. </p>
    180. 

  180. <h5> <span class="mw-headline" id="is_authenticated.28.29">is_authenticated()</span></h5>
    181. 

  181. <p>Returns TRUE if the request has been authenticated, or FALSE if it has not been attempted, or if authentication failed.
    182. 

  182. </p>
    183. 

  183. <h5> <span class="mw-headline" id="is_auth_failed.28.29">is_auth_failed()</span></h5>
    184. 

  184. <p>Returns TRUE if request authentication has failed, or FALSE if it succeeded or has not yet been attampted.
    185. 

  185. </p>
    186. 

  186. <h5> <span class="mw-headline" id="set_response.28.24response.29">set_response($response)</span></h5>
    187. 

  187. <p>Provides a reference to a <a href="../../../../articles/s/l/o/SloodleLSLResponse.html" title="SloodleLSLResponse">SloodleLSLResponse</a> object which is to be stored in the <i>$response</i> member.
    188. 

  188. </p>
    189. 

  189. <ul><li> <i>Note:</i> if you are providing a custom response object, it is advisable to provide it in the constructor, or immediately thereafter.
    190. 

  190. </li></ul>
    191. 

  191. <h5> <span class="mw-headline" id="set_user.28.24user.29">set_user($user)</span></h5>
    192. 

  192. <p>Provides a reference to a <a href="../../../../articles/s/l/o/SloodleUser.html" title="SloodleUser">SloodleUser</a> object which is to be stored in the <i>$user</i> member.
    193. 

  193. </p>
    194. 

  194. <ul><li> <i>Note:</i> if you are providing a custom user object, it is advisable to provide it in the constructor, or immediately thereafter.
    195. 

  195. </li></ul>
    196. 

  196. <p><br />
    197. 

  197. </p>
    198. 

  198. <h3> <span class="mw-headline" id="Active_Accessors"> Active Accessors </span></h3>
    199. 

  199. <p>These functions provide access to the request data, but will first make sure the request data has been processed. (Note: if the request data <i>has</i> already been processed, then it is not done again). Remember that each function may return NULL if the appropriate parameter was not specified in the request.
    200. 

  200. </p>
    201. 

  201. <h5> <span class="mw-headline" id="get_password.28.29">get_password()</span></h5>
    202. 

  202. <p>Returns the password string stored in member <i>$password</i>.
    203. 

  203. </p>
    204. 

  204. <h5> <span class="mw-headline" id="get_course_id.28.29">get_course_id()</span></h5>
    205. 

  205. <p>Returns the course ID integer stored in member <i>$course_id</i>.
    206. 

  206. </p>
    207. 

  207. <h5> <span class="mw-headline" id="get_module_id.28.29">get_module_id()</span></h5>
    208. 

  208. <p>Returns the module ID integer stored in member <i>$module_id</i>.
    209. 

  209. </p>
    210. 

  210. <h5> <span class="mw-headline" id="get_avatar_uuid.28.29">get_avatar_uuid()</span></h5>
    211. 

  211. <p>Returns the avatar UUID string stored in member <i>$avatar_uuid</i>.
    212. 

  212. </p>
    213. 

  213. <h5> <span class="mw-headline" id="get_avatar_name.28.29">get_avatar_name()</span></h5>
    214. 

  214. <p>Returns the avatar name string stored in member <i>$avatar_name</i>.
    215. 

  215. </p>
    216. 

  216. <h5> <span class="mw-headline" id="get_login_security_token.28.29">get_login_security_token()</span></h5>
    217. 

  217. <p>Returns the login security token string stored in member <i>$login_security_token</i>.
    218. 

  218. </p>
    219. 

  219. <h5> <span class="mw-headline" id="get_response.28.29">get_response()</span></h5>
    220. 

  220. <p>Returns the reference to a <a href="../../../../articles/s/l/o/SloodleLSLResponse.html" title="SloodleLSLResponse">SloodleLSLResponse</a> object stored in member <i>$response</i>.
    221. 

  221. </p>
    222. 

  222. <h5> <span class="mw-headline" id="get_user.28.29">get_user()</span></h5>
    223. 

  223. <p>Returns the reference to a <a href="../../../../articles/s/l/o/SloodleUser.html" title="SloodleUser">SloodleUser</a> object stored in member <i>$user</i>.
    224. 

  224. </p><p><br />
    225. 

  225. </p>
    226. 

  226. <h3> <span class="mw-headline" id="Construction"> Construction </span></h3>
    227. 

  227. <h5> <span class="mw-headline" id="SloodleLSLRequest.28.26.24response.2C_.26.24user.29">SloodleLSLRequest(&amp;$response, &amp;$user)</span></h5>
    228. 

  228. <p>This constructor can be used to provide references to <a href="../../../../articles/s/l/o/SloodleLSLResponse.html" title="SloodleLSLResponse">SloodleLSLResponse</a> and <a href="../../../../articles/s/l/o/SloodleUser.html" title="SloodleUser">SloodleUser</a> objects (parameters <i>$response</i> and <i>$user</i> respectively). If they are not NULL, then they are stored in members <i>$response</i> and <i>$user</i> respectively. However, if the parameters are NULL, then the constructor creates its own objects for this.
    229. 

  229. </p>
    230. 

  230. <ul><li> <b>Note:</b> you can provide one object, and make the other NULL.
    231. 

  231. </li></ul>
    232. 

  232. <p><br />
    233. 

  233. </p>
    234. 

  234. <h3> <span class="mw-headline" id="Other_Functions"> Other Functions </span></h3>
    235. 

  235. <p>Like the "Active Accessors" above, these functions will make sure the request data has been processed before they execute.
    236. 

  236. </p>
    237. 

  237. <h5> <span class="mw-headline" id="process_request_data.28.24force_.3D_FALSE.29">process_request_data($force = FALSE)</span></h5>
    238. 

  238. <p>This is the most important function in the class. It will check for all of the standard Sloodle parameters in the incoming HTTP request (using the Moodle "optional_param" function), and store any values it finds. Most other member functions in this class will call this function if necessary before they start, so you rarely actually <i>need</i> to call this function directly. <i>However,</i> it is strongly advisable to do so anyway, to avoid problems.
    239. 

  239. </p><p>It also performs certain processing, such as converting the Login Zone position string to an array of vector information. Most importantly, if an avatar is identified by name and/or UUID, then it will lookup that user in the database and, if found, store their details in the <a href="../../../../articles/s/l/o/SloodleUser.html" title="SloodleUser">SloodleUser</a> <i>$user</i> member. Additionally, if the avatar is linked to a Moodle account, then it will automatically lookup and store the details for that Moodle account in the <i>$user</i> member as well. Another useful feature is that, if only the avatar name or UUID was specified in the request, but the other item was found in the database, then it will replace the missing request data so that your processing scripts can continue without problem.
    240. 

  240. </p><p>Furthermore, this processing function will write certain items of data to the <a href="../../../../articles/s/l/o/SloodleLSLResponse.html" title="SloodleLSLResponse">SloodleLSLResponse</a> <i>$response</i> member, including avatar UUID, and the request descriptor (which does not get stored in the request class).
    241. 

  241. </p>
    242. 

  242. <ul><li> <b>NOTE:</b> when processing is done, the <i>$request_data_processed</i> member is set to TRUE. If processing has already been done when this function is called, then it is not done again... <b>unless</b> the optional <i>$force</i> parameter is explicitly set to TRUE (the default is FALSE). This can be used if you know the request data has changed, for whatever reason... although that is a very unlikely circumstance!
    243. 

  243. </li></ul>
    244. 

  244. <p><br />
    245. 

  245. </p>
    246. 

  246. <h5> <span class="mw-headline" id="authenticate_request.28.24require_.3D_TRUE.29">authenticate_request($require = TRUE)</span></h5>
    247. 

  247. <p>This function is used to check the authentication information provided in the request parameters (i.e. the <i>$password</i> member) against the authentication data in the database. If the authentication data is correct, then it will set the <i>$auth_status</i> member to <a href="../../../../articles/s/l/o/SLOODLE_AUTH_OK.html" title="SLOODLE AUTH OK">SLOODLE_AUTH_OK</a>, and return TRUE.
    248. 

  248. </p><p>If authentication fails, then behaviour the <i>$auth_status</i> member is set to <a href="../../../../articles/s/l/o/SLOODLE_AUTH_FAILED.html" title="SLOODLE AUTH FAILED">SLOODLE_AUTH_FAILED</a>, although the subsequent behaviour depends upon the <i>$require</i> parameter. If <i>$require</i> is TRUE (default), then the script will terminate with an error message. Otherwise, it will simply return FALSE.
    249. 

  249. </p>
    250. 

  250. <ul><li> In most cases, you can omit the <i>$require</i> parameter, as it will default to TRUE, and you want to make sure unauthorised requests are not permitted.
    251. 

  251. </li><li> See <a href="../../../../articles/p/r/i/Prim_Password.html" title="Prim Password">Prim Password</a> and <a href="../../../../articles/o/b/j/Object_Authorization.html" title="Object Authorization">Object Authorization</a> for more information on object authentication methods.
    252. 

  252. </li></ul>
    253. 

  253. <p><br />
    254. 

  254. </p>
    255. 

  255. <h5> <span class="mw-headline" id="get_course_record.28.24require_.3D_TRUE.29">get_course_record($require = TRUE)</span></h5>
    256. 

  256. <p>Searches the database for the course identified in member <i>$course_id</i> (HTTP parameter "<i>sloodlecourseid</i>"). If the parameter was specified, and the course is found, it returns a database record object representing the course.
    257. 

  257. </p><p>Note that if the course ID was not specified, the course does not exist, or if it is not visible, the function will fail. If parameter <i>$require</i> is TRUE (default) then failure means the script will terminate with an error message. Otherwise, it will return FALSE.
    258. 

  258. </p><p><br />
    259. 

  259. </p>
    260. 

  260. <h5> <span class="mw-headline" id="get_course_module_instance.28.24type_.3D_.27.27.2C_.24require_.3D_TRUE.29">get_course_module_instance($type = '', $require = TRUE)</span></h5>
    261. 

  261. <p>Searches the database for the course module instance identified in member <i>$module_id</i> (HTTP parameter "<i>sloodlemoduleid</i>"). If the instance is found, is visible, and is of the correct type (according to the name in parameter <i>$type</i>) then a database record object is returned. (Note: type-checking is based on module names such as "forum" or "sloodle". It is optional, and is skipped if the name is empty).
    262. 

  262. </p><p>Note that if the module ID was not specified, the module does not exist, it is not visible, or if it is of the wrong type, then the function fails. If parameter <i>$require</i> is TRUE (default) then failure means the script will terminate with an error message. Otherwise, it will return FALSE.
    263. 

  263. </p><p><br />
    264. 

  264. </p>
    265. 

  265. <h5> <span class="mw-headline" id="required_param.28.24parname.2C_.24type.3DPARAM_RAW.29">required_param($parname, $type=PARAM_RAW)</span></h5>
    266. 

  266. <p>This function is a Sloodle-friendly version of the Moodle "required_param" function. However, instead of rendering an HTML error message on failure, this will render an LSL-friendly error message.
    267. 

  267. </p><p>It is used to get a particular HTTP request parameter, with name <i>$parname</i>, and type according to parameter <i>$type</i> (the standard Moodle types work here, such as PARAM_RAW for a string, PARAM_INT for an integer).
    268. 

  268. </p>
    269. 

  269. <ul><li> See also the global Sloodle function: <a href="../../../../articles/s/l/o/Sloodle_required_param.html" title="Sloodle required param">sloodle_required_param</a>.
    270. 

  270. </li></ul>
    271. 

  271. <p>(The advantage to using the member version is that it will still output other response status data that may have been accumulated).
    272. 

  272. </p><p><br />
    273. 

  273. </p>
    274. 

  274. <table style="background-color:white; border:1px solid #0099cc; text-align:center; width:100%;">
    275. 

  275. <tr>
    276. 

  276. <th style="background-color:#99d9ea;" colspan="4"> This page is part of the SLOODLE documentation
    277. 

  277. </th></tr>
    278. 

  278. <tr>
    279. 

  279. <td style="border-bottom:solid 1px #dddddd;"> Docs: <a href="../../../../articles/s/l/o/SloodleUserDocs.html" title="SloodleUserDocs" class="mw-redirect">Users</a> | <a href="../../../../articles/s/l/o/SloodleAdminDocs.html" title="SloodleAdminDocs" class="mw-redirect">Administrators</a> | <a href="../../../../articles/s/l/o/SloodleDevDocs.html" title="SloodleDevDocs" class="mw-redirect">Developers</a>
    280. 

  280. </td></tr>
    281. 

  281. <tr>
    282. 

  282. <td style=""> <span style="float:left"><a href="../../../../articles/s/l/o/Sloodle.html" title="Sloodle" class="mw-redirect">Wiki Frontpage</a></span> <span style="float:right"><a rel="nofollow" class="external text" href="http://www.sloodle.org">Sloodle.org</a></span>
    283. 

  283. </td></tr></table>
    284. 

  284. 

  285. <!-- 
    286. 

  286. NewPP limit report
    287. 

  287. Preprocessor node count: 188/1000000
    288. 

  288. Post‐expand include size: 557/2097152 bytes
    289. 

  289. Template argument size: 47/2097152 bytes
    290. 

  290. Expensive parser function count: 0/100
    291. 

  291. -->
    292. 

  292. </div><div class="printfooter">
    293. 

  293. </div>
    294. 

  294. 	    <div id="catlinks"><div id='catlinks' class='catlinks'><div id="mw-normal-catlinks" class="mw-normal-catlinks"><a href="http://localhost/sl/index.php/Special:Categories" title="Special:Categories">Category</a>: <ul><li><a href="../../../../articles/s/l/o/Category:Sloodle_PHP_API.html" title="Category:Sloodle PHP API">Sloodle PHP API</a></li></ul></div></div></div>	    <!-- end content -->
    295. 

  295. 	    <div class="visualClear"></div>
    296. 

  296. 	  </div>
    297. 

  297. 	</div>
    298. 

  298.       </div>
    299. 

  299.       <div id="column-one">
    300. 

  300. 	<div id="p-cactions" class="portlet">
    301. 

  301. 	  <h5>Views</h5>
    302. 

  302. 	  <ul>
    303. 

  303. 	    <li id="ca-nstab-main"
    304. 

  304. 	       class="selected"	       ><a href="../../../../articles/s/l/o/SloodleLSLRequest.html">Page</a></li><li id="ca-talk"
    305. 

  305. 	       class="new"	       ><a href="http:http://localhost/sl/index.php?title=Talk:SloodleLSLRequest&amp;action=edit&amp;redlink=1">Discussion</a></li><li id="ca-current"
    306. 

  306. 	       	       ><a href="http://localhost/sl/index.php/SloodleLSLRequest">Latest revision</a></li>	  </ul>
    307. 

  307. 	</div>
    308. 

  308. 	<div class="portlet" id="p-logo">
    309. 

  309. 	  <a style="background-image: url(../../../../misc/wiki.png);"
    310. 

  310. 	    href="../../../../index.html"
    311. 

  311. 	    title="Main Page"></a>
    312. 

  312. 	</div>
    313. 

  313. 	<script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script>
    314. 

  314. 		<div class='portlet' id='p-navigation'>
    315. 

  315. 	  <h5>Navigation</h5>
    316. 

  316. 	  <div class='pBody'>
    317. 

  317. 	    <ul>
    318. 

  318. 	    	      <li id="n-mainpage-description"><a href="../../../../index.html">Main page</a></li>
    319. 

  319. 	     	      <li id="n-SLOODLE"><a href="../../../../articles/s/l/o/Sloodle.html">SLOODLE</a></li>
    320. 

  320. 	     	      <li id="n-currentevents"><a href="../../../../articles/c/u/r/SLIS_Second_Life_Wiki:Current_events.html">Current events</a></li>
    321. 

  321. 	     	      <li id="n-help"><a href="../../../../articles/c/o/n/Help:Contents.html">Help</a></li>
    322. 

  322. 	     	    </ul>
    323. 

  323. 	  </div>
    324. 

  324. 	</div>
    325. 

  325. 		<div class='portlet' id='p-SEARCH'>
    326. 

  326. 	  <h5>Search</h5>
    327. 

  327. 	  <div class='pBody'>
    328. 

  328. 	    <ul>
    329. 

  329. 	    	    </ul>
    330. 

  330. 	  </div>
    331. 

  331. 	</div>
    332. 

  332. 		<div class='portlet' id='p-TOOLBOX'>
    333. 

  333. 	  <h5>Toolbox</h5>
    334. 

  334. 	  <div class='pBody'>
    335. 

  335. 	    <ul>
    336. 

  336. 	    	    </ul>
    337. 

  337. 	  </div>
    338. 

  338. 	</div>
    339. 

  339. 		<div class='portlet' id='p-LANGUAGES'>
    340. 

  340. 	  <h5>LANGUAGES</h5>
    341. 

  341. 	  <div class='pBody'>
    342. 

  342. 	    <ul>
    343. 

  343. 	    	    </ul>
    344. 

  344. 	  </div>
    345. 

  345. 	</div>
    346. 

  346. 		<div id="p-search" class="portlet">
    347. 

  347. 	  <h5><label for="searchInput">Search</label></h5>
    348. 

  348. 	  <div id="searchBody" class="pBody">
    349. 

  349. 	    <form action="javascript:goToStatic(3)" id="searchform"><div>
    350. 

  350. 	      <input id="searchInput" name="search" type="text"
    351. 

  351. 	        accesskey="f" value="" />
    352. 

  352. 	      <input type='submit' name="go" class="searchButton" id="searchGoButton"
    353. 

  353. 	        value="Go" />
    354. 

  354. 	    </div></form>
    355. 

  355. 	  </div>
    356. 

  356. 	</div>
    357. 

  357. 	      </div><!-- end of the left (by default at least) column -->
    358. 

  358.       <div class="visualClear"></div>
    359. 

  359.       <div id="footer">
    360. 

  360.     <div id="f-poweredbyico"><a href="//www.mediawiki.org/"><img src="../../../../skins/common/images/poweredby_mediawiki_88x31.png" height="31" width="88" alt="Powered by MediaWiki" /></a></div>		<ul id="f-list">
    361. 

  361. 	  	  	  <li id="f-credits">This page was last modified 07:48, 6 February 2008 by SLIS Second Life Wiki user <a href="http:http://localhost/sl/index.php?title=User:Peter_Bloomfield&amp;action=edit&amp;redlink=1" class="new" title="User:Peter Bloomfield (page does not exist)">Peter Bloomfield</a>. </li>	  	  <li id="f-about"><a href="../../../../articles/a/b/o/SLIS_Second_Life_Wiki:About.html" title="SLIS Second Life Wiki:About">About SLIS Second Life Wiki</a></li>	  <li id="f-disclaimer"><a href="../../../../articles/g/e/n/SLIS_Second_Life_Wiki:General_disclaimer.html" title="SLIS Second Life Wiki:General disclaimer">Disclaimers</a></li>	  	</ul>
    362. 

  362.       </div>
    363. 

  363.     </div>
    364. 

  364.   </body>
    365. 

  365. </html>
    366.