MaketRandevu/doc/code/php/class-Roles_Model.html

283 lines
5.7 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Roles_Model</title>
<script type="text/javascript" src="resources/combined.js?955602237"></script>
<script type="text/javascript" src="elementlist.js?679583101"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Admins_Model.html">Admins_Model</a></li>
<li><a href="class-Appointments.html">Appointments</a></li>
<li><a href="class-Appointments_Model.html">Appointments_Model</a></li>
<li><a href="class-Backend.html">Backend</a></li>
<li><a href="class-Backend_api.html">Backend_api</a></li>
<li><a href="class-Customers_Model.html">Customers_Model</a></li>
<li><a href="class-Errors.html">Errors</a></li>
<li><a href="class-Google.html">Google</a></li>
<li><a href="class-Providers_Model.html">Providers_Model</a></li>
<li class="active"><a href="class-Roles_Model.html">Roles_Model</a></li>
<li><a href="class-Secretaries_Model.html">Secretaries_Model</a></li>
<li><a href="class-Services_Model.html">Services_Model</a></li>
<li><a href="class-Settings_Model.html">Settings_Model</a></li>
<li><a href="class-Test.html">Test</a></li>
<li><a href="class-User.html">User</a></li>
<li><a href="class-User_Model.html">User_Model</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Roles_Model</h1>
<dl class="tree">
<dd style="padding-left:0px">
CI_Model
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Roles_Model</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Roles_Model.html#3-70" title="Go to source code">roles_model.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Roles_Model.html#4-9" title="Go to source code">__construct</a>( )</code>
<div class="description short">
<p>Class Constructor</p>
</div>
<div class="description detailed hidden">
<p>Class Constructor</p>
</div>
</div></td>
</tr>
<tr data-order="get_role_id" id="_get_role_id">
<td class="attributes"><code>
public
integer
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_role_id">#</a>
<code><a href="source-class-Roles_Model.html#11-20" title="Go to source code">get_role_id</a>( <span>string <var>$role_slug</var></span> )</code>
<div class="description short">
<p>Get the record id of a particular role.</p>
</div>
<div class="description detailed hidden">
<p>Get the record id of a particular role.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$role_slug</var></dt>
<dd><code>string</code><br>$role_slug The selected role slug. Slugs are defined in the
"application/config/constants.php" file.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>integer</code><br>Returns the database id of the roles record.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="get_privileges" id="_get_privileges">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_privileges">#</a>
<code><a href="source-class-Roles_Model.html#22-69" title="Go to source code">get_privileges</a>( <span>string <var>$slug</var></span> )</code>
<div class="description short">
<p>Returns all the privileges (bool values) of a role slug.</p>
</div>
<div class="description detailed hidden">
<p>Returns all the privileges (bool values) of a role slug.</p>
<p>The privilege numbers are converted into bool values of the four main actions
(view, add, edit, delete). By checking each value you can know if the user is
able to perform this action.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$slug</var></dt>
<dd><code>string</code><br>$slug The role slug.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>Returns the privilege value.<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>