Ayuda_Virtual
/
sloodle_website


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672
							<?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 SloodleCourse</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"> SloodleCourse</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">The Sloodle course data class</p>
		<p class="notes">
			Located in <a class="field" href="_lib---course.php.html">/lib/course.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a25">25</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																								<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type"><a href="../sloodle/SloodleController.html">SloodleController</a></span>
					<a href="#$controller" title="details" class="var-name">$controller</a>
				</div>
																<div class="var-title">
					<img src="../media/images/PrivateVariable.png" alt=" " />
					<span class="var-type">object</span>
					<a href="#$course_object" title="details" class="var-name">$course_object</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">object</span>
					<a href="#$sloodle_course_data" title="details" class="var-name">$sloodle_course_data</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">SloodleCourse</span>
										<a href="#SloodleCourse" title="details" class="method-name">SloodleCourse</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#can_user_authorise_objects" title="details" class="method-name">can_user_authorise_objects</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#check_autoenrol" title="details" class="method-name">check_autoenrol</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#check_autoreg" title="details" class="method-name">check_autoreg</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#delete_layout" title="details" class="method-name">delete_layout</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#delete_loginzone_allocation" title="details" class="method-name">delete_loginzone_allocation</a>
											(<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#disable_autoenrol" title="details" class="method-name">disable_autoenrol</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#disable_autoreg" title="details" class="method-name">disable_autoreg</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#enable_autoenrol" title="details" class="method-name">enable_autoenrol</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#enable_autoreg" title="details" class="method-name">enable_autoreg</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string|false</span>
										<a href="#generate_loginzone_allocation" title="details" class="method-name">generate_loginzone_allocation</a>
											(<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#get_autoenrol" title="details" class="method-name">get_autoenrol</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#get_autoreg" title="details" class="method-name">get_autoreg</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">mixed</span>
										<a href="#get_course_id" title="details" class="method-name">get_course_id</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">mixed</span>
										<a href="#get_course_object" title="details" class="method-name">get_course_object</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_full_name" title="details" class="method-name">get_full_name</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#get_layout" title="details" class="method-name">get_layout</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$layoutid</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#get_layouts" title="details" class="method-name">get_layouts</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">array|bool</span>
										<a href="#get_layout_entries" title="details" class="method-name">get_layout_entries</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">array|bool</span>
										<a href="#get_layout_entries_for_layout_id" title="details" class="method-name">get_layout_entries_for_layout_id</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">array</span>
										<a href="#get_layout_names" title="details" class="method-name">get_layout_names</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string|bool</span>
										<a href="#get_loginzone_allocation" title="details" class="method-name">get_loginzone_allocation</a>
											(<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_loginzone_position" title="details" class="method-name">get_loginzone_position</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_loginzone_region" title="details" class="method-name">get_loginzone_region</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_loginzone_size" title="details" class="method-name">get_loginzone_size</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">int</span>
										<a href="#get_loginzone_time_updated" title="details" class="method-name">get_loginzone_time_updated</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_short_name" title="details" class="method-name">get_short_name</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#has_loginzone_data" title="details" class="method-name">has_loginzone_data</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#is_available" title="details" class="method-name">is_available</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#is_loaded" title="details" class="method-name">is_loaded</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#load" title="details" class="method-name">load</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$course</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#load_by_controller" title="details" class="method-name">load_by_controller</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$controllerid</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#load_user_by_loginzone" title="details" class="method-name">load_user_by_loginzone</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pos</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">&$user</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#save_layout" title="details" class="method-name">save_layout</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$entries</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$add</span> = <span class="var-default">false</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#save_layout_by_id" title="details" class="method-name">save_layout_by_id</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$entries</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$add</span> = <span class="var-default">false</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_loginzone_position" title="details" class="method-name">set_loginzone_position</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pos</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_loginzone_position_xyz" title="details" class="method-name">set_loginzone_position_xyz</a>
											(<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_loginzone_region" title="details" class="method-name">set_loginzone_region</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$region</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_loginzone_size" title="details" class="method-name">set_loginzone_size</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$size</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_loginzone_size_xyz" title="details" class="method-name">set_loginzone_size_xyz</a>
											(<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_loginzone_time_updated" title="details" class="method-name">set_loginzone_time_updated</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">bool</span>
										<a href="#write" title="details" class="method-name">write</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$controller" id="$controller"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type"><a href="../sloodle/SloodleController.html">SloodleController</a></span>
			<span class="var-name">$controller</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a51">51</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The <a href="../sloodle/SloodleController.html">SloodleController</a> object being used to access this course, if available.</p>
	
	
</div>
<a name="var$course_object" id="$course_object"><!-- --></A>
<div class="evenrow">

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

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The database object of the course to which this object relates.</p>
<p class="description"><p>Corresponds to the &quot;course&quot; table in Moodle.  Is null if not yet set</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
</div>
<a name="var$sloodle_course_data" id="$sloodle_course_data"><!-- --></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">$sloodle_course_data</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a44">44</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The Sloodle course data object, if it exists.</p>
<p class="description"><p>Is null if not yet set.</p></p>
	
	
</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="methodSloodleCourse" id="SloodleCourse"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor SloodleCourse</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a59">59</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
	
	<div class="method-signature">
		<span class="method-result">SloodleCourse</span>
		<span class="method-name">
			SloodleCourse
		</span>
				()
			</div>
	
		
	</div>
<a name="methodcan_user_authorise_objects" id="can_user_authorise_objects"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">can_user_authorise_objects</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a712">712</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether or not the CURRENTLY LOGGED-IN user can authorise objects on this course.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if the user has object authorisation permission, or false otherwise.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			can_user_authorise_objects
		</span>
				()
			</div>
	
		
	</div>
<a name="methodcheck_autoenrol" id="check_autoenrol"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">check_autoenrol</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a161">161</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is auto enrolment permitted on this site AND course?  Takes into account the site-wide setting as well.</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			check_autoenrol
		</span>
				()
			</div>
	
		
	</div>
<a name="methodcheck_autoreg" id="check_autoreg"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">check_autoreg</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a118">118</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is auto registration permitted on this site AND course?  Takes into account the site-wide setting as well.</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			check_autoreg
		</span>
				()
			</div>
	
		
	</div>
<a name="methoddelete_layout" id="delete_layout"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">delete_layout</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a602">602</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes the named layout.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			delete_layout
		</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 layout to delete</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddelete_loginzone_allocation" id="delete_loginzone_allocation"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">delete_loginzone_allocation</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a414">414</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes any loginzone allocations for the given user  If there are multiple for the same user (which there should never be) it will delete them all.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			delete_loginzone_allocation
		</span>
					(<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
				<span class="var-name">$user</span><span class="var-description">: The user whose allocation is to be deleted</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddisable_autoenrol" id="disable_autoenrol"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">disable_autoenrol</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a192">192</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Disables auto-enrolment for this course.</p>
<p class="description"><p>NOTE: does not affect the site setting.</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			disable_autoenrol
		</span>
				()
			</div>
	
		
	</div>
<a name="methoddisable_autoreg" id="disable_autoreg"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">disable_autoreg</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a149">149</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Disables auto-registration for this course.</p>
<p class="description"><p>NOTE: does not affect the site setting.</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			disable_autoreg
		</span>
				()
			</div>
	
		
	</div>
<a name="methodenable_autoenrol" id="enable_autoenrol"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">enable_autoenrol</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a182">182</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enables auto-enrolment for this course.</p>
<p class="description"><p>NOTE: it may still be disabled at site-level.</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			enable_autoenrol
		</span>
				()
			</div>
	
		
	</div>
<a name="methodenable_autoreg" id="enable_autoreg"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">enable_autoreg</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a139">139</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enables auto-registration for this course.</p>
<p class="description"><p>NOTE: it may still be disabled at site-level.</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			enable_autoreg
		</span>
				()
			</div>
	
		
	</div>
<a name="methodgenerate_loginzone_allocation" id="generate_loginzone_allocation"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">generate_loginzone_allocation</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a330">330</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a new LoginZone allocation for the specified user.</p>
	<ul class="tags">
				<li><span class="field">return:</span> A SLurl for the allocation, or false if it was unsuccessful</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|false</span>
		<span class="method-name">
			generate_loginzone_allocation
		</span>
					(<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
				<span class="var-name">$user</span><span class="var-description">: The user for whom this allocation should be made</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_autoenrol" id="get_autoenrol"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_autoenrol</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a172">172</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the auto enrolment value for this course only.</p>
<p class="description"><p>(Ignores the site setting).</p></p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			get_autoenrol
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_autoreg" id="get_autoreg"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_autoreg</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a129">129</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the autoregistration value for this course only.</p>
<p class="description"><p>(Ignores the site setting).</p></p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			get_autoreg
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_course_id" id="get_course_id"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a78">78</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the identifier of the course in the VLE.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			get_course_id
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_course_object" id="get_course_object"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_course_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a89">89</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the VLE course object.</p>
<p class="description"><p>WARNING: this should only be used when ABSOLUTELY necessary.  The contents are specific to the VLE.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Type and content depends upon VLE. In Moodle, it is an object representing a record from the 'course' table.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			get_course_object
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_full_name" id="get_full_name"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_full_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a108">108</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the full name of this course in the VLE.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Fullname of this course.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_full_name
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_layout" id="get_layout"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_layout</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a701">701</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			get_layout
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$layoutid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$layoutid</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_layouts" id="get_layouts"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_layouts</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a583">583</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets SloodleLayout objects for all the layouts in the course.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			get_layouts
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_layout_entries" id="get_layout_entries"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_layout_entries</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a550">550</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets all the entries in the named layout.</p>
	<ul class="tags">
				<li><span class="field">return:</span> A numeric array of <a href="../sloodle/SloodleLayoutEntry.html">SloodleLayoutEntry</a> objects if successful, or false if the layout does not exist</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array|bool</span>
		<span class="method-name">
			get_layout_entries
		</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 layout to query</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_layout_entries_for_layout_id" id="get_layout_entries_for_layout_id"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_layout_entries_for_layout_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a564">564</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets all the entries in the named layout.</p>
	<ul class="tags">
				<li><span class="field">return:</span> A numeric array of <a href="../sloodle/SloodleLayoutEntry.html">SloodleLayoutEntry</a> objects if successful, or false if the layout does not exist</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array|bool</span>
		<span class="method-name">
			get_layout_entries_for_layout_id
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$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 layout to query</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_layout_names" id="get_layout_names"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_layout_names</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a530">530</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets an array associating layout ID's to names</p>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			get_layout_names
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_loginzone_allocation" id="get_loginzone_allocation"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_loginzone_allocation</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a370">370</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the SLurl for the specified user's loginzone alloation</p>
	<ul class="tags">
				<li><span class="field">return:</span> The SLurl string if successful, or false if the user has no allocation or the loginzone does not exist</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|bool</span>
		<span class="method-name">
			get_loginzone_allocation
		</span>
					(<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
				<span class="var-name">$user</span><span class="var-description">: The user whose allocation is to be retrieved</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_loginzone_position" id="get_loginzone_position"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_loginzone_position</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a217">217</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the position of the loginzone as a string vector &lt;x,y,z&gt;</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_loginzone_position
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_loginzone_region" id="get_loginzone_region"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_loginzone_region</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a285">285</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the region of the loginzone</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_loginzone_region
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_loginzone_size" id="get_loginzone_size"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_loginzone_size</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a251">251</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the size of the loginzone as a string vector &lt;x,y,z&gt;</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_loginzone_size
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_loginzone_time_updated" id="get_loginzone_time_updated"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_loginzone_time_updated</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a306">306</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the timestamp of the last time the loginzone was updated</p>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			get_loginzone_time_updated
		</span>
				()
			</div>
	
		
	</div>
<a name="methodget_short_name" id="get_short_name"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_short_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a99">99</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the short name of this course in the VLE.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Shortname of this course.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_short_name
		</span>
				()
			</div>
	
		
	</div>
<a name="methodhas_loginzone_data" id="has_loginzone_data"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">has_loginzone_data</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a423">423</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not LoginZone data exists for this course.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if there is complete data, or false otherwise</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			has_loginzone_data
		</span>
				()
			</div>
	
		
	</div>
<a name="methodis_available" id="is_available"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">is_available</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a204">204</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not the course is available.</p>
<p class="description"><p>Checks that the course has not been disabled or hidden etc..</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if the course is available</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			is_available
		</span>
				()
			</div>
	
		
	</div>
<a name="methodis_loaded" id="is_loaded"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">is_loaded</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a68">68</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether or not course data has been loaded.</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			is_loaded
		</span>
				()
			</div>
	
		
	</div>
<a name="methodload" id="load"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a437">437</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reads fresh data into the structure from the database.</p>
<p class="description"><p>Fetches Moodle and Sloodle data about the course specified.  If necessary, it creates a new Sloodle entry with default settings.  Returns true if successful, or false on failure.</p></p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			load
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$course</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$course</span><span class="var-description">: Either a unique course ID, or a course data object. If the former, then VLE course data is read from the database. Otherwise, the data object is used as-is.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodload_by_controller" id="load_by_controller"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">load_by_controller</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a490">490</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads course and controller data by the unqiue site-wide identifier of a Sloodle controller.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false on failure.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			load_by_controller
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$controllerid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$controllerid</span><span class="var-description">: The unique site-wide identifier for a Sloodle Controller. (For Moodle, an integer cmi)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodload_user_by_loginzone" id="load_user_by_loginzone"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">load_user_by_loginzone</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a393">393</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Finds the user identified by LoginZone allocation, and loads it into the given user object.</p>
<p class="description"><p>Note: does not delete the allocation.</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">
			load_user_by_loginzone
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pos</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">&$user</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pos</span><span class="var-description">: Absolute position vector (relative to sim, not to LoginZone)</span>			</li>
					<li>
				<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
				<span class="var-name">&$user</span><span class="var-description">: The user object which will be manipulated (by reference)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsave_layout" id="save_layout"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">save_layout</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a621">621</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Save the given entries in the named profile.</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">
			save_layout
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$entries</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$add</span> = <span class="var-default">false</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 layout to query</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$entries</span><span class="var-description">: A numeric array of <a href="../sloodle/SloodleLayoutEntry.html">SloodleLayoutEntry</a> objects to store</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$add</span><span class="var-description">: (Default: false) If true, then the entries will be added to the layout instead of replacing existing entries</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsave_layout_by_id" id="save_layout_by_id"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">save_layout_by_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a641">641</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Save the given entries in the profile specified by id.</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">
			save_layout_by_id
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$entries</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$add</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: The id of the layout to query. 0 to add a new layout.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: The new name of the layout.</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$entries</span><span class="var-description">: A numeric array of <a href="../sloodle/SloodleLayoutEntry.html">SloodleLayoutEntry</a> objects to store</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$add</span><span class="var-description">: (Default: false) If true, then the entries will be added to the layout instead of replacing existing entries</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_loginzone_position" id="set_loginzone_position"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_loginzone_position</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a229">229</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the position of the loginzone as a string vector &lt;x,y,z&gt;</p>
	<ul class="tags">
				<li><span class="field">todo:</span> Update to handle arrays as well</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_loginzone_position
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pos</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pos</span><span class="var-description">: A string position vector &lt;x,y,z&gt;</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_loginzone_position_xyz" id="set_loginzone_position_xyz"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_loginzone_position_xyz</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a241">241</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the position of the loginzone as a set of components</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_loginzone_position_xyz
		</span>
					(<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">float</span>
				<span class="var-name">$x</span>			</li>
					<li>
				<span class="var-type">float</span>
				<span class="var-name">$y</span>			</li>
					<li>
				<span class="var-type">float</span>
				<span class="var-name">$z</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_loginzone_region" id="set_loginzone_region"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_loginzone_region</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a296">296</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the region of the loginzone</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_loginzone_region
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$region</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$region</span><span class="var-description">: A string naming a region</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_loginzone_size" id="set_loginzone_size"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_loginzone_size</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a263">263</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the size of the loginzone as a string vector &lt;x,y,z&gt;</p>
	<ul class="tags">
				<li><span class="field">todo:</span> Update to handle arrays as well</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_loginzone_size
		</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">: A string size vector &lt;x,y,z&gt;</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_loginzone_size_xyz" id="set_loginzone_size_xyz"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_loginzone_size_xyz</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a275">275</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the size of the loginzone as a set of components</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_loginzone_size_xyz
		</span>
					(<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">float</span>
				<span class="var-name">$x</span>			</li>
					<li>
				<span class="var-type">float</span>
				<span class="var-name">$y</span>			</li>
					<li>
				<span class="var-type">float</span>
				<span class="var-name">$z</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_loginzone_time_updated" id="set_loginzone_time_updated"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_loginzone_time_updated</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a317">317</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the timestamp of the last time the loginzone was updated</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_loginzone_time_updated
		</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. If null, the current timestamp is used</span>			</li>
				</ul>
		
			
	</div>
<a name="methodwrite" id="write"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">write</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libcourse.php.html#a517">517</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Writes current Sloodle course data back to the database.</p>
<p class="description"><p>Requires that a course structure has already been retrieved.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if successful, or false on failure</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			write
		</span>
				()
			</div>
	
		
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Fri, 17 Jul 2009 11:01:13 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>