iflrandevu/doc/code/php/class-Settings_Model.html

323 lines
6.5 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 Settings_Model</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 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 Settings_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>Settings_Model</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Settings_Model.html#2-98" title="Go to source code">settings_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-Settings_Model.html#3-8" 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_setting" id="_get_setting">
<td class="attributes"><code>
public
string
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_setting">#</a>
<code><a href="source-class-Settings_Model.html#10-35" title="Go to source code">get_setting</a>( <span>string <var>$name</var></span> )</code>
<div class="description short">
<p>Get setting value from database.</p>
</div>
<div class="description detailed hidden">
<p>Get setting value from database.</p>
<p>This method returns a system setting from the database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name The database setting name.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>string</code><br>Returns the database value for the selected setting.<br />
</div>
<h4>ExpectedException</h4>
<div class="list">
InvalidArgumentException Raises whenever the $name argument is not a string, or
does not exist in the database.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="set_setting" id="_set_setting">
<td class="attributes"><code>
public
integer
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_set_setting">#</a>
<code><a href="source-class-Settings_Model.html#37-76" title="Go to source code">set_setting</a>( <span>string <var>$name</var></span>, <span>type <var>$value</var></span> )</code>
<div class="description short">
<p>This method sets the value for a specific setting on the database. If the
setting doesn't exist, it is going to be created, otherwise updated.</p>
</div>
<div class="description detailed hidden">
<p>This method sets the value for a specific setting on the database. If the
setting doesn't exist, it is going to be created, otherwise updated.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name The setting name.</dd>
<dt><var>$value</var></dt>
<dd><code>type</code><br>$value The setting value.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>integer</code><br>Returns the setting database id.<br />
</div>
<h4>ExpectedException</h4>
<div class="list">
DatabaseException Raises whenever an error occures during the insert or the
update operation.<br />
InvalidArgumentException Raises whenever the $name argument is not a string.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="remove_setting" id="_remove_setting">
<td class="attributes"><code>
public
boolean
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_remove_setting">#</a>
<code><a href="source-class-Settings_Model.html#78-97" title="Go to source code">remove_setting</a>( <span>string <var>$name</var></span> )</code>
<div class="description short">
<p>Remove a setting from the database.</p>
</div>
<div class="description detailed hidden">
<p>Remove a setting from the database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name The setting name to be removed.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>boolean</code><br>Returns the delete operation result.<br />
</div>
<h4>ExpectedException</h4>
<div class="list">
InvalidArgumentException Raises whenever the $name parameter is not a string.<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>