File Services/Core/Invoice/InvoiceListGenerator.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

<?php

/* --------------------------------------------------------------
   InvoiceListGenerator.inc.php 24.04.16
   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 InvoiceListGenerator
 *
 * @category   System
 * @package    Invoice
 */
class InvoiceListGenerator implements InvoiceListGeneratorInterface
{
    /**
     * @var \CI_DB_query_builder
     */
    private $db;


    /**
     * InvoiceListGenerator constructor.
     *
     * @param \CI_DB_query_builder $db
     */
    public function __construct(CI_DB_query_builder $db)
    {
        $this->db = $db;
    }
    

    /**
     * Returns an invoice list item collection by the given conditions.
     * The other arguments helps to control fetched data.
     *
     * @param array            $conditions (Optional) Conditions for tht where clause.
     * @param \IntType|null    $startIndex (Optional) Start index for the limit clause.
     * @param \IntType|null    $maxCount   (Optional) Max count for the limit clause.
     * @param \StringType|null $orderBy    (Optional) Sort order of fetched data.
     *
     * @return InvoiceListItemCollection
     */
    public function getInvoiceListByConditions(array $conditions = [],
                                               IntType $startIndex = null,
                                               IntType $maxCount = null,
                                               StringType $orderBy = null)
    {

        $this->_select()->_limit($startIndex, $maxCount)->_order($orderBy);

        if(count($conditions) > 0)
        {
            $this->db->where($conditions);
        }

        $test = $this->db->get()->result_array();

        return $this->_prepareCollection($test);
    }
    

    /**
     * Prepares the InvoiceListItemCollection by the passed result array.
     *
     * @param array $resultArray Result array with fetched invoice data.
     *
     * @return \InvoiceListItemCollection
     */
    protected function _prepareCollection(array $resultArray)
    {
        $items = [];
        foreach($resultArray as $row)
        {
            $invoiceId          = new IdType($row['invoice_id']);
            $invoiceNumber      = new StringType($row['invoice_number']);
            $invoiceDate        = new DateTime($row['invoice_date']);
            $totalSum           = new DecimalType($row['total_sum']);
            $currencyCode       = MainFactory::create('CurrencyCode', new StringType($row['currency']));
            $customerId         = new IdType($row['customer_id']);
            $customerName       = new StringType($row['customers_firstname'] . ' ' . $row['customers_lastname']);
            $customerStatusId   = new IdType($row['customer_status_id']);
            $customerStatusName = new StringType($row['customer_status_name']);
            $customerMemos      = $this->_createMemoCollectionByCustomersId($row['customer_id']);

            $paymentAddress  = $this->_createOrderAddressBlockByRow('billing', $row);
            $shippingAddress = $this->_createOrderAddressBlockByRow('delivery', $row);

            $orderId            = new IdType($row['order_id']);
            $orderDatePurchased = new DateTime($row['order_date_purchased']);
            $paymentType        = new OrderPaymentType(new StringType($row['payment_class']),
                                                       new StringType($row['payment_method']));

            $orderStatusArray = $this->_createOrderStatusArrayByOrderId($row['order_id']);
            $orderStatusId    = new IdType($orderStatusArray['orders_status']);
            $orderStatusName  = new StringType($orderStatusArray['orders_status_name']);

            $items[] = new InvoiceListItem($invoiceId, $invoiceNumber, $invoiceDate, $totalSum, $currencyCode,
                                           $customerId, $customerName, $customerStatusId, $customerStatusName,
                                           $customerMemos, $paymentAddress, $shippingAddress, $orderId,
                                           $orderDatePurchased, $paymentType, $orderStatusId, $orderStatusName);
        }

        return MainFactory::create('InvoiceListItemCollection', $items);
    }
    

    /**
     * Creates an order status array by the given order id.
     * The returned array is associative and contains the
     * keys orders_status and orders_status_name.
     *
     * @param int $orderId orders_id of expected entry.
     *
     * @return array Contains the order status id and name.
     */
    protected function _createOrderStatusArrayByOrderId($orderId)
    {
        $orderStatusId = $this->db->select('orders_status, orders_status.orders_status_name')
                                  ->from('orders')
                                  ->join('orders_status', 'orders.orders_status = orders_status.orders_status_id')
                                  ->where(['orders_id' => $orderId])
                                  ->get()
                                  ->row_array();

        return $orderStatusId;
    }


    /**
     * Creates an order address block object by the given type and row_array (looped result of CIDB::result_array())
     *
     * @param string $type Whether delivery or billing.
     * @param array  $row  Array which contain data about an order result row.
     *
     * @Todo Equal to OrderListGenerator::_createOrderAddressBlockByRow() method. Maybe outsource in abstract parent.
     *
     * @return \OrderAddressBlock
     */
    protected function _createOrderAddressBlockByRow($type, array $row)
    {
        if($type !== 'delivery' && $type !== 'billing')
        {
            throw new BadMethodCallException('the "$type" argument has to be equal to whether "delivery" or "billing"');
        }

        $firstName             = new StringType($row[$type . '_firstname']);
        $lastName              = new StringType($row[$type . '_lastname']);
        $company               = new StringType($row[$type . '_company']);
        $streetAddress         = new StringType($row[$type . '_street_address']);
        $houseNumber           = new StringType($row[$type . '_house_number']);
        $additionalAddressInfo = new StringType($row[$type . '_additional_info']);
        $postCode              = new StringType($row[$type . '_postcode']);
        $city                  = new StringType($row[$type . '_city']);
        $state                 = new StringType($row[$type . '_state']);
        $country               = new StringType($row[$type . '_country']);
        $countryIsoCode        = new StringType($row[$type . '_country_iso_code_2']);

        return MainFactory::create('OrderAddressBlock', $firstName, $lastName, $company, $streetAddress, $houseNumber,
                                   $additionalAddressInfo, $postCode, $city, $state, $country, $countryIsoCode);
    }


    /**
     * Creates and returns a customer memo collection by the given customers id.
     *
     * @param int $customersId Id of customer.
     *
     * @Todo Equal to OrderListGenerator::_createMemoCollectionByCustomersId() method. Maybe outsource in abstract
     *       parent.
     *
     * @return \CustomerMemoCollection
     */
    protected function _createMemoCollectionByCustomersId($customersId)
    {
        $memoArray = $this->db->get_where('customers_memo', array('customers_id' => $customersId))->result_array();
        $memos     = array();

        foreach($memoArray as $customerMemo)
        {
            $memos[] = MainFactory::create('CustomerMemo', MainFactory::create('IdType', $customerMemo['customers_id']),
                                           MainFactory::create('StringType', $customerMemo['memo_title']),
                                           MainFactory::create('StringType', $customerMemo['memo_text']),
                                           MainFactory::create('DateTime', $customerMemo['memo_date']),
                                           MainFactory::create('IdType', $customerMemo['poster_id']));
        }

        return MainFactory::create('CustomerMemoCollection', $memos);
    }


    /**
     * Execute the select and join methods.
     *
     * @return $this|InvoiceListGenerator Returns the instance object for method chaining.
     */
    protected function _select()
    {
        $this->db->select()->from('invoices');

        return $this;
    }


    /**
     * Add limit configuration to the database object.
     *
     * @param \IntType $startIndex
     * @param \IntType $maxCount
     *
     * @Todo Equal to OrderListGenerator::_limit() method. Maybe outsource in abstract parent.
     *
     * @return $this|InvoiceListGenerator Returns the instance object for method chaining.
     */
    protected function _limit(IntType $startIndex = null, IntType $maxCount = null)
    {
        if($maxCount && $startIndex)
        {
            $this->db->limit($maxCount->asInt(), $startIndex->asInt());
        }
        else
        {
            if($maxCount && !$startIndex)
            {
                $this->db->limit($maxCount->asInt());
            }
        }

        return $this;
    }


    /**
     * Set the order by clause of the query.
     *
     * @param \StringType $orderBy
     *
     * @Todo Equal to OrderListGenerator::_order() method. Maybe outsource in abstract parent.
     *
     * @return $this|InvoiceListGenerator Returns the instance object for method chaining.
     */
    protected function _order(StringType $orderBy = null)
    {
        if($orderBy)
        {
            $this->db->order_by($orderBy->asString());
        }

        return $this;
    }
}

Packages

Classes

Interfaces

Exceptions