File Controllers/HttpView/AdminAjax/InvoicesOverviewAjaxController.inc.php

  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

<?php
/* --------------------------------------------------------------
   InvoicesOverviewAjaxController.inc.php 2016-10-11
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2016 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

/**
 * Class InvoicesAjaxController
 *
 * AJAX controller for the invoices main page.
 *
 * @category   System
 * @package    AdminHttpViewControllers
 * @extends    AdminHttpViewController
 */
class InvoicesOverviewAjaxController extends AdminHttpViewController
{
    /**
     * @var CI_DB_query_builder
     */
    protected $db;
    
    /**
     * @var InvoiceArchiveReadService
     */
    protected $invoiceArchiveReadService;
    /**
     * @var DataTableHelper
     */
    protected $dataTableHelper;
    
    /**
     * @var InvoicesOverviewColumns
     */
    protected $invoicesOverviewColumns;
    
    /**
     * @var InvoicesOverviewTooltips
     */
    protected $invoicesOverviewTooltips;
    
    
    /**
     * Initialize Controller
     */
    public function init()
    {
        // Check page token validity.
        $this->_validatePageToken();
        
        $this->db                        = StaticGXCoreLoader::getDatabaseQueryBuilder();
        $this->invoiceArchiveReadService = StaticGXCoreLoader::getService('InvoiceArchiveRead');
        $this->dataTableHelper           = MainFactory::create('DataTableHelper');
        $this->invoicesOverviewColumns   = MainFactory::create('InvoicesOverviewColumns', $this->db);
        $this->invoicesOverviewTooltips  = MainFactory::create('InvoicesOverviewTooltips');
    }
    
    
    /**
     * DataTable Instance Callback
     *
     * Provides the data for the DataTables instance of the invoices overview.
     */
    public function actionDataTable()
    {
        try
        {
            $tableData = $this->_getTableData();
            
            $response = [
                'draw'            => (int)$_REQUEST['draw'],
                'recordsTotal'    => $this->_getTotalRecordCount(),
                'recordsFiltered' => $this->_getFilteredRecordCount(),
                'data'            => $tableData
            ];
        }
        catch(Exception $ex)
        {
            $response = AjaxException::response($ex);
        }
        
        return MainFactory::create('JsonHttpControllerResponse', $response);
    }
    
    
    /**
     * DataTable Tooltips Rendering
     *
     * This method will use the InvoicesOverviewTooltips class to render all the tooltips of the current view.
     *
     * @return JsonHttpControllerResponse
     */
    public function actionTooltips()
    {
        try
        {
            $invoiceListItems = $this->_getInvoiceListItems();
            
            $response = [];
            
            /** @var InvoiceListItem $invoiceListItem */
            foreach($invoiceListItems as $invoiceListItem)
            {
                $response[$invoiceListItem->getInvoiceId()] = $this->invoicesOverviewTooltips->getRowTooltips($invoiceListItem);
            }
        }
        catch(Exception $ex)
        {
            $response = AjaxException::response($ex);
        }
        
        return MainFactory::create('JsonHttpControllerResponse', $response);
    }
    
    
    /**
     * Regenerate the filtering options and send them back to the client.
     *
     * After some specific changes the table filtering options will need to be updated because they do not contain
     * the required values from the table row. This method will use the InvoicesOverviewColumns class to fetch the
     * latest state of the filtering options.
     *
     * @return JsonHttpControllerResponse
     */
    public function actionFilterOptions()
    {
        try
        {
            // Create a new instance of the InvoicesOverviewColumns in order to fetch the latest options.
            $invoicesOverviewColumns = MainFactory::create('InvoicesOverviewColumns', $this->db);
            
            $response = [];
            
            /** @var DataTableColumn $dataTableColumn */
            foreach($invoicesOverviewColumns->getColumns() as $dataTableColumn)
            {
                $options = $dataTableColumn->getOptions();
                
                if(count($options) > 0)
                {
                    $response[$dataTableColumn->getName()] = $dataTableColumn->getOptions();
                }
            }
        }
        catch(Exception $ex)
        {
            $response = AjaxException::response($ex);
        }
        
        return MainFactory::create('JsonHttpControllerResponse', $response);
    }
    
    
    /**
     * Parse the DataTable request and fetch the InvoiceListItems that need to be displayed.
     *
     * @return InvoiceListItemCollection Returns the collection with the InvoiceListItem instances.
     */
    protected function _getInvoiceListItems()
    {
        // DataTable Column Info
        $columns = $this->invoicesOverviewColumns->getColumns();
        
        // Paginate Records
        $startIndex = new IntType($_REQUEST['start']);
        $maxCount   = new IntType($_REQUEST['length']);
        
        // Sort the order records. 
        $orderBy = new StringType($this->dataTableHelper->getOrderByClause($columns));
        
        // Get the filter parameters.  
        $filterParameters = $this->dataTableHelper->getFilterParameters($columns);
        
        $invoiceListItems = $this->invoiceArchiveReadService->filterInvoiceList($filterParameters, $startIndex,
                                                                                $maxCount, $orderBy);
        
        return $invoiceListItems;
    }
    
    
    /**
     * Get the table data.
     *
     * This method will generate the data of the datatable instance. It can be overloaded in order to contain extra
     * data e.g. for a new column. The filtering of custom columns must be also done manually.
     *
     * @return array
     */
    protected function _getTableData()
    {
        $currenciesArray = $this->_getCurrencies();
        
        $invoiceListItems = $this->_getInvoiceListItems();
        
        $tableData = [];
        
        /** @var InvoiceListItem $invoiceListItem */
        foreach($invoiceListItems as $invoiceListItem)
        {
            if(array_key_exists($invoiceListItem->getCurrency()->getCode(), $currenciesArray))
            {
                $currency = $currenciesArray[$invoiceListItem->getCurrency()->getCode()];
            }
            else
            {
                $currency = $currenciesArray[DEFAULT_CURRENCY];
            }
            
            $tableData[] = [
                'DT_RowId'       => $invoiceListItem->getInvoiceId(),
                'DT_RowData'     => $this->_getRowData($invoiceListItem),
                'invoiceNumber'  => $invoiceListItem->getInvoiceNumber(),
                'invoiceDate'    => $invoiceListItem->getInvoiceDate()->format('Y-m-d H:i:s'),
                'sum'            => number_format($invoiceListItem->getTotalSum(), (int)$currency['decimal_places'],
                                                  $currency['decimal_point'], $currency['thousands_point']) . ' '
                                    . $currency['symbol_right'],
                'customer'       => $invoiceListItem->getCustomerName(),
                'group'          => $invoiceListItem->getCustomerStatusName(),
                'countryIsoCode' => $invoiceListItem->getShippingAddress()->getCountryIsoCode(),
                'orderId'        => $invoiceListItem->getOrderId(),
                'orderDate'      => $invoiceListItem->getOrderDatePurchased()->format('Y-m-d H:i:s'),
                'paymentMethod'  => $invoiceListItem->getPaymentType()->getAlias(),
                'status'         => $invoiceListItem->getOrderStatusName()
            ];
        }
        
        return $tableData;
    }
    
    
    /**
     * Set the <tr> row data.
     *
     * This method will return an array which will contain the data attributes of each row. These data are
     * used in JS as follows: "$('tr').data('propertyName')".
     *
     * Overload this method to provide your own data to the rows.
     *
     * @param InvoiceListItem $invoiceListItem
     *
     * @return array
     */
    protected function _getRowData(InvoiceListItem $invoiceListItem)
    {
        $rowData = [
            'statusId'              => $invoiceListItem->getOrderStatusId(),
            'orderId'               => $invoiceListItem->getOrderId(),
            'invoiceId'             => $invoiceListItem->getInvoiceId(),
            'invoiceNumber'         => $invoiceListItem->getInvoiceNumber(),
            'customerMemos'         => $invoiceListItem->getCustomerMemos()->getSerializedArray(),
            'paymentMethod'         => $invoiceListItem->getPaymentType()->getTitle(),
            'invoiceDate'           => $invoiceListItem->getInvoiceDate(),
            'filename'              => $invoiceListItem->getInvoiceFilename(),
            'country'               => $invoiceListItem->getPaymentAddress()->getCountry(),
            'customerName'          => $invoiceListItem->getCustomerName(),
            'currency'              => $invoiceListItem->getCurrency()->getCode(),
            'isCancellationInvoice' => $invoiceListItem->isCancellationInvoice()
        ];
        
        return $rowData;
    }
    
    
    /**
     * Get the total record count of the "orders" table.
     *
     * @return int
     */
    protected function _getTotalRecordCount()
    {
        return $this->db->count_all('invoices');
    }
    
    
    /**
     * Get the filtered record count of the "orders" table.
     *
     * @return int
     */
    protected function _getFilteredRecordCount()
    {
        $columns          = $this->invoicesOverviewColumns->getColumns();
        $filterParameters = $this->dataTableHelper->getFilterParameters($columns);
        
        return $this->invoiceArchiveReadService->filterInvoiceListCount($filterParameters);
    }
    
    
    /**
     * Get the currencies with all settings like decimal point.
     *
     * @return array
     */
    protected function _getCurrencies()
    {
        $currenciesArray  = [];
        $currenciesResult = $this->db->get('currencies');
        
        foreach($currenciesResult->result_array() as $currency)
        {
            $currenciesArray[$currency['code']] = $currency;
        }
        
        return $currenciesArray;
    }
}

Packages

Classes

Interfaces

Exceptions