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
  • 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

  • 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
  • to_currency
  • to_currency_no_money
  • 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: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');

/**
 * Employee class
 *
 * @link    github.com/jekkos/opensourcepos
 * @since   1.0
 * @author  N/A
 */

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

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

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

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

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

        return $this->db->get();        
    }
    
    /*
    Gets information about a particular employee
    */
    public function get_info($employee_id)
    {
        $this->db->from('employees');   
        $this->db->join('people', 'people.person_id = employees.person_id');
        $this->db->where('employees.person_id', $employee_id);
        $query = $this->db->get();

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

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

            return $person_obj;
        }
    }

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

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

    /*
    Inserts or updates an employee
    */
    public function save_employee(&$person_data, &$employee_data, &$grants_data, $employee_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, $employee_id))
        {
            if(!$employee_id || !$this->exists($employee_id))
            {
                $employee_data['person_id'] = $employee_id = $person_data['person_id'];
                $success = $this->db->insert('employees', $employee_data);
            }
            else
            {
                $this->db->where('person_id', $employee_id);
                $success = $this->db->update('employees', $employee_data);
            }

            //We have either inserted or updated a new employee, now lets set permissions. 
            if($success)
            {
                //First lets clear out any grants the employee currently has.
                $success = $this->db->delete('grants', array('person_id' => $employee_id));
                
                //Now insert the new grants
                if($success)
                {
                    foreach($grants_data as $permission_id)
                    {
                        $success = $this->db->insert('grants', array('permission_id' => $permission_id, 'person_id' => $employee_id));
                    }
                }
            }
        }

        $this->db->trans_complete();

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

        return $success;
    }

    /*
    Deletes one employee
    */
    public function delete($employee_id)
    {
        $success = FALSE;

        //Don't let employees delete theirself
        if($employee_id == $this->get_logged_in_employee_info()->person_id)
        {
            return FALSE;
        }

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

        //Delete permissions
        if($this->db->delete('grants', array('person_id' => $employee_id)))
        {   
            $this->db->where('person_id', $employee_id);
            $success = $this->db->update('employees', array('deleted' => 1));
        }

        $this->db->trans_complete();

        return $success;
    }

    /*
    Deletes a list of employees
    */
    public function delete_list($employee_ids)
    {
        $success = FALSE;

        //Don't let employees delete theirself
        if(in_array($this->get_logged_in_employee_info()->person_id, $employee_ids))
        {
            return FALSE;
        }

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

        $this->db->where_in('person_id', $employee_ids);
        //Delete permissions
        if($this->db->delete('grants'))
        {
            //delete from employee table
            $this->db->where_in('person_id', $employee_ids);
            $success = $this->db->update('employees', array('deleted' => 1));
        }

        $this->db->trans_complete();

        return $success;
    }

    /*
    Get search suggestions to find employees
    */
    public function get_search_suggestions($search, $limit = 5)
    {
        $suggestions = array();

        $this->db->from('employees');
        $this->db->join('people', 'employees.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);
        }

        $this->db->from('employees');
        $this->db->join('people', 'employees.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('employees');
        $this->db->join('people', 'employees.person_id = people.person_id');
        $this->db->where('deleted', 0);
        $this->db->like('username', $search);
        $this->db->order_by('username', 'asc');
        foreach($this->db->get()->result() as $row)
        {
            $suggestions[] = array('value' => $row->person_id, 'label' => $row->username);
        }

        $this->db->from('employees');
        $this->db->join('people', 'employees.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);
        }

        //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('employees');
        $this->db->join('people', 'employees.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('username', $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 employees
    */
    public function search($search, $rows = 0, $limit_from = 0, $sort = 'last_name', $order = 'asc')
    {
        $this->db->from('employees');
        $this->db->join('people', 'employees.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('username', $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();    
    }

    /*
    Attempts to login employee and set session. Returns boolean based on outcome.
    */
    public function login($username, $password)
    {
        $query = $this->db->get_where('employees', array('username' => $username, 'deleted' => 0), 1);

        if($query->num_rows() == 1)
        {
            $row = $query->row();

            // compare passwords depending on the hash version
            if($row->hash_version == 1 && $row->password == md5($password))
            {
                $this->db->where('person_id', $row->person_id);
                $this->session->set_userdata('person_id', $row->person_id);
                $password_hash = password_hash($password, PASSWORD_DEFAULT);

                return $this->db->update('employees', array('hash_version' => 2, 'password' => $password_hash));
            }
            elseif($row->hash_version == 2 && password_verify($password, $row->password))
            {
                $this->session->set_userdata('person_id', $row->person_id);

                return TRUE;
            }

        }

        return FALSE;
    }

    /*
    Logs out a user by destorying all session data and redirect to login
    */
    public function logout()
    {
        $this->session->sess_destroy();

        redirect('login');
    }
    
    /*
    Determins if a employee is logged in
    */
    public function is_logged_in()
    {
        return ($this->session->userdata('person_id') != FALSE);
    }

    /*
    Gets information about the currently logged in employee.
    */
    public function get_logged_in_employee_info()
    {
        if($this->is_logged_in())
        {
            return $this->get_info($this->session->userdata('person_id'));
        }

        return FALSE;
    }

    /*
    Determines whether the employee has access to at least one submodule
     */
    public function has_module_grant($permission_id, $person_id)
    {
        $this->db->from('grants');
        $this->db->like('permission_id', $permission_id, 'after');
        $this->db->where('person_id', $person_id);
        $result_count = $this->db->get()->num_rows();

        if($result_count != 1)
        {
            return ($result_count != 0);
        }

        return $this->has_subpermissions($permission_id);
    }

    /*
    Checks permissions
    */
    public function has_subpermissions($permission_id)
    {
        $this->db->from('permissions');
        $this->db->like('permission_id', $permission_id.'_', 'after');

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

    /*
    Determines whether the employee specified employee has access the specific module.
    */
    public function has_grant($permission_id, $person_id)
    {
        //if no module_id is null, allow access
        if($permission_id == NULL)
        {
            return TRUE;
        }

        $query = $this->db->get_where('grants', array('person_id' => $person_id, 'permission_id' => $permission_id), 1);

        return ($query->num_rows() == 1); 
    }

    /*
    Gets employee permission grants
    */
    public function get_employee_grants($person_id)
    {
        $this->db->from('grants');
        $this->db->where('person_id', $person_id);

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


    /*
    Attempts to login employee and set session. Returns boolean based on outcome.
    */
    public function check_password($username, $password)
    {
        $query = $this->db->get_where('employees', array('username' => $username, 'deleted' => 0), 1);

        if($query->num_rows() == 1)
        {
            $row = $query->row();

            // compare passwords
            if(password_verify($password, $row->password))
            {
                return TRUE;
            }

        }

        return FALSE;
    }

    /*
    Change password for the employee
    */
    public function change_password($employee_data, $employee_id = FALSE)
    {
        $success = FALSE;

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

        $this->db->where('person_id', $employee_id);
        $success = $this->db->update('employees', $employee_data);

        $this->db->trans_complete();

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

        return $success;
    }
}
?>
API documentation generated by ApiGen