Ayuda_Virtual
/
sloodle_website


			
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493
							<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos  -->
			<title>Docs For Class SloodleUser</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
						<script src="../media/lib/classTree.js"></script>
												<script language="javascript" type="text/javascript">
				var imgPlus = new Image();
				var imgMinus = new Image();
				imgPlus.src = "../media/images/plus.png";
				imgMinus.src = "../media/images/minus.png";
				
				function showNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgMinus.src;
					oTable.style.display = "block";
				}
				
				function hideNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgPlus.src;
					oTable.style.display = "none";
				}
				
				function nodeIsVisible(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
									break;
							}
					return (oTable && oTable.style.display == "block");
				}
				
				function toggleNodeVisibility(Node){
					if (nodeIsVisible(Node)){
						hideNode(Node);
					}else{
						showNode(Node);
					}
				}
			</script>
					</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> SloodleUser</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A class to represent a single user, including Moodle and Sloodle data.</p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../sloodle/SloodleRequest.html">SloodleRequest</a> - Stores and processes user data incoming from an HTTP request</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_sloodle---lib---user.php.html">/sloodle/lib/user.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a31">31</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																								<div class="var-title">
					<img src="../media/images/PrivateVariable.png" alt=" " />
					<span class="var-type">object</span>
					<a href="#$avatar_data" title="details" class="var-name">$avatar_data</a>
				</div>
																<div class="var-title">
					<img src="../media/images/PrivateVariable.png" alt=" " />
					<span class="var-type">obejct</span>
					<a href="#$user_data" title="details" class="var-name">$user_data</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">object</span>
					<a href="#$_session" title="details" class="var-name">$_session</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																																																																																																																																																																							
				<div class="method-definition">
					<img src="../media/images/Constructor.png" alt=" "/>
											<span class="method-result">SloodleUser</span>
										<a href="#SloodleUser" title="details" class="method-name">SloodleUser</a>
											(<span class="var-type">object</span>&nbsp;<span class="var-name">&$_session</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#add_linked_avatar" title="details" class="method-name">add_linked_avatar</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$userid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">object|bool</span>
										<a href="#add_pending_avatar" title="details" class="method-name">add_pending_avatar</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string|bool</span>
										<a href="#autoregister_avatar_user" title="details" class="method-name">autoregister_avatar_user</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#delete_avatar" title="details" class="method-name">delete_avatar</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#enrol" title="details" class="method-name">enrol</a>
											([<span class="var-type">object</span>&nbsp;<span class="var-name">$sloodle_course</span> = <span class="var-default">null</span>], <span class="var-type">bool</span>&nbsp;<span class="var-name">1</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">mixed</span>
										<a href="#get_avatar_id" title="details" class="method-name">get_avatar_id</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">int</span>
										<a href="#get_avatar_last_active" title="details" class="method-name">get_avatar_last_active</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_avatar_name" title="details" class="method-name">get_avatar_name</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_avatar_uuid" title="details" class="method-name">get_avatar_uuid</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">array</span>
										<a href="#get_enrolled_courses" title="details" class="method-name">get_enrolled_courses</a>
											([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$category</span> = <span class="var-default">null</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">array</span>
										<a href="#get_staff_courses" title="details" class="method-name">get_staff_courses</a>
											([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$category</span> = <span class="var-default">null</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_username" title="details" class="method-name">get_username</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string|null</span>
										<a href="#get_user_email" title="details" class="method-name">get_user_email</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_user_firstname" title="details" class="method-name">get_user_firstname</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">mixed</span>
										<a href="#get_user_id" title="details" class="method-name">get_user_id</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_user_lastname" title="details" class="method-name">get_user_lastname</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#is_avatar_linked" title="details" class="method-name">is_avatar_linked</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#is_avatar_loaded" title="details" class="method-name">is_avatar_loaded</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#is_enrolled" title="details" class="method-name">is_enrolled</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$courseid</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$course</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">1</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#is_staff" title="details" class="method-name">is_staff</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$courseid</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$course</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">1</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#is_user_loaded" title="details" class="method-name">is_user_loaded</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#link_avatar" title="details" class="method-name">link_avatar</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#load_avatar" title="details" class="method-name">load_avatar</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#load_avatar_by_id" title="details" class="method-name">load_avatar_by_id</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool,string</span>
										<a href="#load_linked_avatar" title="details" class="method-name">load_linked_avatar</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#load_linked_user" title="details" class="method-name">load_linked_user</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#load_user" title="details" class="method-name">load_user</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#login" title="details" class="method-name">login</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#purge_password_notifications" title="details" class="method-name">purge_password_notifications</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string|bool</span>
										<a href="#reset_password" title="details" class="method-name">reset_password</a>
											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_avatar_last_active" title="details" class="method-name">set_avatar_last_active</a>
											([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_avatar_name" title="details" class="method-name">set_avatar_name</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_avatar_uuid" title="details" class="method-name">set_avatar_uuid</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#write_avatar" title="details" class="method-name">write_avatar</a>
										()
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$avatar_data" id="$avatar_data"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/PrivateVariable.png" />
		<span class="var-title">
			<span class="var-type">object</span>
			<span class="var-name">$avatar_data</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a49">49</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Internal only - avatar data.</p>
<p class="description"><p>In Moodle, corresponds to a record from the 'sloodle_users' table.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
</div>
<a name="var$user_data" id="$user_data"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/PrivateVariable.png" />
		<span class="var-title">
			<span class="var-type">obejct</span>
			<span class="var-name">$user_data</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a57">57</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Internal only - user data. (i.e. VLE user)  In Moodle, corresponds to a record from the 'user' table.</p>
	<ul class="tags">
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
</div>
<a name="var$_session" id="$_session"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">object</span>
			<span class="var-name">$_session</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a41">41</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Internal only - reference to the containing <a href="../sloodle/SloodleSession.html">SloodleSession</a> object.</p>
<p class="description"><p>Note: always check that it is not null before use!</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
</div>

						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodSloodleUser" id="SloodleUser"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor SloodleUser</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a67">67</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class constructor.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">SloodleUser</span>
		<span class="method-name">
			SloodleUser
		</span>
					(<span class="var-type">object</span>&nbsp;<span class="var-name">&$_session</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">object</span>
				<span class="var-name">&$_session</span><span class="var-description">: Reference to the containing <a href="../sloodle/SloodleSession.html">SloodleSession</a> object, if available.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodadd_linked_avatar" id="add_linked_avatar"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">add_linked_avatar</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a359">359</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a new avatar to the database, and link it to the specified user.</p>
<p class="description"><p>If successful, it deletes any matching avatar details from pending users list.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false if not.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			add_linked_avatar
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$userid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$userid</span><span class="var-description">: Site-wide unique ID of a user (type depends on VLE; integer for Moodle)</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$uuid</span><span class="var-description">: UUID of the avatar</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$avname</span><span class="var-description">: Name of the avatar</span>			</li>
				</ul>
		
			
	</div>
<a name="methodadd_pending_avatar" id="add_pending_avatar"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">add_pending_avatar</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a389">389</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a new unlinked avatar to the database (the entry is pending linking)</p>
	<ul class="tags">
				<li><span class="field">return:</span> Returns the database object if successul, or false if not.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object|bool</span>
		<span class="method-name">
			add_pending_avatar
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$uuid</span><span class="var-description">: UUID of the avatar</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$avname</span><span class="var-description">: Name of the avatar</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$timestamp</span><span class="var-description">: The timestamp at which to mark the update (or null to use the current timestamp). Entries expire after a certain period.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodautoregister_avatar_user" id="autoregister_avatar_user"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">autoregister_avatar_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a419">419</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Auto-register a new user account for the current avatar.</p>
<p class="description"><p>NOTE: this does NOT respect ANYTHING but the most basic Moodle accounts.  Use at your own risk!</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The new password (plaintext) if successful, or false if not</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|bool</span>
		<span class="method-name">
			autoregister_avatar_user
		</span>
				()
			</div>
	
		
	</div>
<a name="methoddelete_avatar" id="delete_avatar"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">delete_avatar</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a256">256</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes the current avatar from the database.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false on failure</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			delete_avatar
		</span>
				()
			</div>
	
		
	</div>
<a name="methodenrol" id="enrol"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">enrol</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a671">671</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enrols the current user in the specified course</p>
<p class="description"><p>NOTE: a side effect of this is that it logs-in the user</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			enrol
		</span>
					([<span class="var-type">object</span>&nbsp;<span class="var-name">$sloodle_course</span> = <span class="var-default">null</span>], <span class="var-type">bool</span>&nbsp;<span class="var-name">1</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">object</span>
				<span class="var-name">$sloodle_course</span><span class="var-description">: A <a href="../sloodle/SloodleCourse.html">SloodleCourse</a> object setup for the necessary course. If null, then the <a href="../sloodle/SloodleUser.html#var$_session">$_session</a> member is queried instead.</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">1</span><span class="var-description">: True if successful (or the user was already enrolled), or false otherwise</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_avatar_id" id="get_avatar_id"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_avatar_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a80">80</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the unique ID of the avatar.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Type depends on VLE. (Integer on Moodle). Returns null if there is no avatar.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			get_avatar_id
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_avatar_last_active" id="get_avatar_last_active"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_avatar_last_active</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a185">185</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the timestamp of whenever the avatar was last active</p>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			get_avatar_last_active
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_avatar_name" id="get_avatar_name"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_avatar_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a139">139</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the name of the avatar</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_avatar_name
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_avatar_uuid" id="get_avatar_uuid"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_avatar_uuid</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a120">120</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the UUID of the avatar</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_avatar_uuid
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_enrolled_courses" id="get_enrolled_courses"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_enrolled_courses</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a551">551</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets a numeric array of <a href="../sloodle/SloodleCourse.html">SloodleCourse</a> objects for courses the user is enrolled in.</p>
<p class="description"><p>WARNING: this function is not very efficient, and will likely be very slow on large sites.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A numeric array of <a href="../sloodle/SloodleCourse.html">SloodleCourse</a> objects</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			get_enrolled_courses
		</span>
					([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$category</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$category</span><span class="var-description">: Unique identifier of a category to limit the query to. Ignored if null. (Type depends on VLE; integer for Moodle)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_staff_courses" id="get_staff_courses"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_staff_courses</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a588">588</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets a numeric array of <a href="../sloodle/SloodleCourse.html">SloodleCourse</a> objects for courses the user is Sloodle staff.</p>
<p class="description"><p>This relates to the &quot;mod/sloodle:staff&quot; capability.  WARNING: this function is not very efficient, and will likely be very slow on large sites.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A numeric array of <a href="../sloodle/SloodleCourse.html">SloodleCourse</a> objects</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			get_staff_courses
		</span>
					([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$category</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$category</span><span class="var-description">: Unique identifier of a category to limit the query to. Ignored if null. (Type depends on VLE; integer for Moodle)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_username" id="get_username"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_username</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a158">158</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the user's username</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_username
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_user_email" id="get_user_email"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_user_email</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a205">205</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the user's email address.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The user's email address, or null if none is specified of if email is disabled.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|null</span>
		<span class="method-name">
			get_user_email
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_user_firstname" id="get_user_firstname"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_user_firstname</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a167">167</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the first name of the user</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_user_firstname
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_user_id" id="get_user_id"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_user_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a91">91</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the unique ID of the VLE user.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Type depends on VLE. (Integer on Moodle). Returns null if there is no user</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			get_user_id
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_user_lastname" id="get_user_lastname"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_user_lastname</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a176">176</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the last name of the user</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_user_lastname
		</span>
				()
			</div>
	
		
	</div>
<a name="methodis_avatar_linked" id="is_avatar_linked"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">is_avatar_linked</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a219">219</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not the current user and avatar are linked.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if they are linked, or false if not.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			is_avatar_linked
		</span>
				()
			</div>
	
		
	</div>
<a name="methodis_avatar_loaded" id="is_avatar_loaded"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">is_avatar_loaded</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a101">101</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not an avatar is loaded.</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			is_avatar_loaded
		</span>
				()
			</div>
	
		
	</div>
<a name="methodis_enrolled" id="is_enrolled"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">is_enrolled</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a621">621</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is the current user enrolled in the specified course?</p>
<p class="description"><p>NOTE: a side effect of this is that it logs-in the user</p></p>
	<ul class="tags">
				<li><span class="field">todo:</span> Update to match parameter format and handling of <a href="../sloodle/SloodleUser.html#methodenrol">enrol()</a> function.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			is_enrolled
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$courseid</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$course</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">1</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$course</span><span class="var-description">: Unique identifier of the course -- type depends on VLE (integer for Moodle)</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">1</span><span class="var-description">: True if the user is enrolled, or false if not.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$courseid</span>			</li>
				</ul>
		
			
	</div>
<a name="methodis_staff" id="is_staff"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">is_staff</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a647">647</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is the current user Sloodle staff in the specified course?</p>
<p class="description"><p>NOTE: a side effect of this is that it logs-in the user</p></p>
	<ul class="tags">
				<li><span class="field">todo:</span> Update to match parameter format and handling of <a href="../sloodle/SloodleUser.html#methodenrol">enrol()</a> function.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			is_staff
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$courseid</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$course</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">1</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$course</span><span class="var-description">: Unique identifier of the course -- type depends on VLE (integer for Moodle)</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">1</span><span class="var-description">: True if the user is staff, or false if not.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$courseid</span>			</li>
				</ul>
		
			
	</div>
<a name="methodis_user_loaded" id="is_user_loaded"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">is_user_loaded</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a110">110</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not a VLE user is loaded.</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			is_user_loaded
		</span>
				()
			</div>
	
		
	</div>
<a name="methodlink_avatar" id="link_avatar"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">link_avatar</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a234">234</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Links the current avatar to the current user.</p>
<p class="description"><p><strong>NOTE:</strong> does not remove any other avatar links to the VLE user.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful or false otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			link_avatar
		</span>
				()
			</div>
	
		
	</div>
<a name="methodload_avatar" id="load_avatar"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">load_avatar</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a292">292</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Finds an avatar with the given UUID and/or name, and loads its data.</p>
<p class="description"><p>The UUID is searched for first. If that is not found, then the name is used.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false otherwise</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			load_avatar
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$uuid</span><span class="var-description">: The UUID of the avatar, or blank to search only by name.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$avname</span><span class="var-description">: The name of the avatar, or blank to search only by UUID.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodload_avatar_by_id" id="load_avatar_by_id"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">load_avatar_by_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a271">271</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads the specified avatar from the database.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			load_avatar_by_id
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$id</span><span class="var-description">: The ID of the avatar (type depends on VLE; integer for Moodle)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodload_linked_avatar" id="load_linked_avatar"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">load_linked_avatar</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a489">489</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Load the avatar linked to the current user.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if a link was loaded, false if there was no link, or string 'multi' if multiple avatars are linked</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool,string</span>
		<span class="method-name">
			load_linked_avatar
		</span>
				()
			</div>
	
		
	</div>
<a name="methodload_linked_user" id="load_linked_user"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">load_linked_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a511">511</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Find the VLE user linked to the current avatar.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false if no link was found</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			load_linked_user
		</span>
				()
			</div>
	
		
	</div>
<a name="methodload_user" id="load_user"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">load_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a320">320</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Load the specified user from the database</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false on failure</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			load_user
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$id</span><span class="var-description">: The unique identifier for the VLE user. (Type depends on VLE; integer for Moodle)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlogin" id="login"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">login</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a532">532</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Internally 'log-in' the current user.</p>
<p class="description"><p>In Moodle, this just stores all the user data in the global $USER variable.  This function will not perform automatic registration.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			login
		</span>
				()
			</div>
	
		
	</div>
<a name="methodpurge_password_notifications" id="purge_password_notifications"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">purge_password_notifications</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a776">776</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">If the system is waiting to send a password notification to this user, then remove it</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			purge_password_notifications
		</span>
				()
			</div>
	
		
	</div>
<a name="methodreset_password" id="reset_password"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">reset_password</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a739">739</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Resets the user's password</p>
	<ul class="tags">
				<li><span class="field">return:</span> The new password if successful, or false otherwise (if $require was false).</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|bool</span>
		<span class="method-name">
			reset_password
		</span>
					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$require</span><span class="var-description">: If true, then the script will be terminated if the operation fails</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_avatar_last_active" id="set_avatar_last_active"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_avatar_last_active</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a195">195</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the timestamp of when the user was last active</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_avatar_last_active
		</span>
					([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$timestamp</span><span class="var-description">: A UNIX timestamp, or null to use the current time</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_avatar_name" id="set_avatar_name"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_avatar_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a149">149</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the name of the avatar</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_avatar_name
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$avname</span><span class="var-description">: The new avatar name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_avatar_uuid" id="set_avatar_uuid"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_avatar_uuid</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a130">130</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the UUID of the avatar</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_avatar_uuid
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$uuid</span><span class="var-description">: The new UUID</span>			</li>
				</ul>
		
			
	</div>
<a name="methodwrite_avatar" id="write_avatar"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">write_avatar</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibuser.php.html#a342">342</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Uses the current avatar data to update the database.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false if the update fails</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			write_avatar
		</span>
				()
			</div>
	
		
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Mon, 16 Jun 2008 15:57:04 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>