docs

silexlabs · Oct 10, 2013 · 1c599a8 · 1c599a8
1 parent c2fc8ce
commit 1c599a8
Show file tree

Hide file tree

Showing 544 changed files with 62,368 additions and 62,305 deletions.
diff --git a/doc/Amfphp/_Amfphp---index.php.html b/doc/Amfphp/_Amfphp---index.php.html
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+  <html xmlns="http://www.w3.org/1999/xhtml">
+		<head>
+			<!-- template designed by Marco Von Ballmoos -->
+			<title>Docs for page index.php</title>
+			<link rel="stylesheet" href="../media/stylesheet.css" />
+			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+		</head>
+		<body>
+			<div class="page-body">			
+<h2 class="file-name">/Amfphp/index.php</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+	<div class="info-box-title">Description</div>
+	<div class="nav-bar">
+					<span class="disabled">Description</span> |
+									<a href="#sec-includes">Includes</a>
+												</div>
+	<div class="info-box-body">	
+		<!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">This file is part of amfPHP</p>
+<p class="description"><p>LICENSE</p><p>This source file is subject to the license that is bundled  with this package in the file license.txt.</p></p>
+
+			</div>
+</div>
+
+
+	<a name="sec-includes"></a>	
+	<div class="info-box">
+		<div class="info-box-title">Includes</div>
+		<div class="nav-bar">
+			<a href="#sec-description">Description</a> |
+						<span class="disabled">Includes</span>
+														</div>
+		<div class="info-box-body">	
+			<a name="_dirname(__FILE__)_/ClassLoader_php"><!-- --></a>
+<div class="oddrow">
+
+	<div>
+		<span class="include-title">
+			<span class="include-type">require_once</span>
+			(<span class="include-name">dirname(__FILE__).'/ClassLoader.php'</span>)
+			(line <span class="line-number">15</span>)
+		</span>
+	</div>
+
+	<!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">includes</p>
+
+</div>
+		</div>
+	</div>
+
+
+
+
+	<p class="notes" id="credit">
+		Documentation generated on Thu, 10 Oct 2013 13:04:05 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
+	</p>
+	</div></body>
+</html>
diff --git a/doc/Amfphp_BackOffice_ClientGenerator/_BackOffice---ClientGenerator.php.html b/doc/Amfphp_BackOffice_ClientGenerator/_BackOffice---ClientGenerator.php.html
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+  <html xmlns="http://www.w3.org/1999/xhtml">
+		<head>
+			<!-- template designed by Marco Von Ballmoos -->
+			<title>Docs for page ClientGenerator.php</title>
+			<link rel="stylesheet" href="../media/stylesheet.css" />
+			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+		</head>
+		<body>
+			<div class="page-body">			
+<h2 class="file-name">/BackOffice/ClientGenerator.php</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+	<div class="info-box-title">Description</div>
+	<div class="nav-bar">
+					<span class="disabled">Description</span> |
+									<a href="#sec-includes">Includes</a>
+												</div>
+	<div class="info-box-body">	
+		<!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">This file is part of amfPHP</p>
+<p class="description"><p>LICENSE</p><p>This source file is subject to the license that is bundled  with this package in the file license.txt.</p></p>
+
+			</div>
+</div>
+
+
+	<a name="sec-includes"></a>	
+	<div class="info-box">
+		<div class="info-box-title">Includes</div>
+		<div class="nav-bar">
+			<a href="#sec-description">Description</a> |
+						<span class="disabled">Includes</span>
+														</div>
+		<div class="info-box-body">	
+			<a name="_dirname(__FILE__)_/ClassLoader_php"><!-- --></a>
+<div class="oddrow">
+
+	<div>
+		<span class="include-title">
+			<span class="include-type">require_once</span>
+			(<span class="include-name">dirname(__FILE__).'/ClassLoader.php'</span>)
+			(line <span class="line-number">14</span>)
+		</span>
+	</div>
+
+	<!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">includes</p>
+
+</div>
+<a name="_dirname(__FILE__)_/HtmlHeader_inc_php"><!-- --></a>
+<div class="evenrow">
+
+	<div>
+		<span class="include-title">
+			<span class="include-type">require_once</span>
+			(<span class="include-name">dirname(__FILE__).'/HtmlHeader.inc.php'</span>)
+			(line <span class="line-number">21</span>)
+		</span>
+	</div>
+
+	<!-- ========== Info from phpDoc block ========= -->
+
+</div>
+<a name="_dirname(__FILE__)_/LinkBar_inc_php"><!-- --></a>
+<div class="oddrow">
+
+	<div>
+		<span class="include-title">
+			<span class="include-type">require_once</span>
+			(<span class="include-name">dirname(__FILE__).'/LinkBar.inc.php'</span>)
+			(line <span class="line-number">24</span>)
+		</span>
+	</div>
+
+	<!-- ========== Info from phpDoc block ========= -->
+
+</div>
+<a name="_dirname(__FILE__)_/MainMenu_inc_php"><!-- --></a>
+<div class="evenrow">
+
+	<div>
+		<span class="include-title">
+			<span class="include-type">require_once</span>
+			(<span class="include-name">dirname(__FILE__).'/MainMenu.inc.php'</span>)
+			(line <span class="line-number">38</span>)
+		</span>
+	</div>
+
+	<!-- ========== Info from phpDoc block ========= -->
+
+</div>
+		</div>
+	</div>
+
+
+
+
+	<p class="notes" id="credit">
+		Documentation generated on Thu, 10 Oct 2013 13:04:03 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
+	</p>
+	</div></body>
+</html>
diff --git a/doc/Amfphp_Backoffice/Amfphp_BackOffice_AccessManager.html b/doc/Amfphp_Backoffice/Amfphp_BackOffice_AccessManager.html
@@ -0,0 +1,186 @@
+<?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 Amfphp_BackOffice_AccessManager</title>
+			<link rel="stylesheet" href="../media/stylesheet.css" />
+			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+		</head>
+		<body>
+			<div class="page-body">			
+<h2 class="class-name">Class Amfphp_BackOffice_AccessManager</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
+
+			</div>
+	<div class="info-box-body">
+        		<!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">controls access to back office, along with SignIn, SignOut scripts</p>
+	<ul class="tags">
+				<li><span class="field">author:</span> Ariel Sommeria-klein</li>
+			</ul>
+		<p class="notes">
+			Located in <a class="field" href="_BackOffice---AccessManager.php.html">/BackOffice/AccessManager.php</a> (line <span class="field">21</span>)
+		</p>
+
+
+		<pre></pre>
+
+			</div>
+</div>
+
+
+	<a name="sec-const-summary"></a>
+	<div class="info-box">
+		<div class="info-box-title">Class Constant Summary</span></div>
+		<div class="nav-bar">
+			<a href="#sec-description">Description</a> |
+						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
+										| 
+									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+					</div>
+		<div class="info-box-body">
+			<div class="const-summary">
+								<div class="const-title">
+					<img src="../media/images/Constant.png" alt=" " />
+					<a href="#AMFPHP_ADMIN_ROLE" title="details" class="const-name">AMFPHP_ADMIN_ROLE</a> = 					<span class="var-type"> 'amfphp_admin'</span>
+
+				</div>
+								<div class="const-title">
+					<img src="../media/images/Constant.png" alt=" " />
+					<a href="#SESSION_FIELD_ROLES" title="details" class="const-name">SESSION_FIELD_ROLES</a> = 					<span class="var-type"> 'amfphp_roles'</span>
+
+				</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-const-summary">Constants</a> (<a href="#sec-consts">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">
+											<span class="method-result">void</span>
+										<a href="#isAccessGranted" title="details" class="method-name">isAccessGranted</a>
+										()
+									</div>
+								</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-const-summary">Constants</a> (<a href="#sec-consts">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="methodisAccessGranted" id="isAccessGranted"><!-- --></a>
+<div class="evenrow">
+
+	<div class="method-header">
+		<span class="method-title">isAccessGranted</span> (line <span class="line-number">33</span>)
+	</div> 
+
+	<!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">checks if access should be granted, either because no sign in is required, or because the user is actually signed in.</p>
+<p class="description"><p>note: must be called before output starts, as starting a session can change headers on some configs.</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">
+			isAccessGranted
+		</span>
+				()
+			</div>
+
+
+
+	</div>
+
+		</div>
+	</div>
+
+	<a name="sec-consts"></a>
+	<div class="info-box">
+		<div class="info-box-title">Class Constants</div>
+		<div class="nav-bar">
+			<a href="#sec-description">Description</a> |
+										<a href="#sec-var-summary">Constants</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="constAMFPHP_ADMIN_ROLE" id="AMFPHP_ADMIN_ROLE"><!-- --></A>
+<div class="oddrow">
+
+	<div class="const-header">
+		<img src="../media/images/Variable.png" />
+		<span class="const-title">
+			<span class="const-name">AMFPHP_ADMIN_ROLE</span>
+			 = <span class="const-default"> 'amfphp_admin'</span>
+			(line <span class="line-number">27</span>)
+		</span>
+	</div>
+
+	<!-- ========== Info from phpDoc block ========= -->
+
+
+</div>
+<a name="constSESSION_FIELD_ROLES" id="SESSION_FIELD_ROLES"><!-- --></A>
+<div class="evenrow">
+
+	<div class="const-header">
+		<img src="../media/images/Variable.png" />
+		<span class="const-title">
+			<span class="const-name">SESSION_FIELD_ROLES</span>
+			 = <span class="const-default"> 'amfphp_roles'</span>
+			(line <span class="line-number">26</span>)
+		</span>
+	</div>
+
+	<!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">the field in the session where the roles array is stored</p>
+
+
+</div>
+
+		</div>
+	</div>
+
+	<p class="notes" id="credit">
+		Documentation generated on Thu, 10 Oct 2013 13:03:57 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
+	</p>
+	</div></body>
+</html>