forked from mirrors/easyappointments
187 lines
18 KiB
HTML
187 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="ApiGen 2.8.0" />
|
|
<meta name="robots" content="noindex" />
|
|
|
|
<title>File settings_model.php</title>
|
|
|
|
<script type="text/javascript" src="resources/combined.js?955602237"></script>
|
|
<script type="text/javascript" src="elementlist.js?815896003"></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">
|
|
</div>
|
|
|
|
|
|
|
|
<div id="elements">
|
|
<h3>Classes</h3>
|
|
<ul>
|
|
<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-Customers_Model.html">Customers_Model</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-Services_Model.html">Services_Model</a></li>
|
|
<li class="active"><a href="class-Settings_Model.html">Settings_Model</a></li>
|
|
<li><a href="class-Test.html">Test</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="class-Settings_Model.html" title="Summary of Settings_Model"><span>Class</span></a>
|
|
</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>
|
|
|
|
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
|
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-keyword1">class</span> <a id="Settings_Model" href="#Settings_Model">Settings_Model</a> <span class="php-keyword1">extends</span> CI_Model {
|
|
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a> <span class="php-comment">/**
|
|
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * Class Constructor
|
|
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> */</span>
|
|
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>() {
|
|
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a> parent::__construct();
|
|
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> }
|
|
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a>
|
|
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a> <span class="php-comment">/**
|
|
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * Get setting value from database.
|
|
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> *
|
|
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * This method returns a system setting from the
|
|
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * database.
|
|
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> *
|
|
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * @expectedException InvalidArgumentException Raises whenever the
|
|
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * $name argument is not a string, or does not exist in the database.
|
|
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> *
|
|
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * @param string $name The database setting name.
|
|
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * @return string Returns the database value for
|
|
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * the selected setting.
|
|
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> */</span>
|
|
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a> <span class="php-keyword1">function</span> <a id="_get_setting" href="#_get_setting">get_setting</a>(<span class="php-var">$name</span>) {
|
|
</span><span id="24" class="l"><a class="l" href="#24"> 24: </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="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'$name argument is not a string : '</span> . <span class="php-var">$name</span>);
|
|
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a> }
|
|
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a>
|
|
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>->db->get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> => <span class="php-var">$name</span>))->num_rows() == <span class="php-num">0</span>) { <span class="php-comment">// Check if setting exists in db.</span>
|
|
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'$name setting does not exist in database : '</span> . <span class="php-var">$name</span>);
|
|
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> }
|
|
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a>
|
|
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a> <span class="php-var">$query</span> = <span class="php-var">$this</span>->db->get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> => <span class="php-var">$name</span>));
|
|
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a> <span class="php-var">$setting</span> = (<span class="php-var">$query</span>->num_rows() > <span class="php-num">0</span>) ? <span class="php-var">$query</span>->row() : <span class="php-quote">''</span>;
|
|
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a> <span class="php-keyword1">return</span> <span class="php-var">$setting</span>->value;
|
|
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a> }
|
|
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a>
|
|
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a> <span class="php-comment">/**
|
|
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * This method sets the value for a specific setting
|
|
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * on the database. If the setting doesn't exist, it
|
|
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * is going to be created, otherwise updated.
|
|
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> *
|
|
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * @expectedException DatabaseException Raises whenever an error
|
|
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * occures during the insert or the update operation.
|
|
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * @expectedException InvalidArgumentException Raises whenever
|
|
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * the $name argument is not a string.
|
|
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> *
|
|
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * @param string $name The setting name.
|
|
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * @param type $value The setting value.
|
|
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * @return int Returns the setting database id.
|
|
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> */</span>
|
|
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-keyword1">function</span> <a id="_set_setting" href="#_set_setting">set_setting</a>(<span class="php-var">$name</span>, <span class="php-var">$value</span>) {
|
|
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_string</span>(<span class="php-var">$name</span>)) {
|
|
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'$name argument is not a string : '</span> . <span class="php-var">$name</span>);
|
|
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> }
|
|
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
|
|
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-var">$query</span> = <span class="php-var">$this</span>->db->get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> => <span class="php-var">$name</span>));
|
|
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-keyword1">if</span> (<span class="php-var">$query</span>->num_rows() > <span class="php-num">0</span>) {
|
|
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-comment">// Update setting</span>
|
|
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>->db->update(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'value'</span> => <span class="php-var">$value</span>), <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> => <span class="php-var">$name</span>))) {
|
|
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> DatabaseException(<span class="php-quote">'Could not update database setting.'</span>);
|
|
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> }
|
|
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> <span class="php-var">$setting_id</span> = <span class="php-keyword2">intval</span>(<span class="php-var">$this</span>->db->get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> => <span class="php-var">$name</span>))->row()->id);
|
|
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> } <span class="php-keyword1">else</span> {
|
|
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-comment">// Insert setting</span>
|
|
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> <span class="php-var">$insert_data</span> = <span class="php-keyword1">array</span>(
|
|
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-quote">'name'</span> => <span class="php-var">$name</span>,
|
|
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-quote">'value'</span> => <span class="php-var">$value</span>
|
|
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> );
|
|
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>->db->insert(<span class="php-quote">'ea_settings'</span>, <span class="php-var">$insert_data</span>)) {
|
|
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> DatabaseException(<span class="php-quote">'Could not insert database setting'</span>);
|
|
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> }
|
|
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-var">$setting_id</span> = <span class="php-keyword2">intval</span>(<span class="php-var">$this</span>->db->insert_id());
|
|
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> }
|
|
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a>
|
|
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-keyword1">return</span> <span class="php-var">$setting_id</span>;
|
|
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> }
|
|
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a>
|
|
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-comment">/**
|
|
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * Remove a setting from the database.
|
|
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> *
|
|
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * @expectedException InvalidArgumentException Raises whenever
|
|
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * the $name parameter is not a string.
|
|
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> *
|
|
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> * @param string $name The setting name to be removed.
|
|
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * @return bool Returns the delete operation result.
|
|
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> */</span>
|
|
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-keyword1">function</span> <a id="_remove_setting" href="#_remove_setting">remove_setting</a>(<span class="php-var">$name</span>) {
|
|
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_string</span>(<span class="php-var">$name</span>)) {
|
|
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'$name is not a string : '</span> . <span class="php-var">$name</span>);
|
|
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> }
|
|
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a>
|
|
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>->db->get_where(<span class="php-quote">'ea_settings'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span> => <span class="php-var">$name</span>))->num_rows() == <span class="php-num">0</span>) {
|
|
</span><span id="93" class="l"><a class="l" href="#93"> 93: </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="94" class="l"><a class="l" href="#94"> 94: </a> }
|
|
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
|
|
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->db-><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> => <span class="php-var">$name</span>));
|
|
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> }
|
|
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a>}
|
|
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a>
|
|
</span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment">/* End of file settings_model.php */</span>
|
|
</span><span id="101" class="l"><a class="l" href="#101">101: </a></span><span class="php-comment">/* Location: ./application/models/settings_model.php */</span></code></pre>
|
|
|
|
<div id="footer">
|
|
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|