altocompta/doc/developper/html/check__priv_8php.html

262 lines
12 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>phpcompta: /home/dany/developpement/phpcompta-dev/phpcompta/include/check_priv.php File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<div class="nav">
<a class="el" href="dir_000000.html">developpement</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000001.html">phpcompta-dev</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000002.html">phpcompta</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000006.html">include</a></div>
<h1>check_priv.php File Reference</h1>Tools for checking the security. <a href="#_details">More...</a>
<p>
<p>
<a href="check__priv_8php-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="check__priv_8php.html#a0">CheckJrn</a> ($p_dossier, $p_user, $p_jrn, $p_detail=False)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vérifie les acces d'un utilisateur sur un journal. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="check__priv_8php.html#a1">CheckAction</a> ($p_dossier, $p_login, $p_action_id)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if an user is allowed to do an action. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="check__priv_8php.html#a2">CheckIsAdmin</a> ($p_user)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if an user is an administrator. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="check__priv_8php.html#a3">CheckDossier</a> ($p_user, $p_dossier)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if an user has acces to a folder. <a href="#a3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Tools for checking the security.
<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>some of those tools are redundant with the class user and should be cleaned </dd></dl>
<p>
Definition in file <a class="el" href="check__priv_8php-source.html">check_priv.php</a>.<hr><h2>Function Documentation</h2>
<a class="anchor" name="a1"></a><!-- doxytag: member="check_priv.php::CheckAction" ref="a1" args="($p_dossier, $p_login, $p_action_id)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">CheckAction </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname" nowrap> <em>p_dossier</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>p_login</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>p_action_id</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Check if an user is allowed to do an action.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p_dossier</em>&nbsp;</td><td>dossier id </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p_login</em>&nbsp;</td><td>user's login </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p_action_id</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>0 no priv</li></ul>
</dd></dl>
<ul>
<li>1 priv granted</li></ul>
<p>
Definition at line <a class="el" href="check__priv_8php-source.html#l00146">146</a> of file <a class="el" href="check__priv_8php-source.html">check_priv.php</a>.
<p>
References <a class="el" href="impress__fiche_8php-source.html#l00026">$cn</a>, <a class="el" href="eub__be_8inc_8php-source.html#l00074">$Res</a>, <a class="el" href="check__priv_8php-source.html#l00167">CheckIsAdmin()</a>, <a class="el" href="postgres_8php-source.html#l00072">DbConnect()</a>, and <a class="el" href="postgres_8php-source.html#l00099">ExecSql()</a>. </td>
</tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="check_priv.php::CheckDossier" ref="a3" args="($p_user, $p_dossier)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">CheckDossier </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname" nowrap> <em>p_user</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>p_dossier</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Check if an user has acces to a folder.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>p_dossier</em>&nbsp;</td><td>concerned folder</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>1 if yes 0 if no</dd></dl>
<p>
Definition at line <a class="el" href="check__priv_8php-source.html#l00192">192</a> of file <a class="el" href="check__priv_8php-source.html">check_priv.php</a>.
<p>
References <a class="el" href="impress__fiche_8php-source.html#l00026">$cn</a>, <a class="el" href="facture_8inc_8php-source.html#l00082">$sql</a>, <a class="el" href="check__priv_8php-source.html#l00167">CheckIsAdmin()</a>, <a class="el" href="postgres_8php-source.html#l00222">CountSql()</a>, and <a class="el" href="postgres_8php-source.html#l00072">DbConnect()</a>. </td>
</tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="check_priv.php::CheckIsAdmin" ref="a2" args="($p_user)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">CheckIsAdmin </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>p_user</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Check if an user is an administrator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$p_user</em>&nbsp;</td><td>user login</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>0 if no</li></ul>
</dd></dl>
<ul>
<li>1 if yes</li></ul>
<p>
Definition at line <a class="el" href="check__priv_8php-source.html#l00167">167</a> of file <a class="el" href="check__priv_8php-source.html">check_priv.php</a>.
<p>
References <a class="el" href="impress__fiche_8php-source.html#l00026">$cn</a>, <a class="el" href="facture_8inc_8php-source.html#l00082">$sql</a>, <a class="el" href="postgres_8php-source.html#l00222">CountSql()</a>, and <a class="el" href="postgres_8php-source.html#l00072">DbConnect()</a>.
<p>
Referenced by <a class="el" href="check__priv_8php-source.html#l00146">CheckAction()</a>, <a class="el" href="check__priv_8php-source.html#l00192">CheckDossier()</a>, and <a class="el" href="check__priv_8php-source.html#l00046">CheckJrn()</a>. </td>
</tr>
</table>
<a class="anchor" name="a0"></a><!-- doxytag: member="check_priv.php::CheckJrn" ref="a0" args="($p_dossier, $p_user, $p_jrn, $p_detail=False)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">CheckJrn </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname" nowrap> <em>p_dossier</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>p_user</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>p_jrn</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>p_detail</em> = <code>False</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Vérifie les acces d'un utilisateur sur un journal.
<p>
parm :<ul>
<li>$p_dossier le dossier</li></ul>
<p>
$p_user le login user<ul>
<li>$p_jrn le journal gen :<ul>
<li>rien return:</li><li>0 pas d'acces</li></ul>
</li><li>1 Lecture</li><li>2 écriture</li></ul>
<p>
Definition at line <a class="el" href="check__priv_8php-source.html#l00046">46</a> of file <a class="el" href="check__priv_8php-source.html">check_priv.php</a>.
<p>
References <a class="el" href="impress__fiche_8php-source.html#l00026">$cn</a>, <a class="el" href="eub__be_8inc_8php-source.html#l00074">$Res</a>, <a class="el" href="setup_8php-source.html#l00403">$Res2</a>, <a class="el" href="check__priv_8php-source.html#l00167">CheckIsAdmin()</a>, <a class="el" href="postgres_8php-source.html#l00222">CountSql()</a>, <a class="el" href="postgres_8php-source.html#l00072">DbConnect()</a>, <a class="el" href="debug_8php-source.html#l00034">echo_debug()</a>, and <a class="el" href="postgres_8php-source.html#l00099">ExecSql()</a>.
<p>
Referenced by <a class="el" href="user__menu_8php-source.html#l00246">ShowMenuJrnUser()</a>. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 23 00:12:46 2006 for phpcompta by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
</body>
</html>