Ayuda_Virtual
/
sloodle_website


			
				
					
						
						
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417
							<?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 general.php</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="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/lib/general.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">Sloodle general library.</p>
<p class="description"><p>Provides various utility functionality for general Sloodle purposes.</p></p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright (c) 2007-8 Sloodle (various contributors)</li>
				<li><span class="field">contributor:</span> Edmund Edgar</li>
				<li><span class="field">contributor:</span> Peter R. Bloomfield</li>
				<li><span class="field">filesource:</span> <a href="../__filesource/fsource_sloodle__libgeneral.php.html">Source Code for this file</a></li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl-3.0.html">GNU GPL v3</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>
			|													<a href="#sec-functions">Functions</a>
					</div>
		<div class="info-box-body">	
			<a name="_SLOODLE_LIBROOT_/mail_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">SLOODLE_LIBROOT.'/mail.php'</span>)
			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a21">21</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Include our email functionality.</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="functionsloodle_access_level_option_choice" id="functionsloodle_access_level_option_choice"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_access_level_option_choice</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a755">755</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			sloodle_access_level_option_choice
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$option</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$current_config</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$show</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&#039;&#039;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$suffix</span> = <span class="var-default">&#039;&#039;</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$option</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$current_config</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$show</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$prefix</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$suffix</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_add_to_log" id="functionsloodle_add_to_log"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_add_to_log</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a163">163</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Old logging function</p>
	<ul class="tags">
				<li><span class="field">todo:</span> <strong>May require update?</strong></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			sloodle_add_to_log
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$courseid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$action</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$cmid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$info</span> = <span class="var-default">null</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$courseid</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$module</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$action</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$url</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$cmid</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$info</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_array_to_vector" id="functionsloodle_array_to_vector"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_array_to_vector</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a297">297</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts an array vector to a string vector.</p>
<p class="description"><p>Array vector should be associative, containing elements 'x', 'y', and 'z'.  Converts to a string vector of format &quot;&lt;x,y,z&gt;&quot;.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../sloodle/_lib---general.php.html#functionsloodle_round_vector">sloodle_round_vector()</a></li>
				<li><span class="field">see:</span> <a href="../sloodle/_lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array()</a></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_array_to_vector
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$arr</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$arr</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_autoenrol_enabled_site" id="functionsloodle_autoenrol_enabled_site"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_autoenrol_enabled_site</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a109">109</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not auto-enrolment is allowed for the site.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if auto-enrolment is allowed on the site, or false otherwise.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_autoenrol_enabled_site
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_autoreg_enabled_site" id="functionsloodle_autoreg_enabled_site"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_autoreg_enabled_site</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a100">100</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not auto-registration is allowed for the site.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if auto-reg is allowed on the site, or false otherwise.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_autoreg_enabled_site
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_check_course_module_instance_type" id="functionsloodle_check_course_module_instance_type"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_check_course_module_instance_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a345">345</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines if the specified course module instance is of the named type.</p>
<p class="description"><p>For example, this can check if a particular instance is a &quot;forum&quot; or a &quot;chat&quot;.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if the module is of the specified type, or false otherwise</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_check_course_module_instance_type
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$module_name</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$id</span><span class="var-description">: The integer ID of a course module instance</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$module_name</span><span class="var-description">: Module type to check (must be the exact name of an installed module, e.g. 'sloodle' or 'quiz')</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_clean_for_db" id="functionsloodle_clean_for_db"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_clean_for_db</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a1059">1059</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the given string, 'cleaned' and ready for storage in the database.</p>
<p class="description"><p>Note: removes tags and slash-characters.</p></p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_clean_for_db
		</span>
					(<span class="var-type">string</span>&nbsp;<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">: str The string to clean.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_clean_for_output" id="functionsloodle_clean_for_output"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_clean_for_output</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a1048">1048</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the given string, 'cleaned' and ready for output to SL as UTF-8.</p>
<p class="description"><p>Removes tags and slash-characters.</p></p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_clean_for_output
		</span>
					(<span class="var-type">string</span>&nbsp;<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">: str The string to clean.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_convert_file_size_shorthand" id="functionsloodle_convert_file_size_shorthand"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_convert_file_size_shorthand</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a1070">1070</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a shorthand file size to a number of bytes, if necessary.</p>
<p class="description"><p>This follows PHP shorthand, with K for Kilobytes, M for Megabytes, and G for Gigabytes.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The size specified in bytes</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			sloodle_convert_file_size_shorthand
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$size</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$size</span><span class="var-description">: size The shorthand size to conert</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_describe_approx_time" id="functionsloodle_describe_approx_time"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_describe_approx_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a796">796</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a very approximate natural language description of a period of time (in minutes, hours, days, or weeks).</p>
<p class="description"><p>Can also be used to describe how long ago something happened, in which case anything less than 1 minute is treated as 'now'.</p></p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_describe_approx_time
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$secs</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$ago</span> = <span class="var-default">false</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$secs</span><span class="var-description">: Number of seconds in period of time</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$ago</span><span class="var-description">: If true (not default), then the time will be described in past tense, e.g. &quot;3 days ago&quot;, as opposed to simply &quot;3 days&quot;.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_finished_login_coordinates" id="functionsloodle_finished_login_coordinates"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_finished_login_coordinates</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a415">415</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates teleport coordinates for a user who has already finished the LoginZone process.</p>
	<ul class="tags">
				<li><span class="field">return:</span> bool An associative array vector containing a teleport location, or false if the operation fails.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">array,</span>
		<span class="method-name">
			sloodle_finished_login_coordinates
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pos</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$size</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pos</span><span class="var-description">: A string vector giving the position of the LoginZone</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$size</span><span class="var-description">: A string vector giving the size of the LoginZone</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_get_config" id="functionsloodle_get_config"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_config</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a80">80</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets a Sloodle configuration value from Moodle's &quot;config&quot; table.</p>
<p class="description"><p>This function does not necessarily need to be used.  All configuration data is available as named members of Moodle's $CFG global variable.  <strong>NOTE:</strong> in Sloodle debug mode, this function will terminate the script with an error if the name is not prefixed with &quot;sloodle_&quot;.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A string containing the configuration value, or false if the query failed (e.g. if the named value didn't exist)</li>
				<li><span class="field">see:</span> <a href="../sloodle/_lib---general.php.html#functionsloodle_set_config">sloodle_set_config()</a></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			sloodle_get_config
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</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 value to be stored (should be prefixed with &quot;sloodle_&quot;)</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_get_course_module_instance" id="functionsloodle_get_course_module_instance"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_course_module_instance</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a308">308</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Obtains the identified course module instance database record.</p>
	<ul class="tags">
				<li><span class="field">return:</span> A database record if successful, or false if it could not be found</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			sloodle_get_course_module_instance
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$id</span><span class="var-description">: The integer ID of a course module instance</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_get_files" id="functionsloodle_get_files"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_files</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a899">899</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets an array of files within the given directory.</p>
<p class="description"><p>Ignores anything which starts with a .</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A numeric array of file names sorted alphabetically, or false if an error occurred (such as the input value not being a directory)</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">array|false</span>
		<span class="method-name">
			sloodle_get_files
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$relative</span> = <span class="var-default">true</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dir</span><span class="var-description">: The directory to search WITHOUT a trailing slash. (Note: cannot search the current directory or higher in the file hierarchy)</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$relative</span><span class="var-description">: If TRUE (default) the array of results will be relative to the input directory. Otherwise, they will include the input directory path.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_get_installed_object_types" id="functionsloodle_get_installed_object_types"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_installed_object_types</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a951">951</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets all object types and versions available in this installation.</p>
<p class="description"><p>Creates a 2-dimensional associative array.  The top level is the object name, and the second is the object version (both as strings).  The associated value is the path to the configuration form script, or boolean false   if the object has no configuration options.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Returns a 2d associative array if successful, or false if an error occurs</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">array|false</span>
		<span class="method-name">
			sloodle_get_installed_object_types
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_get_max_post_upload" id="functionsloodle_get_max_post_upload"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_max_post_upload</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a1112">1112</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the maximum size of a file (in bytes) that can be uploaded using POST.</p>
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			sloodle_get_max_post_upload
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_get_module_id" id="functionsloodle_get_module_id"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_module_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a366">366</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Obtains the ID number of the specified module (type not instance).</p>
	<ul class="tags">
				<li><span class="field">return:</span> Integer containing module ID, or false if it is not installed</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			sloodle_get_module_id
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</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 module type to check, e.g. 'sloodle' or 'forum'</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_get_size_description" id="functionsloodle_get_size_description"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_size_description</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a1091">1091</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a file size to plain text.</p>
<p class="description"><p>For example, will convert &quot;1024&quot; to &quot;1 kilobyte&quot;.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A text string describing the specified size.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_get_size_description
		</span>
					(<span class="var-type">integer|string</span>&nbsp;<span class="var-name">$size</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">integer|string</span>
				<span class="var-name">$size</span><span class="var-description">: size If an integer, then it is the number of bytes. If a string, then it can be PHP shorthand, such as &quot;1M&quot; for 1 megabyte.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_get_subdirectories" id="functionsloodle_get_subdirectories"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_subdirectories</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a867">867</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets an array of subdirectories within the given directory.</p>
<p class="description"><p>Ignores anything which starts with a .</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A numeric array of subdirectory names sorted alphabetically, or false if an error occurred (such as the input value not being a directory)</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">array|false</span>
		<span class="method-name">
			sloodle_get_subdirectories
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$relative</span> = <span class="var-default">true</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dir</span><span class="var-description">: The directory to search WITHOUT a trailing slash. (Note: cannot search the current directory or higher in the file hierarchy)</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$relative</span><span class="var-description">: If TRUE (default) the array of results will be relative to the input directory. Otherwise, they will include the input directory path.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_get_value" id="functionsloodle_get_value"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_value</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a683">683</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extracts a value from a name-value associative array if it is set.</p>
<p class="description"><p>(The array should associate name to value).</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The value from the input array, or the $default parameter</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			sloodle_get_value
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$settings</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$settings</span><span class="var-description">: The array of names and values</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: The name of the value to retrieve</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$default</span><span class="var-description">: The default value to return if the specified value was not found</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_get_web_path" id="functionsloodle_get_web_path"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_get_web_path</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a847">847</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the basic URL of the current web-page being accessed.</p>
<p class="description"><p>Includes the protocol, hostname, and script path/name.</p></p>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_get_web_path
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_is_course_module_instance_visible" id="functionsloodle_is_course_module_instance_visible"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_is_course_module_instance_visible</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a319">319</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not the specified course module instance is visible.</p>
<p class="description"><p>Checks that the instance itself and the course section are both valid.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if visible, or false if invisible or not found</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_is_course_module_instance_visible
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$id</span><span class="var-description">: The integer ID of a course module instance.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_is_installed" id="functionsloodle_is_installed"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_is_installed</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a204">204</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not Sloodle is installed.</p>
<p class="description"><p>Queries Moodle's modules table for a Sloodle entry.  <strong>NOTE:</strong> does not check for the presence of the Sloodle files.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if Sloodle is installed, or false otherwise.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_is_installed
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_login_notification" id="functionsloodle_login_notification"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_login_notification</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a597">597</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores a pending login notification for an auto-registered user.</p>
<p class="description"><p>A cron job will process the pending notification queue.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false otherwise</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_login_notification
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$destination</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$avatar</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$destination</span><span class="var-description">: Identifies the destination of the notification (for SL, this will be the object UUID. The send function will construct the email address)</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$avatar</span><span class="var-description">: Identifier for the avatar being notified</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span><span class="var-description">: The username to notify the user of</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span><span class="var-description">: The (plaintext) password to notify the user of</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_login_zone_bounds" id="functionsloodle_login_zone_bounds"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_login_zone_bounds</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a496">496</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Calculates the maximum and minimum bounds of the specified LoginZone  Returns the bounds as a numeric array of two associate array vectors: ($max, $min).</p>
<p class="description"><p>(Or returns false if no LoginZone position/size could be found in the Moodle configuration table).</p></p>
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			sloodle_login_zone_bounds
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pos</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$size</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pos</span><span class="var-description">: A string vector giving the position of the LoginZone</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$size</span><span class="var-description">: A string vector giving the size of the LoginZone</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_parse_object_identifier" id="functionsloodle_parse_object_identifier"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_parse_object_identifier</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a929">929</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extracts the object name and version number from an object identifier.</p>
	<ul class="tags">
				<li><span class="field">return:</span> A numeric array of name then version number.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			sloodle_parse_object_identifier
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$objid</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$objid</span><span class="var-description">: An object identifier, such as &quot;chat-1.0&quot;</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_position_is_in_login_zone" id="functionsloodle_position_is_in_login_zone"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_position_is_in_login_zone</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a383">383</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks if the specified position is in the current (site-wide) loginzone.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if position is in LoginZone, or false if not</li>
				<li><span class="field">see:</span> sloodle_login_zone_coordinates()</li>
				<li><span class="field">todo:</span> Update or remove... no longer valid</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_position_is_in_login_zone
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$pos</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$pos</span><span class="var-description">: A string vector or an associated array vector</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_print_access_level_options" id="functionsloodle_print_access_level_options"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_print_access_level_options</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a700">700</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Outputs the standard form elements for access levels in object configuration.</p>
<p class="description"><p>Each part can be optionally hidden, and default values can be provided.  (Note: the server access level must be communicated from the object back to Moodle... rubbish implementation, but it works!)</p></p>
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			sloodle_print_access_level_options
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$current_config</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$show_use_object</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$show_control_object</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$show_server</span> = <span class="var-default">true</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$current_config</span><span class="var-description">: An associative array of setting names to values, containing defaults. (Ignored if null).</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$show_use_object</span><span class="var-description">: Determines whether or not the &quot;Use Object&quot; setting is shown</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$show_control_object</span><span class="var-description">: Determines whether or not the &quot;Control Object&quot; setting is shown</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$show_server</span><span class="var-description">: Determines whether or not the server access setting is shown</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_process_login_notifications" id="functionsloodle_process_login_notifications"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_process_login_notifications</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a633">633</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Processes pending login notifications, up to a certain limit.</p>
<p class="description"><p>Retrieves the requests one-at-a-time for processing.  This is slower, but ensures minimal damage if the process is terminated, e.g. due to server timeout.</p></p>
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			sloodle_process_login_notifications
		</span>
					([<span class="var-type">int</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">25</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$limit</span><span class="var-description">: The maximum number of pending requests to process.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_random_position_in_zone" id="functionsloodle_random_position_in_zone"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_random_position_in_zone</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a438">438</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a random position within a cuboid zone of the specified size.</p>
<p class="description"><p>(Note: leaves a 2 metre margin round the outside)</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> An associative vector array</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			sloodle_random_position_in_zone
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$size</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$size</span><span class="var-description">: Associative array giving the size of the zone</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_random_prim_password" id="functionsloodle_random_prim_password"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_random_prim_password</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a262">262</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a random prim password (7 to 9 digit number).</p>
	<ul class="tags">
				<li><span class="field">return:</span> The password as a string</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_random_prim_password
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_random_security_token" id="functionsloodle_random_security_token"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_random_security_token</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a216">216</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a random login security token.</p>
<p class="description"><p>Uses mixed-case letters and numbers to generate a random 16-character string.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../sloodle/_lib---general.php.html#functionsloodle_random_web_password">sloodle_random_web_password()</a></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_random_security_token
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_random_web_password" id="functionsloodle_random_web_password"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_random_web_password</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a240">240</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a random web password  Uses mixed-case letters and numbers to generate a random 8-character string.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../sloodle/_lib---general.php.html#functionsloodle_random_security_token">sloodle_random_security_token()</a></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			sloodle_random_web_password
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_require_login_no_guest" id="functionsloodle_require_login_no_guest"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_require_login_no_guest</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a29">29</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Force the user to login, but reject guest logins.</p>
<p class="description"><p>This function exists to workaround some Moodle 1.8 bugs.</p></p>
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			sloodle_require_login_no_guest
		</span>
				()
			</div>

		
	
</div>
<a name="functionsloodle_round_vector" id="functionsloodle_round_vector"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_round_vector</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a461">461</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Rounds the specified 3d vector integer values.</p>
<p class="description"><p>Can handle/return a string vector, or an array vector.  (Output type matches input type).</p></p>
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			sloodle_round_vector
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$pos</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$pos</span><span class="var-description">: Either a string vector or an array vector</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_send_login_notification" id="functionsloodle_send_login_notification"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_send_login_notification</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a620">620</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send a login notification.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false otherwise</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_send_login_notification
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$destination</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$avatar</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$destination</span><span class="var-description">: Identifies the destination of the notification (for SL, this will be the object UUID. The target email address will be constructed)</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$avatar</span><span class="var-description">: Identifier for the avatar being notified</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span><span class="var-description">: The username to notify the user of</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span><span class="var-description">: The (plaintext) password to notify the user of</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_send_xmlrpc_message" id="functionsloodle_send_xmlrpc_message"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_send_xmlrpc_message</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a121">121</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sends an XMLRPC message into Second Life.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false if an error occurs</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_send_xmlrpc_message
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$channel</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$intval</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$strval</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$channel</span><span class="var-description">: A string containing a UUID identifying the XMLRPC channel in SL to be used</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$intval</span><span class="var-description">: An integer value to be sent in the message</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$strval</span><span class="var-description">: A string value to be sent in the message</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_set_config" id="functionsloodle_set_config"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_set_config</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a59">59</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets a Sloodle configuration value.</p>
<p class="description"><p>This data will be stored in Moodle's &quot;config&quot; table, so it will persist even after Sloodle is uninstalled.  After being set, it will be available (read-only) as a named member of Moodle's $CFG variable.  <strong>NOTE:</strong> in Sloodle debug mode, this function will terminate the script with an error if the name is not prefixed with &quot;sloodle_&quot;.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True on success, or false on failure (may fail if database query encountered an error)</li>
				<li><span class="field">see:</span> <a href="../sloodle/_lib---general.php.html#functionsloodle_get_config">sloodle_get_config()</a></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_set_config
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</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 value to be stored (should be prefixed with &quot;sloodle_&quot;)</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: The string representation of the value to be stored</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_validate_prim_password" id="functionsloodle_validate_prim_password"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_validate_prim_password</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a524">524</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks if the given prim password is valid.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if it is valid, or false otherwise.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_validate_prim_password
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span><span class="var-description">: The password string to check</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_validate_prim_password_verbose" id="functionsloodle_validate_prim_password_verbose"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_validate_prim_password_verbose</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a550">550</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks if the given prim password is valid, and provides feedback.</p>
<p class="description"><p>An array is written to by reference, each element containing error codes.  Each error code is a word. The full text of the error message may be obtained   from the string file by looking for &quot;primpass:errorcode&quot;.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if the prim password is valid, or false otherwise</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_validate_prim_password_verbose
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">&$errors</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span><span class="var-description">: The password to validate</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">&$errors</span><span class="var-description">: An array (passed by reference) which will contain any error messages</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_vector_to_array" id="functionsloodle_vector_to_array"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_vector_to_array</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a277">277</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a string vector to an array vector.</p>
<p class="description"><p>String vector should be of format &quot;&lt;x,y,z&gt;&quot;.  Converts to associative array with members 'x', 'y', and 'z'.  Returns false if input parameter was not of correct format.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../sloodle/_lib---general.php.html#functionsloodle_round_vector">sloodle_round_vector()</a></li>
				<li><span class="field">see:</span> <a href="../sloodle/_lib---general.php.html#functionsloodle_array_to_vector">sloodle_array_to_vector()</a></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			sloodle_vector_to_array
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$vector</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$vector</span><span class="var-description">: A string vector of format &quot;&lt;x,y,z&gt;&quot;.</span>			</li>
				</ul>
		
	
</div>
<a name="functionsloodle_view" id="functionsloodle_view"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">sloodle_view</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libgeneral.php.html#a994">994</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Render a page viewing a particular feature, or a SLOODLE module.</p>
<p class="description"><p>Outputs error text in SLOODLE debug mode.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false if not.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			sloodle_view
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$feature</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$feature</span><span class="var-description">: The name of a feature to view (&quot;course&quot;, &quot;user&quot;, &quot;users&quot;), or &quot;module&quot; to indicate that we are viewing some kind of module. Note: features should contain only alphanumric characters.</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Fri, 17 Jul 2009 11:01:16 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>