ifl/iflrandevu
1
1
Fork 0
forked from mirrors/easyappointments
Code Issues 6 Pull requests Releases 3 Activity
iflrandevu/doc/code-docs/php/source-class-Customers_Model.html
alextselegidis@gmail.com 534b17dc80 - Συγχώνευση των αρχείων τεκμηρίωσης της πτυχιακής σε ένα έγγραφό. 
- Προσθήκη του λογότυπου της εφαρμογής.
- Προσθήκη τεκμηρίωσης του κώδικα (PHP + Javascript)
2013-06-01 11:03:17 +00:00

371 lines
45 KiB
HTML
Raw Blame History

<!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 customers_model.php</title>
<script type="text/javascript" src="resources/combined.js?955602237"></script>
<script type="text/javascript" src="elementlist.js?1576614342"></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 class="active"><a href="class-Customers_Model.html">Customers_Model</a></li>
<li><a href="class-Google.html">Google</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><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-Customers_Model.html" title="Summary of Customers_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">&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 class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Customers_Model" href="#Customers_Model">Customers_Model</a> <span class="php-keyword1">extends</span> CI_Model {
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a> <span class="php-comment">/**
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * Class Constructor
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> */</span>
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>() {
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> parent::__construct();
</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><span id="11" class="l"><a class="l" href="#11"> 11: </a> <span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * Add a customer record to the database.
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> *
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * This method adds a customer to the database. If the customer
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * doesn't exists it is going to be inserted, otherwise the
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * record is going to be updated.
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> *
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * @expectedException ValidationException When customer's data are invalid.
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * @expectedException DatabaseException When update or insert method fails.
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> *
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * @param array $customer_data Associative array with the customer's
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * data. Each key has the same name with the database fields.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * @return int Returns the customer id.
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> */</span>
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_add" href="#_add">add</a>(<span class="php-var">$customer_data</span>) {
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a> <span class="php-comment">// Validate the appointment data before doing anything.</span>
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a> <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;validate_data(<span class="php-var">$customer_data</span>)) {
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> ValidationException(<span class="php-quote">'Customer data are not valid.'</span>);
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a> }
</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 class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;exists(<span class="php-var">$customer_data</span>)) {
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a> <span class="php-var">$customer_data</span>[<span class="php-quote">'id'</span>] = <span class="php-var">$this</span>-&gt;insert(<span class="php-var">$customer_data</span>);
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a> } <span class="php-keyword1">else</span> {
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a> <span class="php-var">$customer_data</span>[<span class="php-quote">'id'</span>] = <span class="php-var">$this</span>-&gt;update(<span class="php-var">$customer_data</span>);
</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-keyword1">return</span> <span class="php-var">$customer_data</span>[<span class="php-quote">'id'</span>];
</span><span id="38" class="l"><a class="l" href="#38"> 38: </a> }
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a>
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a> <span class="php-comment">/**
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * Check if a particular customer record already exists.
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> *
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * This method checks wether the given customer already exists in
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * the database. It doesn't search with the id, but with the following
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * fields: &quot;email&quot;
</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"> * @expectedException InvalidArgumentException When the $customer_data
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * array does not contain all the necessary fields.
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> *
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * @param array $customer_data Associative array with the customer's
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * data. Each key has the same name with the database fields.
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * @return bool Returns wether the record exists or not.
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_exists" href="#_exists">exists</a>(<span class="php-var">$customer_data</span>) {
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$customer_data</span>[<span class="php-quote">'email'</span>])) {
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'Customer\'s email is not provided.'</span>);
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> }
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-comment">// This method shouldn't depend on another method of this class.</span>
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-var">$num_rows</span> = <span class="php-var">$this</span>-&gt;db
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> -&gt;select(<span class="php-quote">'*'</span>)
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> -&gt;from(<span class="php-quote">'ea_users'</span>)
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> -&gt;<span class="php-keyword2">join</span>(<span class="php-quote">'ea_roles'</span>, <span class="php-quote">'ea_roles.id = ea_users.id_roles'</span>, <span class="php-quote">'inner'</span>)
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> -&gt;where(<span class="php-quote">'ea_users.email'</span>, <span class="php-var">$customer_data</span>[<span class="php-quote">'email'</span>])
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> -&gt;where(<span class="php-quote">'ea_roles.slug'</span>, DB_SLUG_CUSTOMER)
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> -&gt;get()-&gt;num_rows();
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a>
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-keyword1">return</span> (<span class="php-var">$num_rows</span> &gt; <span class="php-num">0</span>) ? <span class="php-keyword1">TRUE</span> : <span class="php-keyword1">FALSE</span>;
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> }
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * Insert a new customer record to the database.
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> *
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * @param array $customer_data Associative array with the customer's
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * data. Each key has the same name with the database fields.
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * @return int Returns the id of the new record.
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> */</span>
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_insert" href="#_insert">insert</a>(<span class="php-var">$customer_data</span>) {
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-comment">// Before inserting the customer we need to get the customer's role id</span>
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-comment">// from the database and assign it to the new record as a foreign key.</span>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-var">$customer_role_id</span> = <span class="php-var">$this</span>-&gt;db
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> -&gt;select(<span class="php-quote">'id'</span>)
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> -&gt;from(<span class="php-quote">'ea_roles'</span>)
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> -&gt;where(<span class="php-quote">'slug'</span>, DB_SLUG_CUSTOMER)
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> -&gt;get()-&gt;row()-&gt;id;
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a>
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-var">$customer_data</span>[<span class="php-quote">'id_roles'</span>] = <span class="php-var">$customer_role_id</span>;
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;db-&gt;insert(<span class="php-quote">'ea_users'</span>, <span class="php-var">$customer_data</span>)) {
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> DatabaseException(<span class="php-quote">'Could not insert customer to the database.'</span>);
</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><span id="93" class="l"><a class="l" href="#93"> 93: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">intval</span>(<span class="php-var">$this</span>-&gt;db-&gt;insert_id());
</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-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * Update an existing customer record in the database.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> *
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * The customer data argument should already include the record
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * id in order to process the update operation.
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> *
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * @param array $customer_data Associative array with the customer's
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * data. Each key has the same name with the database fields.
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * @return int Returns the updated record id.
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> */</span>
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_update" href="#_update">update</a>(<span class="php-var">$customer_data</span>) {
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$customer_data</span>[<span class="php-quote">'id'</span>])) {
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-var">$customer_data</span>[<span class="php-quote">'id'</span>] = <span class="php-var">$this</span>-&gt;find_record_id(<span class="php-var">$customer_data</span>);
</span><span id="109" class="l"><a class="l" href="#109">109: </a> }
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-quote">'id'</span>, <span class="php-var">$customer_data</span>[<span class="php-quote">'id'</span>]);
</span><span id="112" class="l"><a class="l" 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_users'</span>, <span class="php-var">$customer_data</span>)) {
</span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> DatabaseException(<span class="php-quote">'Could not update customer to the database.'</span>);
</span><span id="114" class="l"><a class="l" href="#114">114: </a> }
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">intval</span>(<span class="php-var">$customer_data</span>[<span class="php-quote">'id'</span>]);
</span><span id="117" class="l"><a class="l" href="#117">117: </a> }
</span><span id="118" class="l"><a class="l" href="#118">118: </a>
</span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-comment">/**
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * Find the database id of a customer record.
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> *
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The customer data should include the following fields in order to
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * get the unique id from the database: &quot;email&quot;
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> *
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> * &lt;strong&gt;IMPORTANT!&lt;/strong&gt; The record must already exists in the
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * database, otherwise an exception is raised.
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> *
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> * @expectedException DatabaseException When the record is not found.
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment"> *
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> * @param array $customer_data Array with the customer data. The
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> * keys of the array should have the same names as the db fields.
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * @return int Returns the id.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_find_record_id" href="#_find_record_id">find_record_id</a>(<span class="php-var">$customer_data</span>) {
</span><span id="135" class="l"><a class="l" href="#135">135: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$customer_data</span>[<span class="php-quote">'email'</span>])) {
</span><span id="136" class="l"><a class="l" href="#136">136: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'Customer\'s email was not provided : '</span>
</span><span id="137" class="l"><a class="l" href="#137">137: </a> . <span class="php-keyword2">print_r</span>(<span class="php-var">$customer_data</span>, <span class="php-keyword1">TRUE</span>));
</span><span id="138" class="l"><a class="l" href="#138">138: </a> }
</span><span id="139" class="l"><a class="l" href="#139">139: </a>
</span><span id="140" class="l"><a class="l" href="#140">140: </a> <span class="php-comment">// Get customer's role id</span>
</span><span id="141" class="l"><a class="l" href="#141">141: </a> <span class="php-var">$result</span> = <span class="php-var">$this</span>-&gt;db
</span><span id="142" class="l"><a class="l" href="#142">142: </a> -&gt;select(<span class="php-quote">'ea_users.id'</span>)
</span><span id="143" class="l"><a class="l" href="#143">143: </a> -&gt;from(<span class="php-quote">'ea_users'</span>)
</span><span id="144" class="l"><a class="l" href="#144">144: </a> -&gt;<span class="php-keyword2">join</span>(<span class="php-quote">'ea_roles'</span>, <span class="php-quote">'ea_roles.id = ea_users.id_roles'</span>, <span class="php-quote">'inner'</span>)
</span><span id="145" class="l"><a class="l" href="#145">145: </a> -&gt;where(<span class="php-quote">'ea_users.email'</span>, <span class="php-var">$customer_data</span>[<span class="php-quote">'email'</span>])
</span><span id="146" class="l"><a class="l" href="#146">146: </a> -&gt;where(<span class="php-quote">'ea_roles.slug'</span>, DB_SLUG_CUSTOMER)
</span><span id="147" class="l"><a class="l" href="#147">147: </a> -&gt;get();
</span><span id="148" class="l"><a class="l" href="#148">148: </a>
</span><span id="149" class="l"><a class="l" href="#149">149: </a> <span class="php-keyword1">if</span> (<span class="php-var">$result</span>-&gt;num_rows() == <span class="php-num">0</span>) {
</span><span id="150" class="l"><a class="l" href="#150">150: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> DatabaseException(<span class="php-quote">'Could not find appointment record id.'</span>);
</span><span id="151" class="l"><a class="l" href="#151">151: </a> }
</span><span id="152" class="l"><a class="l" href="#152">152: </a>
</span><span id="153" class="l"><a class="l" href="#153">153: </a> <span class="php-keyword1">return</span> <span class="php-var">$result</span>-&gt;row()-&gt;id;
</span><span id="154" class="l"><a class="l" href="#154">154: </a> }
</span><span id="155" class="l"><a class="l" href="#155">155: </a>
</span><span id="156" class="l"><a class="l" href="#156">156: </a> <span class="php-comment">/**
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * Validate customer data before the insert or
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> * update operation is executed.
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> *
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment"> * @param array $customer_data Contains the customer data.
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment"> * @return bool Returns the validation result.
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> */</span>
</span><span id="163" class="l"><a class="l" href="#163">163: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_validate_data" href="#_validate_data">validate_data</a>(<span class="php-var">$customer_data</span>) {
</span><span id="164" class="l"><a class="l" href="#164">164: </a> <span class="php-var">$this</span>-&gt;load-&gt;helper(<span class="php-quote">'data_validation'</span>);
</span><span id="165" class="l"><a class="l" href="#165">165: </a>
</span><span id="166" class="l"><a class="l" href="#166">166: </a> <span class="php-keyword1">try</span> {
</span><span id="167" class="l"><a class="l" href="#167">167: </a> <span class="php-comment">// Validate required fields</span>
</span><span id="168" class="l"><a class="l" href="#168">168: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$customer_data</span>[<span class="php-quote">'last_name'</span>])
</span><span id="169" class="l"><a class="l" href="#169">169: </a> || !<span class="php-keyword1">isset</span>(<span class="php-var">$customer_data</span>[<span class="php-quote">'email'</span>])
</span><span id="170" class="l"><a class="l" href="#170">170: </a> || !<span class="php-keyword1">isset</span>(<span class="php-var">$customer_data</span>[<span class="php-quote">'phone_number'</span>])) {
</span><span id="171" class="l"><a class="l" href="#171">171: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'Not all required fields are provided : '</span>
</span><span id="172" class="l"><a class="l" href="#172">172: </a> . <span class="php-keyword2">print_r</span>(<span class="php-var">$customer_data</span>, <span class="php-keyword1">TRUE</span>));
</span><span id="173" class="l"><a class="l" href="#173">173: </a> }
</span><span id="174" class="l"><a class="l" href="#174">174: </a>
</span><span id="175" class="l"><a class="l" href="#175">175: </a> <span class="php-comment">// Validate email address</span>
</span><span id="176" class="l"><a class="l" href="#176">176: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">filter_var</span>(<span class="php-var">$customer_data</span>[<span class="php-quote">'email'</span>], FILTER_VALIDATE_EMAIL)) {
</span><span id="177" class="l"><a class="l" href="#177">177: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception(<span class="php-quote">'Invalid email address provided : '</span> . <span class="php-var">$customer_data</span>[<span class="php-quote">'email'</span>]);
</span><span id="178" class="l"><a class="l" href="#178">178: </a> }
</span><span id="179" class="l"><a class="l" href="#179">179: </a>
</span><span id="180" class="l"><a class="l" href="#180">180: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">TRUE</span>;
</span><span id="181" class="l"><a class="l" href="#181">181: </a> } <span class="php-keyword1">catch</span> (Exception <span class="php-var">$exc</span>) {
</span><span id="182" class="l"><a class="l" href="#182">182: </a> <span class="php-keyword1">echo</span> <span class="php-var">$exc</span>-&gt;getMessage();
</span><span id="183" class="l"><a class="l" href="#183">183: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">FALSE</span>;
</span><span id="184" class="l"><a class="l" href="#184">184: </a> }
</span><span id="185" class="l"><a class="l" href="#185">185: </a> }
</span><span id="186" class="l"><a class="l" href="#186">186: </a>
</span><span id="187" class="l"><a class="l" href="#187">187: </a> <span class="php-comment">/**
</span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment"> * Delete an existing customer record from the database.
</span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment"> *
</span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment"> * @expectedException InvalidArgumentException Raises when
</span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment"> * the $customer_id is not an integer.
</span></span><span id="192" class="l"><a class="l" href="#192">192: </a><span class="php-comment"> *
</span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment"> * @param int $customer_id The record id to be deleted.
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> * @return bool Returns the delete operation result.
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> */</span>
</span><span id="196" class="l"><a class="l" href="#196">196: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$customer_id</span>) {
</span><span id="197" class="l"><a class="l" href="#197">197: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_numeric</span>(<span class="php-var">$customer_id</span>)) {
</span><span id="198" class="l"><a class="l" href="#198">198: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'Invalid argument type $customer_id : '</span> . <span class="php-var">$customer_id</span>);
</span><span id="199" class="l"><a class="l" href="#199">199: </a> }
</span><span id="200" class="l"><a class="l" href="#200">200: </a>
</span><span id="201" class="l"><a class="l" href="#201">201: </a> <span class="php-var">$num_rows</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_users'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'id'</span> =&gt; <span class="php-var">$customer_id</span>))-&gt;num_rows();
</span><span id="202" class="l"><a class="l" href="#202">202: </a> <span class="php-keyword1">if</span> (<span class="php-var">$num_rows</span> == <span class="php-num">0</span>) {
</span><span id="203" class="l"><a class="l" href="#203">203: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">FALSE</span>;
</span><span id="204" class="l"><a class="l" href="#204">204: </a> }
</span><span id="205" class="l"><a class="l" href="#205">205: </a>
</span><span id="206" class="l"><a class="l" href="#206">206: </a> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-quote">'id'</span>, <span class="php-var">$customer_id</span>);
</span><span id="207" class="l"><a class="l" href="#207">207: </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_users'</span>);
</span><span id="208" class="l"><a class="l" href="#208">208: </a> }
</span><span id="209" class="l"><a class="l" href="#209">209: </a>
</span><span id="210" class="l"><a class="l" href="#210">210: </a> <span class="php-comment">/**
</span></span><span id="211" class="l"><a class="l" href="#211">211: </a><span class="php-comment"> * Get a specific row from the appointments table.
</span></span><span id="212" class="l"><a class="l" href="#212">212: </a><span class="php-comment"> *
</span></span><span id="213" class="l"><a class="l" href="#213">213: </a><span class="php-comment"> * @param int $customer_id The record's id to be returned.
</span></span><span id="214" class="l"><a class="l" href="#214">214: </a><span class="php-comment"> * @return array Returns an associative array with the selected
</span></span><span id="215" class="l"><a class="l" href="#215">215: </a><span class="php-comment"> * record's data. Each key has the same name as the database
</span></span><span id="216" class="l"><a class="l" href="#216">216: </a><span class="php-comment"> * field names.
</span></span><span id="217" class="l"><a class="l" href="#217">217: </a><span class="php-comment"> */</span>
</span><span id="218" class="l"><a class="l" href="#218">218: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_get_row" href="#_get_row">get_row</a>(<span class="php-var">$customer_id</span>) {
</span><span id="219" class="l"><a class="l" href="#219">219: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_numeric</span>(<span class="php-var">$customer_id</span>)) {
</span><span id="220" class="l"><a class="l" href="#220">220: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'Invalid argument provided as $customer_id : '</span> . <span class="php-var">$customer_id</span>);
</span><span id="221" class="l"><a class="l" href="#221">221: </a> }
</span><span id="222" class="l"><a class="l" href="#222">222: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_users'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'id'</span> =&gt; <span class="php-var">$customer_id</span>))-&gt;row_array();
</span><span id="223" class="l"><a class="l" href="#223">223: </a> }
</span><span id="224" class="l"><a class="l" href="#224">224: </a>
</span><span id="225" class="l"><a class="l" href="#225">225: </a> <span class="php-comment">/**
</span></span><span id="226" class="l"><a class="l" href="#226">226: </a><span class="php-comment"> * Get a specific field value from the database.
</span></span><span id="227" class="l"><a class="l" href="#227">227: </a><span class="php-comment"> *
</span></span><span id="228" class="l"><a class="l" href="#228">228: </a><span class="php-comment"> * @param string $field_name The field name of the value to be
</span></span><span id="229" class="l"><a class="l" href="#229">229: </a><span class="php-comment"> * returned.
</span></span><span id="230" class="l"><a class="l" href="#230">230: </a><span class="php-comment"> * @param int $customer_id The selected record's id.
</span></span><span id="231" class="l"><a class="l" href="#231">231: </a><span class="php-comment"> * @return string Returns the records value from the database.
</span></span><span id="232" class="l"><a class="l" href="#232">232: </a><span class="php-comment"> */</span>
</span><span id="233" class="l"><a class="l" href="#233">233: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_get_value" href="#_get_value">get_value</a>(<span class="php-var">$field_name</span>, <span class="php-var">$customer_id</span>) {
</span><span id="234" class="l"><a class="l" href="#234">234: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_numeric</span>(<span class="php-var">$customer_id</span>)) {
</span><span id="235" class="l"><a class="l" href="#235">235: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'Invalid argument provided as $customer_id : '</span> . <span class="php-var">$customer_id</span>);
</span><span id="236" class="l"><a class="l" href="#236">236: </a> }
</span><span id="237" class="l"><a class="l" href="#237">237: </a>
</span><span id="238" class="l"><a class="l" href="#238">238: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_string</span>(<span class="php-var">$field_name</span>)) {
</span><span id="239" class="l"><a class="l" href="#239">239: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'$field_name argument is not a string : '</span> . <span class="php-var">$field_name</span>);
</span><span id="240" class="l"><a class="l" href="#240">240: </a> }
</span><span id="241" class="l"><a class="l" href="#241">241: </a>
</span><span id="242" class="l"><a class="l" href="#242">242: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_users'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'id'</span> =&gt; <span class="php-var">$customer_id</span>))-&gt;num_rows() == <span class="php-num">0</span>) {
</span><span id="243" class="l"><a class="l" href="#243">243: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'The record with the $customer_id argument does not exist in the database : '</span> . <span class="php-var">$customer_id</span>);
</span><span id="244" class="l"><a class="l" href="#244">244: </a> }
</span><span id="245" class="l"><a class="l" href="#245">245: </a>
</span><span id="246" class="l"><a class="l" href="#246">246: </a> <span class="php-var">$row_data</span> = <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_users'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'id'</span> =&gt; <span class="php-var">$customer_id</span>))-&gt;row_array();
</span><span id="247" class="l"><a class="l" href="#247">247: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$row_data</span>[<span class="php-var">$field_name</span>])) {
</span><span id="248" class="l"><a class="l" href="#248">248: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> InvalidArgumentException(<span class="php-quote">'The given $field_name argument does not exist in the database : '</span> . <span class="php-var">$field_name</span>);
</span><span id="249" class="l"><a class="l" href="#249">249: </a> }
</span><span id="250" class="l"><a class="l" href="#250">250: </a>
</span><span id="251" class="l"><a class="l" href="#251">251: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get_where(<span class="php-quote">'ea_users'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'id'</span> =&gt; <span class="php-var">$customer_id</span>))-&gt;row_array()[<span class="php-var">$field_name</span>];
</span><span id="252" class="l"><a class="l" href="#252">252: </a> }
</span><span id="253" class="l"><a class="l" href="#253">253: </a>
</span><span id="254" class="l"><a class="l" href="#254">254: </a> <span class="php-comment">/**
</span></span><span id="255" class="l"><a class="l" href="#255">255: </a><span class="php-comment"> * Get all, or specific records from appointment's table.
</span></span><span id="256" class="l"><a class="l" href="#256">256: </a><span class="php-comment"> *
</span></span><span id="257" class="l"><a class="l" href="#257">257: </a><span class="php-comment"> * @example $this-&gt;Model-&gt;getBatch('id = ' . $recordId);
</span></span><span id="258" class="l"><a class="l" href="#258">258: </a><span class="php-comment"> *
</span></span><span id="259" class="l"><a class="l" href="#259">259: </a><span class="php-comment"> * @param string $whereClause (OPTIONAL) The WHERE clause of
</span></span><span id="260" class="l"><a class="l" href="#260">260: </a><span class="php-comment"> * the query to be executed. DO NOT INCLUDE 'WHERE' KEYWORD.
</span></span><span id="261" class="l"><a class="l" href="#261">261: </a><span class="php-comment"> * @return array Returns the rows from the database.
</span></span><span id="262" class="l"><a class="l" href="#262">262: </a><span class="php-comment"> */</span>
</span><span id="263" class="l"><a class="l" href="#263">263: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_get_batch" href="#_get_batch">get_batch</a>(<span class="php-var">$where_clause</span> = <span class="php-quote">''</span>) {
</span><span id="264" class="l"><a class="l" href="#264">264: </a> <span class="php-var">$customers_role_id</span> = <span class="php-var">$this</span>-&gt;get_customers_role_id();
</span><span id="265" class="l"><a class="l" href="#265">265: </a>
</span><span id="266" class="l"><a class="l" href="#266">266: </a> <span class="php-keyword1">if</span> (<span class="php-var">$where_clause</span> != <span class="php-quote">''</span>) {
</span><span id="267" class="l"><a class="l" href="#267">267: </a> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-var">$where_clause</span>);
</span><span id="268" class="l"><a class="l" href="#268">268: </a> }
</span><span id="269" class="l"><a class="l" href="#269">269: </a>
</span><span id="270" class="l"><a class="l" href="#270">270: </a> <span class="php-var">$this</span>-&gt;db-&gt;where(<span class="php-quote">'id_roles'</span>, <span class="php-var">$customers_role_id</span>);
</span><span id="271" class="l"><a class="l" href="#271">271: </a>
</span><span id="272" class="l"><a class="l" href="#272">272: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db-&gt;get(<span class="php-quote">'ea_users'</span>)-&gt;result_array();
</span><span id="273" class="l"><a class="l" href="#273">273: </a> }
</span><span id="274" class="l"><a class="l" href="#274">274: </a>
</span><span id="275" class="l"><a class="l" href="#275">275: </a> <span class="php-comment">/**
</span></span><span id="276" class="l"><a class="l" href="#276">276: </a><span class="php-comment"> * Get the customers role id from the database.
</span></span><span id="277" class="l"><a class="l" href="#277">277: </a><span class="php-comment"> *
</span></span><span id="278" class="l"><a class="l" href="#278">278: </a><span class="php-comment"> * @return int Returns the role id for the customer records.
</span></span><span id="279" class="l"><a class="l" href="#279">279: </a><span class="php-comment"> */</span>
</span><span id="280" class="l"><a class="l" href="#280">280: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_get_customers_role_id" href="#_get_customers_role_id">get_customers_role_id</a>() {
</span><span id="281" class="l"><a class="l" href="#281">281: </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; DB_SLUG_CUSTOMER))-&gt;row()-&gt;id;
</span><span id="282" class="l"><a class="l" href="#282">282: </a> }
</span><span id="283" class="l"><a class="l" href="#283">283: </a>}
</span><span id="284" class="l"><a class="l" href="#284">284: </a>
</span><span id="285" class="l"><a class="l" href="#285">285: </a><span class="php-comment">/* End of file customers_model.php */</span>
</span><span id="286" class="l"><a class="l" href="#286">286: </a></span><span class="php-comment">/* Location: ./application/models/customers_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>
Reference in a new issue View git blame Copy permalink