mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-12-29 18:12:48 +03:00
Code Issues Projects Releases Packages Wiki Activity
easyappointments/doc/code/php/source-class-Settings_Model.html
Alex Tselegidis d256c0823e Replaced phpdoc with apigen
2015-01-28 23:56:57 +01:00

267 lines
24 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="robots" content="noindex">
<title>File settings_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><span id="2" class="l"><a href="#2"> 2 </a><span class="php-keyword1">class</span> Settings_Model <span class="php-keyword1">extends</span> CI_Model {
</span><span id="3" class="l"><a href="#3"> 3 </a> <span class="php-comment">/**
</span></span><span id="4" class="l"><a href="#4"> 4 </a><span class="php-comment"> * Class Constructor
</span></span><span id="5" class="l"><a href="#5"> 5 </a><span class="php-comment"> */</span>
</span><span id="6" class="l"><a href="#6"> 6 </a> <span class="php-keyword1">function</span> __construct() {
</span><span id="7" class="l"><a href="#7"> 7 </a> parent::__construct();
</span><span id="8" class="l"><a href="#8"> 8 </a> }
</span><span id="9" class="l"><a href="#9"> 9 </a>
</span><span id="10" class="l"><a href="#10"> 10 </a> <span class="php-comment">/**
</span></span><span id="11" class="l"><a href="#11"> 11 </a><span class="php-comment"> * Get setting value from database.
</span></span><span id="12" class="l"><a href="#12"> 12 </a><span class="php-comment"> *
</span></span><span id="13" class="l"><a href="#13"> 13 </a><span class="php-comment"> * This method returns a system setting from the
</span></span><span id="14" class="l"><a href="#14"> 14 </a><span class="php-comment"> * database.
</span></span><span id="15" class="l"><a href="#15"> 15 </a><span class="php-comment"> *
</span></span><span id="16" class="l"><a href="#16"> 16 </a><span class="php-comment"> * @expectedException Exception
</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-comment"> * @param string $name The database setting name.
</span></span><span id="19" class="l"><a href="#19"> 19 </a><span class="php-comment"> * @return string Returns the database value for
</span></span><span id="20" class="l"><a href="#20"> 20 </a><span class="php-comment"> * the selected setting.
</span></span><span id="21" class="l"><a href="#21"> 21 </a><span class="php-comment"> */</span>
</span><span id="22" class="l"><a href="#22"> 22 </a> <span class="php-keyword1">function</span> get_setting(<span class="php-var">$name</span>) {
</span><span id="23" class="l"><a href="#23"> 23 </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_string</span>(<span class="php-var">$name</span>)) { <span class="php-comment">// Check argument type.</span>
</span><span id="24" class="l"><a href="#24"> 24 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'$name argument is not a string : '</span> . <span class="php-var">$name</span>);
</span><span id="25" class="l"><a href="#25"> 25 </a> }
</span><span id="26" class="l"><a href="#26"> 26 </a>
</span><span id="27" class="l"><a href="#27"> 27 </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> =&gt; <span class="php-var">$name</span>))-&gt;num_rows() == <span class="php-num">0</span>) { <span class="php-comment">// Check if setting exists in db.</span>
</span><span id="28" class="l"><a href="#28"> 28 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'$name setting does not exist in database : '</span> . <span class="php-var">$name</span>);
</span><span id="29" class="l"><a href="#29"> 29 </a> }
</span><span id="30" class="l"><a href="#30"> 30 </a>
</span><span id="31" class="l"><a href="#31"> 31 </a> <span class="php-var">$query</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> =&gt; <span class="php-var">$name</span>));
</span><span id="32" class="l"><a href="#32"> 32 </a> <span class="php-var">$setting</span> = (<span class="php-var">$query</span>-&gt;num_rows() &gt; <span class="php-num">0</span>) ? <span class="php-var">$query</span>-&gt;row() : <span class="php-quote">''</span>;
</span><span id="33" class="l"><a href="#33"> 33 </a> <span class="php-keyword1">return</span> <span class="php-var">$setting</span>-&gt;value;
</span><span id="34" class="l"><a href="#34"> 34 </a> }
</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">/**
</span></span><span id="37" class="l"><a href="#37"> 37 </a><span class="php-comment"> * This method sets the value for a specific setting
</span></span><span id="38" class="l"><a href="#38"> 38 </a><span class="php-comment"> * on the database. If the setting doesn't exist, it
</span></span><span id="39" class="l"><a href="#39"> 39 </a><span class="php-comment"> * is going to be created, otherwise updated.
</span></span><span id="40" class="l"><a href="#40"> 40 </a><span class="php-comment"> *
</span></span><span id="41" class="l"><a href="#41"> 41 </a><span class="php-comment"> * @expectedException Exception
</span></span><span id="42" class="l"><a href="#42"> 42 </a><span class="php-comment"> *
</span></span><span id="43" class="l"><a href="#43"> 43 </a><span class="php-comment"> * @param string $name The setting name.
</span></span><span id="44" class="l"><a href="#44"> 44 </a><span class="php-comment"> * @param type $value The setting value.
</span></span><span id="45" class="l"><a href="#45"> 45 </a><span class="php-comment"> * @return int Returns the setting database id.
</span></span><span id="46" class="l"><a href="#46"> 46 </a><span class="php-comment"> */</span>
</span><span id="47" class="l"><a href="#47"> 47 </a> <span class="php-keyword1">function</span> set_setting(<span class="php-var">$name</span>, <span class="php-var">$value</span>) {
</span><span id="48" class="l"><a href="#48"> 48 </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_string</span>(<span class="php-var">$name</span>)) {
</span><span id="49" class="l"><a href="#49"> 49 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'$name argument is not a string : '</span> . <span class="php-var">$name</span>);
</span><span id="50" class="l"><a href="#50"> 50 </a> }
</span><span id="51" class="l"><a href="#51"> 51 </a>
</span><span id="52" class="l"><a href="#52"> 52 </a> <span class="php-var">$query</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> =&gt; <span class="php-var">$name</span>));
</span><span id="53" class="l"><a href="#53"> 53 </a> <span class="php-keyword1">if</span> (<span class="php-var">$query</span>-&gt;num_rows() &gt; <span class="php-num">0</span>) {
</span><span id="54" class="l"><a href="#54"> 54 </a> <span class="php-comment">// Update setting</span>
</span><span id="55" class="l"><a href="#55"> 55 </a> <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;db-&gt;update(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'value'</span> =&gt; <span class="php-var">$value</span>), <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> =&gt; <span class="php-var">$name</span>))) {
</span><span id="56" class="l"><a href="#56"> 56 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'Could not update database setting.'</span>);
</span><span id="57" class="l"><a href="#57"> 57 </a> }
</span><span id="58" class="l"><a href="#58"> 58 </a> <span class="php-var">$setting_id</span> = <span class="php-keyword2">intval</span>(<span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> =&gt; <span class="php-var">$name</span>))-&gt;row()-&gt;id);
</span><span id="59" class="l"><a href="#59"> 59 </a> } <span class="php-keyword1">else</span> {
</span><span id="60" class="l"><a href="#60"> 60 </a> <span class="php-comment">// Insert setting</span>
</span><span id="61" class="l"><a href="#61"> 61 </a> <span class="php-var">$insert_data</span> = <span class="php-keyword1">array</span>(
</span><span id="62" class="l"><a href="#62"> 62 </a> <span class="php-quote">'name'</span> =&gt; <span class="php-var">$name</span>,
</span><span id="63" class="l"><a href="#63"> 63 </a> <span class="php-quote">'value'</span> =&gt; <span class="php-var">$value</span>
</span><span id="64" class="l"><a href="#64"> 64 </a> );
</span><span id="65" class="l"><a href="#65"> 65 </a> <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;db-&gt;insert(<span class="php-quote">'ea_settings'</span>, <span class="php-var">$insert_data</span>)) {
</span><span id="66" class="l"><a href="#66"> 66 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'Could not insert database setting'</span>);
</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-var">$setting_id</span> = <span class="php-keyword2">intval</span>(<span class="php-var">$this</span>-&gt;db-&gt;insert_id());
</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 class="php-keyword1">return</span> <span class="php-var">$setting_id</span>;
</span><span id="72" class="l"><a href="#72"> 72 </a> }
</span><span id="73" class="l"><a href="#73"> 73 </a>
</span><span id="74" class="l"><a href="#74"> 74 </a> <span class="php-comment">/**
</span></span><span id="75" class="l"><a href="#75"> 75 </a><span class="php-comment"> * Remove a setting from the database.
</span></span><span id="76" class="l"><a href="#76"> 76 </a><span class="php-comment"> *
</span></span><span id="77" class="l"><a href="#77"> 77 </a><span class="php-comment"> * @expectedException Exception
</span></span><span id="78" class="l"><a href="#78"> 78 </a><span class="php-comment"> *
</span></span><span id="79" class="l"><a href="#79"> 79 </a><span class="php-comment"> * @param string $name The setting name to be removed.
</span></span><span id="80" class="l"><a href="#80"> 80 </a><span class="php-comment"> * @return bool Returns the delete operation result.
</span></span><span id="81" class="l"><a href="#81"> 81 </a><span class="php-comment"> */</span>
</span><span id="82" class="l"><a href="#82"> 82 </a> <span class="php-keyword1">function</span> remove_setting(<span class="php-var">$name</span>) {
</span><span id="83" class="l"><a href="#83"> 83 </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_string</span>(<span class="php-var">$name</span>)) {
</span><span id="84" class="l"><a href="#84"> 84 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'$name is not a string : '</span> . <span class="php-var">$name</span>);
</span><span id="85" class="l"><a href="#85"> 85 </a> }
</span><span id="86" class="l"><a href="#86"> 86 </a>
</span><span id="87" class="l"><a href="#87"> 87 </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> =&gt; <span class="php-var">$name</span>))-&gt;num_rows() == <span class="php-num">0</span>) {
</span><span id="88" class="l"><a href="#88"> 88 </a> <span class="php-keyword1">return</span> <span class="php-keyword1">FALSE</span>; <span class="php-comment">// There is no such setting.</span>
</span><span id="89" class="l"><a href="#89"> 89 </a> }
</span><span id="90" class="l"><a href="#90"> 90 </a>
</span><span id="91" class="l"><a href="#91"> 91 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;<span class="php-keyword2">delete</span>(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> =&gt; <span class="php-var">$name</span>));
</span><span id="92" class="l"><a href="#92"> 92 </a> }
</span><span id="93" class="l"><a href="#93"> 93 </a>
</span><span id="94" class="l"><a href="#94"> 94 </a> <span class="php-comment">/**
</span></span><span id="95" class="l"><a href="#95"> 95 </a><span class="php-comment"> * Saves all the system settings into the database.
</span></span><span id="96" class="l"><a href="#96"> 96 </a><span class="php-comment"> *
</span></span><span id="97" class="l"><a href="#97"> 97 </a><span class="php-comment"> * This method is usefull when trying to save all the system settings at once instead of
</span></span><span id="98" class="l"><a href="#98"> 98 </a><span class="php-comment"> * saving them one by one.
</span></span><span id="99" class="l"><a href="#99"> 99 </a><span class="php-comment"> *
</span></span><span id="100" class="l"><a href="#100">100 </a><span class="php-comment"> * @param array $settings Contains all the system settings.
</span></span><span id="101" class="l"><a href="#101">101 </a><span class="php-comment"> * @return bool Returns the save operation result.
</span></span><span id="102" class="l"><a href="#102">102 </a><span class="php-comment"> *
</span></span><span id="103" class="l"><a href="#103">103 </a><span class="php-comment"> * @throws Exception When the update operation won't work for a specific setting.
</span></span><span id="104" class="l"><a href="#104">104 </a><span class="php-comment"> */</span>
</span><span id="105" class="l"><a href="#105">105 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> save_settings(<span class="php-var">$settings</span>) {
</span><span id="106" class="l"><a href="#106">106 </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_array</span>(<span class="php-var">$settings</span>)) {
</span><span id="107" class="l"><a href="#107">107 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'$settings argument is invalid: '</span>. <span class="php-keyword2">print_r</span>(<span class="php-var">$settings</span>, <span class="php-keyword1">TRUE</span>));
</span><span id="108" class="l"><a href="#108">108 </a> }
</span><span id="109" class="l"><a href="#109">109 </a>
</span><span id="110" class="l"><a href="#110">110 </a> <span class="php-keyword1">foreach</span>(<span class="php-var">$settings</span> <span class="php-keyword1">as</span> <span class="php-var">$setting</span>) {
</span><span id="111" class="l"><a href="#111">111 </a> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-quote">'name'</span>, <span class="php-var">$setting</span>[<span class="php-quote">'name'</span>]);
</span><span id="112" class="l"><a href="#112">112 </a> <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;db-&gt;update(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'value'</span> =&gt; <span class="php-var">$setting</span>[<span class="php-quote">'value'</span>]))) {
</span><span id="113" class="l"><a href="#113">113 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'Could not save setting ('</span> . <span class="php-var">$setting</span>[<span class="php-quote">'name'</span>]
</span><span id="114" class="l"><a href="#114">114 </a> . <span class="php-quote">' - '</span> . <span class="php-var">$setting</span>[<span class="php-quote">'value'</span>] . <span class="php-quote">')'</span>);
</span><span id="115" class="l"><a href="#115">115 </a> }
</span><span id="116" class="l"><a href="#116">116 </a> }
</span><span id="117" class="l"><a href="#117">117 </a>
</span><span id="118" class="l"><a href="#118">118 </a> <span class="php-keyword1">return</span> <span class="php-keyword1">TRUE</span>;
</span><span id="119" class="l"><a href="#119">119 </a> }
</span><span id="120" class="l"><a href="#120">120 </a>
</span><span id="121" class="l"><a href="#121">121 </a> <span class="php-comment">/**
</span></span><span id="122" class="l"><a href="#122">122 </a><span class="php-comment"> * Returns all the system settings at once.
</span></span><span id="123" class="l"><a href="#123">123 </a><span class="php-comment"> *
</span></span><span id="124" class="l"><a href="#124">124 </a><span class="php-comment"> * @return array Array of all the system settings stored in the 'ea_settings' table.
</span></span><span id="125" class="l"><a href="#125">125 </a><span class="php-comment"> */</span>
</span><span id="126" class="l"><a href="#126">126 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> get_settings() {
</span><span id="127" class="l"><a href="#127">127 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get(<span class="php-quote">'ea_settings'</span>)-&gt;result_array();
</span><span id="128" class="l"><a href="#128">128 </a> }
</span><span id="129" class="l"><a href="#129">129 </a>}
</span><span id="130" class="l"><a href="#130">130 </a>
</span><span id="131" class="l"><a href="#131">131 </a><span class="php-comment">/* End of file settings_model.php */</span>
</span><span id="132" class="l"><a href="#132">132 </a><span class="php-comment">/* Location: ./application/models/settings_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>
Reference in a new issue View git blame Copy permalink