mirror of
https://github.com/alextselegidis/easyappointments.git
synced 2024-12-23 07:03:26 +03:00
430 lines
11 KiB
HTML
430 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<title>Class Settings_Model</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 class="active">
|
|
<span>Class</span> </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 class="active"><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><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 class="active"><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><a href="class-User_Model.html">User_Model</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="splitter"></div>
|
|
|
|
<div id="right">
|
|
<div id="rightInner">
|
|
<div id="content" class="class">
|
|
<h1>Class Settings_Model</h1>
|
|
|
|
|
|
|
|
<dl class="tree well">
|
|
<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="alert alert-info">
|
|
|
|
|
|
|
|
|
|
|
|
<b>Located at</b> <a href="source-class-Settings_Model.html#2-129" title="Go to source code">settings_model.php</a>
|
|
<br>
|
|
</div>
|
|
|
|
|
|
|
|
<h2>Methods summary</h2>
|
|
<table class="summary table table-bordered table-striped methods" id="methods">
|
|
<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-34" 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>The database setting name.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string<br><p>Returns the database value for
|
|
the selected setting.</p>
|
|
</div>
|
|
|
|
|
|
<h4>Expectedexception</h4>
|
|
<div class="list">
|
|
Exception<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#36-72" 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>The setting name.</dd>
|
|
<dt><var>$value</var></dt>
|
|
<dd>The setting value.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
integer<br>Returns the setting database id.
|
|
</div>
|
|
|
|
|
|
<h4>Expectedexception</h4>
|
|
<div class="list">
|
|
Exception<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#74-92" 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>The setting name to be removed.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
boolean<br>Returns the delete operation result.
|
|
</div>
|
|
|
|
|
|
<h4>Expectedexception</h4>
|
|
<div class="list">
|
|
Exception<br>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="save_settings" id="_save_settings">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_save_settings">#</a>
|
|
<code><a href="source-class-Settings_Model.html#94-119" title="Go to source code">save_settings</a>( <span>array <var>$settings</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
<p>Saves all the system settings into the database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Saves all the system settings into the database.</p>
|
|
|
|
<p>This method is usefull when trying to save all the system settings at once instead of
|
|
saving them one by one.</p>
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$settings</var></dt>
|
|
<dd>Contains all the system settings.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
boolean<br>Returns the save operation result.
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
Exception<br>When the update operation won't work for a specific setting.
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="get_settings" id="_get_settings">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_get_settings">#</a>
|
|
<code><a href="source-class-Settings_Model.html#121-128" title="Go to source code">get_settings</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>Returns all the system settings at once.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Returns all the system settings at once.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
array<br>Array of all the system settings stored in the 'ea_settings' table.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<h3>Magic methods summary</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="footer">
|
|
API documentation generated by <a href="http://apigen.org">ApiGen</a>
|
|
</div>
|
|
</div>
|
|
<script src="resources/combined.js"></script>
|
|
<script src="elementlist.js"></script>
|
|
</body>
|
|
</html>
|