easyappointments/doc/code/php/source-class-Roles_Model.html

209 lines
15 KiB
HTML
Raw Normal View History

2015-01-29 00:56:57 +02:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="robots" content="noindex">
<title>File roles_model.php</title>
<link rel="stylesheet" href="resources/bootstrap.min.css?08b23951ef4599ca9cbf1f902d0e8290c9653ddd">
<link rel="stylesheet" href="resources/style.css?062e9e59e0b8c44fbaaded5b7ffc21f907b78669">
</head>
<body>
<div id="navigation" class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a href="index.html" class="brand">Overview</a>
<div class="nav-collapse">
<ul class="nav">
<li>
<a href="class-User_Model.html" title="Summary of User_Model"><span>Class</span></a>
</li>
<li class="divider-vertical"></li>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
<li>
<a href="todo.html" title="Todo list"><span>Todo</span></a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="left">
<div id="menu">
<form id="search" class="form-search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="search-query" placeholder="Search">
</form>
<div id="groups">
</div>
<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-Google_Sync.html">Google_Sync</a></li>
<li><a href="class-Notifications.html">Notifications</a></li>
<li><a href="class-Providers_Model.html">Providers_Model</a></li>
<li><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-Unit_tests.html">Unit_tests</a></li>
<li><a href="class-Unit_tests_admins_model.html">Unit_tests_admins_model</a></li>
<li><a href="class-Unit_tests_appointments_model.html">Unit_tests_appointments_model</a></li>
<li><a href="class-Unit_tests_customers_model.html">Unit_tests_customers_model</a></li>
<li><a href="class-Unit_tests_providers_model.html">Unit_tests_providers_model</a></li>
<li><a href="class-Unit_tests_secretaries_model.html">Unit_tests_secretaries_model</a></li>
<li><a href="class-Unit_tests_services_model.html">Unit_tests_services_model</a></li>
<li><a href="class-Unit_tests_settings_model.html">Unit_tests_settings_model</a></li>
<li><a href="class-User.html">User</a></li>
<li class="active"><a href="class-User_Model.html">User_Model</a></li>
</ul>
<h3>Interfaces</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-Google_Sync.html">Google_Sync</a></li>
<li><a href="class-Notifications.html">Notifications</a></li>
<li><a href="class-Providers_Model.html">Providers_Model</a></li>
<li><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-Unit_tests.html">Unit_tests</a></li>
<li><a href="class-Unit_tests_admins_model.html">Unit_tests_admins_model</a></li>
<li><a href="class-Unit_tests_appointments_model.html">Unit_tests_appointments_model</a></li>
<li><a href="class-Unit_tests_customers_model.html">Unit_tests_customers_model</a></li>
<li><a href="class-Unit_tests_providers_model.html">Unit_tests_providers_model</a></li>
<li><a href="class-Unit_tests_secretaries_model.html">Unit_tests_secretaries_model</a></li>
<li><a href="class-Unit_tests_services_model.html">Unit_tests_services_model</a></li>
<li><a href="class-Unit_tests_settings_model.html">Unit_tests_settings_model</a></li>
<li><a href="class-User.html">User</a></li>
<li class="active"><a href="class-User_Model.html">User_Model</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<pre id="source"><code><span id="1" class="l"><a href="#1"> 1 </a><span class="xlang">&lt;?php</span> <span class="php-keyword1">if</span> ( ! <span class="php-keyword2">defined</span>(<span class="php-quote">'BASEPATH'</span>)) <span class="php-keyword1">exit</span>(<span class="php-quote">'No direct script access allowed'</span>);
</span><span id="2" class="l"><a href="#2"> 2 </a>
</span><span id="3" class="l"><a href="#3"> 3 </a><span class="php-keyword1">class</span> Roles_Model <span class="php-keyword1">extends</span> CI_Model {
</span><span id="4" class="l"><a href="#4"> 4 </a> <span class="php-comment">/**
</span></span><span id="5" class="l"><a href="#5"> 5 </a><span class="php-comment"> * Class Constructor
</span></span><span id="6" class="l"><a href="#6"> 6 </a><span class="php-comment"> */</span>
</span><span id="7" class="l"><a href="#7"> 7 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> __construct() {
</span><span id="8" class="l"><a href="#8"> 8 </a> parent::__construct();
</span><span id="9" class="l"><a href="#9"> 9 </a> }
</span><span id="10" class="l"><a href="#10">10 </a>
</span><span id="11" class="l"><a href="#11">11 </a> <span class="php-comment">/**
</span></span><span id="12" class="l"><a href="#12">12 </a><span class="php-comment"> * Get the record id of a particular role.
</span></span><span id="13" class="l"><a href="#13">13 </a><span class="php-comment"> *
</span></span><span id="14" class="l"><a href="#14">14 </a><span class="php-comment"> * @param string $role_slug The selected role slug. Slugs are
</span></span><span id="15" class="l"><a href="#15">15 </a><span class="php-comment"> * defined in the &quot;application/config/constants.php&quot; file.
</span></span><span id="16" class="l"><a href="#16">16 </a><span class="php-comment"> * @return int Returns the database id of the roles record.
</span></span><span id="17" class="l"><a href="#17">17 </a><span class="php-comment"> */</span>
</span><span id="18" class="l"><a href="#18">18 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_role_id(<span class="php-var">$role_slug</span>) {
</span><span id="19" class="l"><a href="#19">19 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_roles'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'slug'</span> =&gt; <span class="php-var">$role_slug</span>))-&gt;row()-&gt;id;
</span><span id="20" class="l"><a href="#20">20 </a> }
</span><span id="21" class="l"><a href="#21">21 </a>
</span><span id="22" class="l"><a href="#22">22 </a> <span class="php-comment">/**
</span></span><span id="23" class="l"><a href="#23">23 </a><span class="php-comment"> * Returns all the privileges (bool values) of a role slug.
</span></span><span id="24" class="l"><a href="#24">24 </a><span class="php-comment"> *
</span></span><span id="25" class="l"><a href="#25">25 </a><span class="php-comment"> * The privilege numbers are converted into bool values of the four main actions (view,
</span></span><span id="26" class="l"><a href="#26">26 </a><span class="php-comment"> * add, edit, delete). By checking each value you can know if the user is able to perform
</span></span><span id="27" class="l"><a href="#27">27 </a><span class="php-comment"> * this action.
</span></span><span id="28" class="l"><a href="#28">28 </a><span class="php-comment"> *
</span></span><span id="29" class="l"><a href="#29">29 </a><span class="php-comment"> * @param string $slug The role slug.
</span></span><span id="30" class="l"><a href="#30">30 </a><span class="php-comment"> * @return array Returns the privilege value.
</span></span><span id="31" class="l"><a href="#31">31 </a><span class="php-comment"> */</span>
</span><span id="32" class="l"><a href="#32">32 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_privileges(<span class="php-var">$slug</span>) {
</span><span id="33" class="l"><a href="#33">33 </a> <span class="php-var">$privileges</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_roles'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'slug'</span> =&gt; <span class="php-var">$slug</span>))-&gt;row_array();
</span><span id="34" class="l"><a href="#34">34 </a> <span class="php-keyword1">unset</span>(<span class="php-var">$privileges</span>[<span class="php-quote">'id'</span>], <span class="php-var">$privileges</span>[<span class="php-quote">'name'</span>], <span class="php-var">$privileges</span>[<span class="php-quote">'slug'</span>], <span class="php-var">$privileges</span>[<span class="php-quote">'is_admin'</span>]);
</span><span id="35" class="l"><a href="#35">35 </a>
</span><span id="36" class="l"><a href="#36">36 </a> <span class="php-comment">// Convert the numeric values to bool so that is easier to check whether a </span>
</span><span id="37" class="l"><a href="#37">37 </a> <span class="php-comment">// user has the required privileges for a specific action.</span>
</span><span id="38" class="l"><a href="#38">38 </a> <span class="php-keyword1">foreach</span>(<span class="php-var">$privileges</span> <span class="php-keyword1">as</span> &amp;<span class="php-var">$value</span>) {
</span><span id="39" class="l"><a href="#39">39 </a> <span class="php-var">$privileges_number</span> = <span class="php-var">$value</span>;
</span><span id="40" class="l"><a href="#40">40 </a>
</span><span id="41" class="l"><a href="#41">41 </a> <span class="php-var">$value</span> = <span class="php-keyword1">array</span>(
</span><span id="42" class="l"><a href="#42">42 </a> <span class="php-quote">'view'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="43" class="l"><a href="#43">43 </a> <span class="php-quote">'add'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="44" class="l"><a href="#44">44 </a> <span class="php-quote">'edit'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="45" class="l"><a href="#45">45 </a> <span class="php-quote">'delete'</span> =&gt; <span class="php-keyword1">FALSE</span>
</span><span id="46" class="l"><a href="#46">46 </a> );
</span><span id="47" class="l"><a href="#47">47 </a>
</span><span id="48" class="l"><a href="#48">48 </a> <span class="php-keyword1">if</span> (<span class="php-var">$privileges_number</span> &gt; <span class="php-num">0</span>) {
</span><span id="49" class="l"><a href="#49">49 </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">intval</span>(<span class="php-var">$privileges_number</span> / PRIV_DELETE) == <span class="php-num">1</span>) {
</span><span id="50" class="l"><a href="#50">50 </a> <span class="php-var">$value</span>[<span class="php-quote">'delete'</span>] = <span class="php-keyword1">TRUE</span>;
</span><span id="51" class="l"><a href="#51">51 </a> <span class="php-var">$privileges_number</span> -= PRIV_DELETE;
</span><span id="52" class="l"><a href="#52">52 </a> }
</span><span id="53" class="l"><a href="#53">53 </a>
</span><span id="54" class="l"><a href="#54">54 </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">intval</span>(<span class="php-var">$privileges_number</span> / PRIV_EDIT) == <span class="php-num">1</span>) {
</span><span id="55" class="l"><a href="#55">55 </a> <span class="php-var">$value</span>[<span class="php-quote">'edit'</span>] = <span class="php-keyword1">TRUE</span>;
</span><span id="56" class="l"><a href="#56">56 </a> <span class="php-var">$privileges_number</span> -= PRIV_EDIT;
</span><span id="57" class="l"><a href="#57">57 </a> }
</span><span id="58" class="l"><a href="#58">58 </a>
</span><span id="59" class="l"><a href="#59">59 </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">intval</span>(<span class="php-var">$privileges_number</span> / PRIV_ADD) == <span class="php-num">1</span>) {
</span><span id="60" class="l"><a href="#60">60 </a> <span class="php-var">$value</span>[<span class="php-quote">'add'</span>] = <span class="php-keyword1">TRUE</span>;
</span><span id="61" class="l"><a href="#61">61 </a> <span class="php-var">$privileges_number</span> -= PRIV_ADD;
</span><span id="62" class="l"><a href="#62">62 </a> }
</span><span id="63" class="l"><a href="#63">63 </a>
</span><span id="64" class="l"><a href="#64">64 </a> <span class="php-var">$value</span>[<span class="php-quote">'view'</span>] = <span class="php-keyword1">TRUE</span>;
</span><span id="65" class="l"><a href="#65">65 </a> }
</span><span id="66" class="l"><a href="#66">66 </a> }
</span><span id="67" class="l"><a href="#67">67 </a>
</span><span id="68" class="l"><a href="#68">68 </a> <span class="php-keyword1">return</span> <span class="php-var">$privileges</span>;
</span><span id="69" class="l"><a href="#69">69 </a> }
</span><span id="70" class="l"><a href="#70">70 </a>}
</span><span id="71" class="l"><a href="#71">71 </a>
</span><span id="72" class="l"><a href="#72">72 </a><span class="php-comment">/* End of file roles_model.php */</span>
</span><span id="73" class="l"><a href="#73">73 </a><span class="php-comment">/* Location: ./application/models/roles_model.php */</span></span></code></pre>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
<script src="resources/combined.js?f939e946b443ea62a054aa3725d39c2c76589984"></script>
<script src="elementlist.js?a05e466e1afa263d862b4b123f836a0e07299ca2"></script>
</body>
</html>