File Extensions/Orders/OrdersOverviewColumns.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 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

<?php

/* --------------------------------------------------------------
   OrdersOverviewColumns.inc.php 2016-09-29
   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]
   --------------------------------------------------------------
*/

require_once DIR_FS_CATALOG . 'inc/get_payment_title.inc.php';
require_once DIR_FS_CATALOG . 'inc/get_shipping_title.inc.php';

/**
 * Class OrdersOverviewColumns
 *
 * This class contains the definition of the order columns. Use it in every controller that needs the
 * column definition.
 *
 * This class can be overloaded and more table columns can be added.
 *
 * @category   System
 * @package    Extensions
 * @subpackage Orders
 */
class OrdersOverviewColumns
{
    /**
     * @var CI_DB_query_builder
     */
    protected $db;
    
    /**
     * @var array
     */
    protected $columns;
    
    /**
     * @var string
     */
    protected $noValuePlaceholder; 
    
    
    /**
     * OrdersOverviewColumns constructor
     *
     * Overload this method and append the $columns array with new column definitions.
     *
     * @throws InvalidArgumentException
     */
    public function __construct()
    {
        $this->db            = StaticGXCoreLoader::getDatabaseQueryBuilder();
        
        $languageTextManager = MainFactory::create('LanguageTextManager', 'admin_orders', $_SESSION['languages_id']);
        $this->noValuePlaceholder = '(' . $languageTextManager->get_text('no_value', 'admin_labels') . ')';
        
        // Number
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('NUMBER')))
                                      ->setName(new StringType('number'))
                                      ->setField(new StringType('orders.orders_id'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::NUMBER));
        
        // Customer 
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('CUSTOMER')))
                                      ->setName(new StringType('customer'))
                                      ->setField(new StringType('orders.customers_lastname orders.customers_firstname'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::STRING));
        
        // Group
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('GROUP')))
                                      ->setName(new StringType('group'))
                                      ->setField(new StringType('orders.customers_status_name'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::STRING))
                                      ->setOptions($this->_getGroupOptions());
        
        // Sum
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('SUM')))
                                      ->setName(new StringType('sum'))
                                      ->setField(new StringType('orders_total.value'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::NUMBER));
        
        // Payment Method
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('PAYMENT')))
                                      ->setName(new StringType('paymentMethod'))
                                      ->setField(new StringType('orders.payment_class'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::STRING))
                                      ->setOptions($this->_getPaymentOptions());
        
        // Shipping Method
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('SHIPPING')))
                                      ->setName(new StringType('shippingMethod'))
                                      ->setField(new StringType('orders.shipping_class'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::STRING))
                                      ->setOptions($this->_getShippingOptions());
        
        // Country ISO Code
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('COUNTRY')))
                                      ->setName(new StringType('countryIsoCode'))
                                      ->setField(new StringType('orders.delivery_country_iso_code_2'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::STRING))
                                      ->setOptions($this->_getCountryOptions());
        
        // Date
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('DATE')))
                                      ->setName(new StringType('date'))
                                      ->setField(new StringType('orders.date_purchased'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::DATE));
        
        // Status
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('STATUS')))
                                      ->setName(new StringType('status'))
                                      ->setField(new StringType('orders_status.orders_status_name'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::STRING))
                                      ->setOptions($this->_getStatusOptions());
        
        // Total Weight
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('ORDER_WEIGHT_UNIT')))
                                      ->setName(new StringType('totalWeight'))
                                      ->setField(new StringType('orders.order_total_weight'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::NUMBER));
        
        // Invoice numbers
        $this->columns[] = MainFactory::create('DataTableColumn')
                                      ->setTitle(new StringType($languageTextManager->get_text('INVOICE_NUMBER', 'admin_invoices')))
                                      ->setName(new StringType('invoiceNumber'))
                                      ->setField(new StringType('invoice_numbers'))
                                      ->setType(new DataTableColumnType(DataTableColumnType::STRING));
    }
    
    
    /**
     * Get the DataTableColumnCollection of the table.
     *
     * @return DataTableColumnCollection
     */
    public function getColumns()
    {
        return MainFactory::create('DataTableColumnCollection', $this->columns);
    }
    
    
    /**
     * Get the column definitions in a plain array.
     *
     * @return array
     */
    public function serializeColumns()
    {
        $columns = [];
        
        /** @var DataTableColumn $dataTableColumn */
        foreach($this->columns as $dataTableColumn)
        {
            $columns[] = [
                'title'   => $dataTableColumn->getTitle(),
                'name'    => $dataTableColumn->getName(),
                'field'   => $dataTableColumn->getField(),
                'type'    => $dataTableColumn->getType(),
                'source'  => $dataTableColumn->getSource(),
                'options' => $dataTableColumn->getOptions()
            ];
        }
        
        return $columns;
    }
    
    
    /**
     * Get the customer group filtering options.
     *
     * @return array
     */
    public function _getGroupOptions()
    {
        $rows = $this->db->distinct()
                         ->select('orders.customers_status AS id, orders.customers_status_name AS fallback_name, '
                                  . 'customers_status.customers_status_name AS status_name')
                         ->from('orders')
                         ->join('customers_status', 'customers_status.customers_status_id = orders.customers_status',
                                'left')
                         ->join('languages', 'languages.languages_id = customers_status.language_id', 'left')
                         ->where('languages.languages_id', $_SESSION['languages_id'])
                         ->get()
                         ->result_array();
        
        $options = [];
        
        foreach($rows as $row)
        {
            $option = [
                // Value 
                $row['id'],
                // Text
                $row['status_name'] !== '' ? $row['status_name'] : $row['fallback_name']
            ];
            
            if(!in_array($option, $options))
            {
                $options[] = $option;
            }
        }
        
        return $this->_getMultiSelectOptions($options);
    }
    
    
    /**
     * Get the order status filtering options.
     *
     * @return array
     */
    public function _getStatusOptions()
    {
        $rows = $this->db->distinct()
                         ->select('orders.orders_status AS status_id, orders_status.orders_status_name AS status_name')
                         ->from('orders')
                         ->join('orders_status', 'orders_status.orders_status_id = orders.orders_status', 'inner')
                         ->where('orders_status.language_id', $_SESSION['languages_id'])
                         ->get()
                         ->result_array();
        
        $options = [];
        
        foreach($rows as $row)
        {
            $options[] = [
                // Value 
                $row['status_id'],
                // Text
                $row['status_name']
            ];
        }
        
        return $this->_getMultiSelectOptions($options);
    }
    
    
    /**
     * Get the payment method filtering options.
     *
     * @return array
     */
    public function _getPaymentOptions()
    {
        $rows = $this->db->distinct()->select('payment_class')->get('orders')->result_array();
        
        $options = [];
        
        foreach($rows as $row)
        {
            $aliasConstant      = 'MODULE_PAYMENT_' . strtoupper($row['payment_class']) . '_ALIAS';
            $paymentModuleTitle = $row['payment_class'] ? get_payment_title($row['payment_class']) : '';
            
            $options[] = [
                // Value
                $row['payment_class'],
                // Text 
                defined($aliasConstant) ? constant($aliasConstant) . ': ' . $paymentModuleTitle : $paymentModuleTitle
            ];
        }
        
        return $this->_getMultiSelectOptions($options);
    }
    
    
    /**
     * Get the shipping method filtering options.
     *
     * @return array
     */
    public function _getShippingOptions()
    {
        $rows = $this->db->distinct()->select('shipping_class')->get('orders')->result_array();
        
        $options = [];
        
        foreach($rows as $row)
        {
            // Handle special case where a module name is doubled (e.g. flat_flat).
            $explodedClassName = explode('_', $row['shipping_class']);
            $shippingClassName = (count($explodedClassName) === 2
                                  && $explodedClassName[0]
                                     === $explodedClassName[1]) ? $explodedClassName[0] : $row['shipping_class'];
            
            $aliasConstant       = 'MODULE_SHIPPING_' . strtoupper($shippingClassName) . '_ALIAS';
            $shippingModuleTitle = ($shippingClassName === '' ? '' : get_shipping_title($shippingClassName));
            
            $options[] = [
                // Value
                $row['shipping_class'],
                // Text
                defined($aliasConstant) ? constant($aliasConstant) . ': ' . $shippingModuleTitle : $shippingModuleTitle
            ];
        }
        
        return $this->_getMultiSelectOptions($options);
    }
    
    
    /**
     * Get the country filtering options.
     *
     * @return array
     */
    protected function _getCountryOptions()
    {
        $options = $this->db->distinct()
                            ->select('delivery_country_iso_code_2, delivery_country')
                            ->get('orders')
                            ->result_array();
        
        return $this->_getMultiSelectOptions($options);
    }
    
    
    /**
     * Convert the option to [value, text] arrays.
     *
     * The result of this method can be given back to multi_select widgets. If an option has different value
     * and text then the first entry must always be the value and the second the text to be displayed.
     *
     * @param array $options Contains the options of the multi_select widget.
     *
     * @return array
     */
    protected function _getMultiSelectOptions(array $options)
    {
        $multiSelectOptions = [];
        
        foreach($options as $option)
        {
            if(is_array($option))
            {
                $multiSelectOption = [
                    'value' => array_shift($option),
                    'text'  => array_shift($option)
                ];
            }
            else
            {
                $multiSelectOption = [
                    'value' => $option,
                    'text'  => $option
                ];
            }
            
            if($multiSelectOption['text'] === '')
            {
                $multiSelectOption['text'] = $this->noValuePlaceholder; 
            }
            
            $multiSelectOptions[] = $multiSelectOption;
        }
        
        return $multiSelectOptions;
    }
}

Packages

Classes

Interfaces

Exceptions