Overview

Namespaces

  • emberlabs
    • Barcode
  • None

Classes

  • Appconfig
  • Barcode_lib
  • Config
  • Customer
  • Customer_rewards
  • Customers
  • Detailed_receivings
  • Detailed_sales
  • Dinner_table
  • Email_lib
  • emberlabs\Barcode\BarcodeBase
  • emberlabs\Barcode\Code128
  • emberlabs\Barcode\Code39
  • emberlabs\Barcode\Ean13
  • emberlabs\Barcode\Ean8
  • Employee
  • Employees
  • Giftcard
  • Giftcards
  • Home
  • Inventory
  • Inventory_low
  • Inventory_summary
  • Item
  • Item_kit
  • Item_kit_items
  • Item_kits
  • Item_lib
  • Item_quantity
  • Item_taxes
  • Items
  • Login
  • Mailchimp_lib
  • MailchimpConnector
  • Messages
  • Migrate
  • Migration_Sales_Tax_Data
  • Module
  • MY_Lang
  • No_Access
  • Person
  • Persons
  • Receiving
  • Receiving_lib
  • Receivings
  • Report
  • Reports
  • Rewards
  • Rounding_code
  • Sale
  • Sale_lib
  • Sale_suspended
  • Sales
  • Secure_Controller
  • Sms_lib
  • Specific_customer
  • Specific_discount
  • Specific_employee
  • Stock_location
  • Summary_categories
  • Summary_customers
  • Summary_discounts
  • Summary_employees
  • Summary_items
  • Summary_payments
  • Summary_report
  • Summary_sales
  • Summary_suppliers
  • Summary_taxes
  • Supplier
  • Suppliers
  • Tax
  • Tax_lib
  • Taxes
  • Token
  • Token_customer
  • Token_invoice_count
  • Token_invoice_sequence
  • Token_lib
  • Token_quote_sequence
  • Token_suspended_invoice_count
  • Token_year_invoice_count
  • Tracking_lib

Functions

  • cash_decimals
  • currency_side
  • current_language
  • current_language_code
  • dateformat_bootstrap
  • dateformat_momentjs
  • db_log_queries
  • get_customer_data_row
  • get_customer_manage_table_headers
  • get_giftcard_data_row
  • get_giftcards_manage_table_headers
  • get_item_data_row
  • get_item_kit_data_row
  • get_item_kits_manage_table_headers
  • get_items_manage_table_headers
  • get_people_manage_table_headers
  • get_person_data_row
  • get_sale_data_last_row
  • get_sale_data_row
  • get_sales_manage_payments_summary
  • get_sales_manage_table_headers
  • get_supplier_data_row
  • get_suppliers_manage_table_headers
  • get_tax_data_row
  • get_taxes_manage_table_headers
  • load_config
  • load_language_files
  • load_stats
  • parse_decimals
  • pdf_create
  • quantity_decimals
  • show_report
  • show_report_if_allowed
  • tax_decimals
  • to_currency
  • to_currency_no_money
  • to_currency_tax
  • to_decimals
  • to_quantity_decimals
  • to_tax_decimals
  • totals_decimals
  • transform_headers
  • transform_headers_readonly
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 
<?php if (!defined('BASEPATH')) exit('No direct script access allowed');

/**
 * Customer class
 */

class Customer extends Person
{
    /*
    Determines if a given person_id is a customer
    */
    public function exists($person_id)
    {
        $this->db->from('customers');
        $this->db->join('people', 'people.person_id = customers.person_id');
        $this->db->where('customers.person_id', $person_id);

        return ($this->db->get()->num_rows() == 1);
    }

    /*
    Checks if account number exists
    */
    public function check_account_number_exists($account_number, $person_id = '')
    {
        $this->db->from('customers');
        $this->db->where('account_number', $account_number);

        if(!empty($person_id))
        {
            $this->db->where('person_id !=', $person_id);
        }

        return ($this->db->get()->num_rows() == 1);
    }

    /*
    Gets total of rows
    */
    public function get_total_rows()
    {
        $this->db->from('customers');
        $this->db->where('deleted', 0);

        return $this->db->count_all_results();
    }

    /*
    Returns all the customers
    */
    public function get_all($rows = 0, $limit_from = 0)
    {
        $this->db->from('customers');
        $this->db->join('people', 'customers.person_id = people.person_id');
        $this->db->where('deleted', 0);
        $this->db->order_by('last_name', 'asc');

        if($rows > 0)
        {
            $this->db->limit($rows, $limit_from);
        }

        return $this->db->get();
    }

    /*
    Gets information about a particular customer
    */
    public function get_info($customer_id)
    {
        $this->db->from('customers');
        $this->db->join('people', 'people.person_id = customers.person_id');
        $this->db->where('customers.person_id', $customer_id);
        $query = $this->db->get();

        if($query->num_rows() == 1)
        {
            return $query->row();
        }
        else
        {
            //Get empty base parent object, as $customer_id is NOT a customer
            $person_obj = parent::get_info(-1);

            //Get all the fields from customer table
            //append those fields to base parent object, we we have a complete empty object
            foreach($this->db->list_fields('customers') as $field)
            {
                $person_obj->$field = '';
            }

            return $person_obj;
        }
    }

    /*
    Gets stats about a particular customer
    */
    public function get_stats($customer_id)
    {
        // create a temporary table to contain all the sum and average of items
        $this->db->query('CREATE TEMPORARY TABLE IF NOT EXISTS ' . $this->db->dbprefix('sales_items_temp') .
            ' (INDEX(sale_id))
            (
                SELECT
                    sales.sale_id AS sale_id,
                    AVG(sales_items.discount_percent) AS avg_discount,
                    SUM(sales_items.quantity_purchased) AS quantity
                FROM ' . $this->db->dbprefix('sales') . ' AS sales
                INNER JOIN ' . $this->db->dbprefix('sales_items') . ' AS sales_items
                    ON sales_items.sale_id = sales.sale_id
                WHERE sales.customer_id = ' . $this->db->escape($customer_id) . '
                GROUP BY sale_id
            )'
        );

        $totals_decimals = totals_decimals();
        $quantity_decimals = quantity_decimals();

        $this->db->select('
                        SUM(sales_payments.payment_amount) AS total,
                        MIN(sales_payments.payment_amount) AS min,
                        MAX(sales_payments.payment_amount) AS max,
                        AVG(sales_payments.payment_amount) AS average,
                        ' . "
                        ROUND(AVG(sales_items_temp.avg_discount), $totals_decimals) AS avg_discount,
                        ROUND(SUM(sales_items_temp.quantity), $quantity_decimals) AS quantity
                        ");
        $this->db->from('sales');
        $this->db->join('sales_payments AS sales_payments', 'sales.sale_id = sales_payments.sale_id');
        $this->db->join('sales_items_temp AS sales_items_temp', 'sales.sale_id = sales_items_temp.sale_id');
        $this->db->where('sales.customer_id', $customer_id);
        $this->db->where('sales.sale_status', 0);
        $this->db->group_by('sales.customer_id');

        $stat = $this->db->get()->row();

        // drop the temporary table to contain memory consumption as it's no longer required
        $this->db->query('DROP TEMPORARY TABLE IF EXISTS ' . $this->db->dbprefix('sales_items_temp'));

        return $stat;
    }

    /*
    Gets information about multiple customers
    */
    public function get_multiple_info($customer_ids)
    {
        $this->db->from('customers');
        $this->db->join('people', 'people.person_id = customers.person_id');
        $this->db->where_in('customers.person_id', $customer_ids);
        $this->db->order_by('last_name', 'asc');

        return $this->db->get();
    }

    /*
    Checks if customer email exists
    */
    public function check_email_exists($email, $customer_id = '')
    {
        // if the email is empty return like it is not existing
        if(empty($email))
        {
            return FALSE;
        }

        $this->db->from('customers');
        $this->db->join('people', 'people.person_id = customers.person_id');
        $this->db->where('people.email', $email);
        $this->db->where('customers.deleted', 0);

        if(!empty($customer_id))
        {
            $this->db->where('customers.person_id !=', $customer_id);
        }

        return ($this->db->get()->num_rows() == 1);
    }

    /*
    Inserts or updates a customer
    */
    public function save_customer(&$person_data, &$customer_data, $customer_id = FALSE)
    {
        $success = FALSE;

        //Run these queries as a transaction, we want to make sure we do all or nothing
        $this->db->trans_start();

        if(parent::save($person_data, $customer_id))
        {
            if(!$customer_id || !$this->exists($customer_id))
            {
                $customer_data['person_id'] = $person_data['person_id'];
                $success = $this->db->insert('customers', $customer_data);
            }
            else
            {
                $this->db->where('person_id', $customer_id);
                $success = $this->db->update('customers', $customer_data);
            }
        }

        $this->db->trans_complete();

        $success &= $this->db->trans_status();

        return $success;
    }

    /*
    Updates reward points value
    */
    public function update_reward_points_value($customer_id, $value)
    {
        $this->db->where('person_id', $customer_id);
        $this->db->update('customers', array('points' => $value));
    }


    /*
    Deletes one customer
    */
    public function delete($customer_id)
    {
        $this->db->where('person_id', $customer_id);

        return $this->db->update('customers', array('deleted' => 1));
    }

    /*
    Deletes a list of customers
    */
    public function delete_list($customer_ids)
    {
        $this->db->where_in('person_id', $customer_ids);

        return $this->db->update('customers', array('deleted' => 1));
    }

    /*
    Get search suggestions to find customers
    */
    public function get_search_suggestions($search, $unique = TRUE, $limit = 25)
    {
        $suggestions = array();

        $this->db->from('customers');
        $this->db->join('people', 'customers.person_id = people.person_id');
        $this->db->group_start();
            $this->db->like('first_name', $search);
            $this->db->or_like('last_name', $search);
            $this->db->or_like('CONCAT(first_name, " ", last_name)', $search);
        $this->db->group_end();
        $this->db->where('deleted', 0);
        $this->db->order_by('last_name', 'asc');
        foreach($this->db->get()->result() as $row)
        {
            $suggestions[] = array('value' => $row->person_id, 'label' => $row->first_name.' '.$row->last_name);
        }

        if(!$unique)
        {
            $this->db->from('customers');
            $this->db->join('people', 'customers.person_id = people.person_id');
            $this->db->where('deleted', 0);
            $this->db->like('email', $search);
            $this->db->order_by('email', 'asc');
            foreach($this->db->get()->result() as $row)
            {
                $suggestions[] = array('value' => $row->person_id, 'label' => $row->email);
            }

            $this->db->from('customers');
            $this->db->join('people', 'customers.person_id = people.person_id');
            $this->db->where('deleted', 0);
            $this->db->like('phone_number', $search);
            $this->db->order_by('phone_number', 'asc');
            foreach($this->db->get()->result() as $row)
            {
                $suggestions[] = array('value' => $row->person_id, 'label' => $row->phone_number);
            }

            $this->db->from('customers');
            $this->db->join('people', 'customers.person_id = people.person_id');
            $this->db->where('deleted', 0);
            $this->db->like('account_number', $search);
            $this->db->order_by('account_number', 'asc');
            foreach($this->db->get()->result() as $row)
            {
                $suggestions[] = array('value' => $row->person_id, 'label' => $row->account_number);
            }
        }

        //only return $limit suggestions
        if(count($suggestions > $limit))
        {
            $suggestions = array_slice($suggestions, 0, $limit);
        }

        return $suggestions;
    }

    /*
    Gets rows
    */
    public function get_found_rows($search)
    {
        $this->db->from('customers');
        $this->db->join('people', 'customers.person_id = people.person_id');
        $this->db->group_start();
            $this->db->like('first_name', $search);
            $this->db->or_like('last_name', $search);
            $this->db->or_like('email', $search);
            $this->db->or_like('phone_number', $search);
            $this->db->or_like('account_number', $search);
            $this->db->or_like('CONCAT(first_name, " ", last_name)', $search);
        $this->db->group_end();
        $this->db->where('deleted', 0);

        return $this->db->get()->num_rows();
    }

    /*
    Performs a search on customers
    */
    public function search($search, $rows = 0, $limit_from = 0, $sort = 'last_name', $order = 'asc')
    {
        $this->db->from('customers');
        $this->db->join('people', 'customers.person_id = people.person_id');
        $this->db->group_start();
            $this->db->like('first_name', $search);
            $this->db->or_like('last_name', $search);
            $this->db->or_like('email', $search);
            $this->db->or_like('phone_number', $search);
            $this->db->or_like('account_number', $search);
            $this->db->or_like('CONCAT(first_name, " ", last_name)', $search);
        $this->db->group_end();
        $this->db->where('deleted', 0);
        $this->db->order_by($sort, $order);

        if($rows > 0)
        {
            $this->db->limit($rows, $limit_from);
        }

        return $this->db->get();
    }
}
?>
API documentation generated by ApiGen