LDAPAccountManager/lam-web/developers/devel/phpdoc/profiles/_lib---profiles.inc.html

246 lines
8.3 KiB
HTML

<html>
<head>
<title>Docs for page profiles.inc</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">profiles</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_profiles.html" class="menu">class tree: profiles</a> ]
[ <a href="../elementindex_profiles.html" class="menu">index: profiles</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="../ric_INSTALL.html">INSTALL</a></p>
<p><a href="../ric_README.html">README</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_configuration.html">configuration</a><br />
<a href="../li_Help.html">Help</a><br />
<a href="../li_LDAP.html">LDAP</a><br />
<a href="../li_lib.html">lib</a><br />
<a href="../li_lists.html">lists</a><br />
<a href="../li_main.html">main</a><br />
<a href="../li_modules.html">modules</a><br />
<a href="../li_PDF.html">PDF</a><br />
<a href="../li_profiles.html">profiles</a><br />
<a href="../li_selfService.html">selfService</a><br />
<a href="../li_tests.html">tests</a><br />
<a href="../li_tools.html">tools</a><br />
<a href="../li_types.html">types</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../profiles/_templates---profedit---profiledelete.php.html"> profiledelete.php
</a><br>
<a href="../profiles/_templates---profedit---profilemain.php.html"> profilemain.php
</a><br>
<a href="../profiles/_templates---profedit---profilepage.php.html"> profilepage.php
</a><br>
<a href="../profiles/_lib---profiles.inc.html"> profiles.inc
</a><br>
</div><br />
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Procedural File: profiles.inc</h1>
Source Location: /lib/profiles.inc<br /><br />
<br>
<br>
<h2>Page Details:</h2>
This file provides functions to load and save account profiles.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Roland Gruber</td>
</tr>
</table>
</div>
<br /><br />
<br /><br />
<br /><br />
<br />
<hr />
<a name="functiondelAccountProfile"></a>
<h3>delAccountProfile <span class="smalllinenumber">[line 147]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean delAccountProfile(
string $file, string $scope)</code>
</td></tr></table>
</td></tr></table><br />
Deletes an account profile<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>true if profile was deleted</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>name of profile (Without .&lt;scope&gt; extension)</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$scope</b>&nbsp;&nbsp;</td>
<td>account type</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiongetAccountProfiles"></a>
<h3>getAccountProfiles <span class="smalllinenumber">[line 38]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getAccountProfiles(
string $scope)</code>
</td></tr></table>
</td></tr></table><br />
Returns an array of string with all available profiles for the given account type<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>profile names</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$scope</b>&nbsp;&nbsp;</td>
<td>account type</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionloadAccountProfile"></a>
<h3>loadAccountProfile <span class="smalllinenumber">[line 66]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array loadAccountProfile(
string $profile, string $scope)</code>
</td></tr></table>
</td></tr></table><br />
Loads an profile of the given account type<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>hash array (attribute =&gt; value)</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$profile</b>&nbsp;&nbsp;</td>
<td>name of the profile (without .&lt;scope&gt; extension)</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$scope</b>&nbsp;&nbsp;</td>
<td>account type</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionsaveAccountProfile"></a>
<h3>saveAccountProfile <span class="smalllinenumber">[line 110]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean saveAccountProfile(
array $attributes, string $profile, string $scope)</code>
</td></tr></table>
</td></tr></table><br />
Saves an hash array (attribute =&gt; value) to an account profile<br /><br /><p>file is created, if needed</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>true, if saving succeeded</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$profile</b>&nbsp;&nbsp;</td>
<td>name of the account profile (without .&lt;scope&gt; extension)</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$attributes</b>&nbsp;&nbsp;</td>
<td>hash array (attribute =&gt; value)</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$scope</b>&nbsp;&nbsp;</td>
<td>account type</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<div class="credit">
<hr />
Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>