CORE-POS/IS4C

View on GitHub
fannie/reports/LocalMix/LocalMixReport.php

Summary

Maintainability
C
1 day
Test Coverage
F
40%
<?php
/*******************************************************************************

    Copyright 2014 Whole Foods Co-op

    This file is part of CORE-POS.

    CORE-POS is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    CORE-POS is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    in the file license.txt along with IT CORE; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*********************************************************************************/

include(dirname(__FILE__) . '/../../config.php');
if (!class_exists('FannieAPI')) {
    include_once(__DIR__ . '/../../classlib2.0/FannieAPI.php');
}

class LocalMixReport extends FannieReportPage 
{
    public $description = '[Local Mix Report] lists the total number of products
        from each vendor as well as each brand within a vendor. The number of
        products designated as local is also listed.';
    public $themed = true;
    public $report_set = 'Purchasing';
    public $required_fields = array();
    protected $title = "Fannie : Local Item Mix Report";
    protected $header = "Local Item Mix Report";
    protected $no_sort_but_style = true;
    protected $sortable = false;

    private $localSettings = array();
    protected $report_headers = array('Vendor', 'Brand', '# Non-Local');

    public function preprocess()
    {
        $dbc = $this->connection;
        $dbc->selectDB($this->config->get('OP_DB'));
        $o = new OriginsModel($dbc);
        $o->local(1);
        foreach ($o->find('originID') as $origin) {
            $this->localSettings[$origin->originID()] = $origin->shortName();
            $this->report_headers[] = '# ' . $origin->shortName();
        }

        return parent::preprocess();
    }

    public function fetch_report_data()
    {
        $dbc = $this->connection;
        $dbc->selectDB($this->config->get('OP_DB'));
        $data = array();
        
        $localCols = '';
        foreach ($this->localSettings as $id => $name) {
            $localCols .= sprintf('SUM(CASE WHEN p.local=%d THEN 1 ELSE 0 END) as local%d,', $id, $id);
        }

        $vendorQ = '
            SELECT ' . $localCols . '
                COALESCE(v.vendorName, \'\') AS vendor,
                v.vendorID,
                SUM(CASE WHEN p.local=0 THEN 1 ELSE 0 END) AS nonLocal,
                COUNT(*) AS numItems
            FROM products AS p
                LEFT JOIN vendors AS v ON p.default_vendor_id=v.vendorID
            GROUP BY COALESCE(v.vendorName, \'\'), v.vendorID
            ORDER BY COUNT(*) DESC';
        $vendorR = $dbc->query($vendorQ);

        $brandP = $dbc->prepare('
            SELECT ' . $localCols . '
                COALESCE(p.brand, \'\') AS brand,
                SUM(CASE WHEN p.local=0 THEN 1 ELSE 0 END) AS nonLocal
            FROM products AS p
                LEFT JOIN vendors AS v ON p.default_vendor_id=v.vendorID
            WHERE p.default_vendor_id=?
            GROUP BY COALESCE(p.brand, \'\')
            ORDER BY COALESCE(p.brand, \'\')');

        $first = true;
        while ($vendorW = $dbc->fetch_row($vendorR)) {
            $has_local = false;
            foreach ($this->localSettings as $id => $name) {
                if ($vendorW['local' . $id] > 0) {
                    $has_local = true;
                    break;
                }
            }
            if (!$has_local) {
                continue;
            }

            if (!$first) {
                $data[] = array('meta'=>FannieReportPage::META_REPEAT_HEADERS);
            } else {
                $first = false;
            }

            $record = array(
                (empty($vendorW['vendor']) ? '(blank)' : $vendorW['vendor']),
                '', // blank brand on vendor row
                $vendorW['nonLocal'],
            );
            foreach ($this->localSettings as $id => $name) {
                $record[] = $vendorW['local' . $id];
            }
            $record['meta'] = FannieReportPage::META_BOLD;
            $data[] = $record;
            $brandR = $dbc->execute($brandP, array($vendorW['vendorID']));
            while ($brandW = $dbc->fetch_row($brandR)) {
                $has_local = false;
                foreach ($this->localSettings as $id => $name) {
                    if ($brandW['local' . $id] > 0) {
                        $has_local = true;
                        break;
                    }
                }
                if (!$has_local) {
                    continue;
                }
                $record = array(
                    '', // blank vendor on brand row
                    (empty($brandW['brand']) ? '(blank)' : $brandW['brand']),
                    $brandW['nonLocal'],
                );
                foreach ($this->localSettings as $id => $name) {
                    $record[] = $brandW['local' . $id];
                }
                $data[] = $record;
            }
        }

        return $data;
    }

    public function form_content()
    {
        return '<!-- not required -->';
    }

    public function helpContent()
    {
        return '<p>
            This report lists the total number of products
            from each vendor as well as each brand within a vendor. The number of
            products designated as local is also listed. It can be
            used to check for discrepancies when products from a
            brand or vendor has inconsistent local designations.
            </p>';
    }

}

FannieDispatch::conditionalExec();