Complex classes like Order often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Order, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
34 | class Order extends DataObject |
||
35 | { |
||
36 | /** |
||
37 | * Status codes and what they mean: |
||
38 | * |
||
39 | * Unpaid (default): Order created but no successful payment by customer yet |
||
40 | * Query: Order not being processed yet (customer has a query, or could be out of stock) |
||
41 | * Paid: Order successfully paid for by customer |
||
42 | * Processing: Order paid for, package is currently being processed before shipping to customer |
||
43 | * Sent: Order paid for, processed for shipping, and now sent to the customer |
||
44 | * Complete: Order completed (paid and shipped). Customer assumed to have received their goods |
||
45 | * AdminCancelled: Order cancelled by the administrator |
||
46 | * MemberCancelled: Order cancelled by the customer (Member) |
||
47 | */ |
||
48 | private static $db = array( |
||
49 | 'Total' => 'Currency', |
||
50 | 'Reference' => 'Varchar', //allow for customised order numbering schemes |
||
51 | //status |
||
52 | 'Placed' => "SS_Datetime", //date the order was placed (went from Cart to Order) |
||
53 | 'Paid' => 'SS_Datetime', //no outstanding payment left |
||
54 | 'ReceiptSent' => 'SS_Datetime', //receipt emailed to customer |
||
55 | 'Printed' => 'SS_Datetime', |
||
56 | 'Dispatched' => 'SS_Datetime', //products have been sent to customer |
||
57 | 'Status' => "Enum('Unpaid,Paid,Processing,Sent,Complete,AdminCancelled,MemberCancelled,Cart','Cart')", |
||
58 | //customer (for guest orders) |
||
59 | 'FirstName' => 'Varchar', |
||
60 | 'Surname' => 'Varchar', |
||
61 | 'Email' => 'Varchar', |
||
62 | 'Notes' => 'Text', |
||
63 | 'IPAddress' => 'Varchar(15)', |
||
64 | //separate shipping |
||
65 | 'SeparateBillingAddress' => 'Boolean', |
||
66 | // keep track of customer locale |
||
67 | 'Locale' => 'DBLocale', |
||
68 | ); |
||
69 | |||
70 | private static $has_one = array( |
||
71 | 'Member' => 'Member', |
||
72 | 'ShippingAddress' => 'Address', |
||
73 | 'BillingAddress' => 'Address', |
||
74 | ); |
||
75 | |||
76 | private static $has_many = array( |
||
77 | 'Items' => 'OrderItem', |
||
78 | 'Modifiers' => 'OrderModifier', |
||
79 | 'OrderStatusLogs' => 'OrderStatusLog', |
||
80 | ); |
||
81 | |||
82 | private static $defaults = array( |
||
83 | 'Status' => 'Cart', |
||
84 | ); |
||
85 | |||
86 | private static $casting = array( |
||
87 | 'FullBillingAddress' => 'Text', |
||
88 | 'FullShippingAddress' => 'Text', |
||
89 | 'Total' => 'Currency', |
||
90 | 'SubTotal' => 'Currency', |
||
91 | 'TotalPaid' => 'Currency', |
||
92 | 'Shipping' => 'Currency', |
||
93 | 'TotalOutstanding' => 'Currency', |
||
94 | ); |
||
95 | |||
96 | private static $summary_fields = array( |
||
97 | 'Reference' => 'Order No', |
||
98 | 'Placed' => 'Date', |
||
99 | 'Name' => 'Customer', |
||
100 | 'LatestEmail' => 'Email', |
||
101 | 'Total' => 'Total', |
||
102 | 'Status' => 'Status', |
||
103 | ); |
||
104 | |||
105 | private static $searchable_fields = array( |
||
106 | 'Reference' => array(), |
||
107 | 'FirstName' => array( |
||
108 | 'title' => 'Customer Name', |
||
109 | ), |
||
110 | 'Email' => array( |
||
111 | 'title' => 'Customer Email', |
||
112 | ), |
||
113 | 'Status' => array( |
||
114 | 'filter' => 'ExactMatchFilter', |
||
115 | 'field' => 'CheckboxSetField', |
||
116 | ), |
||
117 | ); |
||
118 | |||
119 | private static $singular_name = "Order"; |
||
120 | |||
121 | private static $plural_name = "Orders"; |
||
122 | |||
123 | private static $default_sort = "\"Placed\" DESC, \"Created\" DESC"; |
||
124 | |||
125 | /** |
||
126 | * Statuses for orders that have been placed. |
||
127 | */ |
||
128 | private static $placed_status = array( |
||
129 | 'Paid', |
||
130 | 'Unpaid', |
||
131 | 'Processing', |
||
132 | 'Sent', |
||
133 | 'Complete', |
||
134 | 'MemberCancelled', |
||
135 | 'AdminCancelled', |
||
136 | ); |
||
137 | |||
138 | /** |
||
139 | * Statuses for which an order can be paid for |
||
140 | */ |
||
141 | private static $payable_status = array( |
||
142 | 'Cart', |
||
143 | 'Unpaid', |
||
144 | 'Processing', |
||
145 | 'Sent', |
||
146 | ); |
||
147 | |||
148 | /** |
||
149 | * Statuses that shouldn't show in user account. |
||
150 | */ |
||
151 | private static $hidden_status = array('Cart'); |
||
152 | |||
153 | /** |
||
154 | * Flags to determine when an order can be cancelled. |
||
155 | */ |
||
156 | private static $cancel_before_payment = true; |
||
157 | |||
158 | private static $cancel_before_processing = false; |
||
159 | |||
160 | private static $cancel_before_sending = false; |
||
161 | |||
162 | private static $cancel_after_sending = false; |
||
163 | |||
164 | /** |
||
165 | * Place an order before payment processing begins |
||
166 | * |
||
167 | * @var boolean |
||
168 | */ |
||
169 | private static $place_before_payment = false; |
||
170 | |||
171 | /** |
||
172 | * Modifiers represent the additional charges or |
||
173 | * deductions associated to an order, such as |
||
174 | * shipping, taxes, vouchers etc. |
||
175 | */ |
||
176 | private static $modifiers = array(); |
||
177 | |||
178 | private static $rounding_precision = 2; |
||
179 | |||
180 | private static $reference_id_padding = 5; |
||
181 | |||
182 | /** |
||
183 | * @var boolean Will allow completion of orders with GrandTotal=0, |
||
184 | * which could be the case for orders paid with loyalty points or vouchers. |
||
185 | * Will send the "Paid" date on the order, even though no actual payment was taken. |
||
186 | * Will trigger the payment related extension points: |
||
187 | * Order->onPayment, OrderItem->onPayment, Order->onPaid. |
||
188 | */ |
||
189 | private static $allow_zero_order_total = false; |
||
190 | |||
191 | public static function get_order_status_options() |
||
199 | |||
200 | /** |
||
201 | * Create CMS fields for cms viewing and editing orders |
||
202 | */ |
||
203 | public function getCMSFields() |
||
227 | |||
228 | /** |
||
229 | * Adjust scafolded search context |
||
230 | * |
||
231 | * @return SearchContext the updated search context |
||
232 | */ |
||
233 | public function getDefaultSearchContext() |
||
284 | |||
285 | /** |
||
286 | * Hack for swapping out relation list with OrderItemList |
||
287 | */ |
||
288 | 33 | public function getComponents($componentName, $filter = "", $sort = "", $join = "", $limit = null) |
|
302 | |||
303 | /** |
||
304 | * Returns the subtotal of the items for this order. |
||
305 | */ |
||
306 | 12 | public function SubTotal() |
|
314 | |||
315 | /** |
||
316 | * Calculate the total |
||
317 | * |
||
318 | * @return the final total |
||
319 | */ |
||
320 | 8 | public function calculate() |
|
328 | |||
329 | /** |
||
330 | * This is needed to maintain backwards compatiability with |
||
331 | * some subsystems using modifiers. eg discounts |
||
332 | */ |
||
333 | public function getModifier($className, $forcecreate = false) |
||
338 | |||
339 | /** |
||
340 | * Enforce rounding precision when setting total |
||
341 | */ |
||
342 | 63 | public function setTotal($val) |
|
346 | |||
347 | /** |
||
348 | * Get final value of order. |
||
349 | * Retrieves value from DataObject's record array. |
||
350 | */ |
||
351 | 14 | public function Total() |
|
355 | |||
356 | /** |
||
357 | * Alias for Total. |
||
358 | */ |
||
359 | 12 | public function GrandTotal() |
|
363 | |||
364 | /** |
||
365 | * Calculate how much is left to be paid on the order. |
||
366 | * Enforces rounding precision. |
||
367 | * |
||
368 | * Payments that have been authorized via a non-manual gateway should count towards the total paid amount. |
||
369 | * However, it's possible to exclude these by setting the $includeAuthorized parameter to false, which is |
||
370 | * useful to determine the status of the Order. Order status should only change to 'Paid' when all |
||
371 | * payments are 'Captured'. |
||
372 | * |
||
373 | * @param bool $includeAuthorized whether or not to include authorized payments (excluding manual payments) |
||
374 | * @return float |
||
375 | */ |
||
376 | 10 | public function TotalOutstanding($includeAuthorized = true) |
|
383 | |||
384 | /** |
||
385 | * Get the order status. This will return a localized value if available. |
||
386 | * |
||
387 | * @return string the payment status |
||
388 | */ |
||
389 | 2 | public function getStatusI18N() |
|
393 | |||
394 | /** |
||
395 | * Get the link for finishing order processing. |
||
396 | */ |
||
397 | 2 | public function Link() |
|
404 | |||
405 | /** |
||
406 | * Returns TRUE if the order can be cancelled |
||
407 | * PRECONDITION: Order is in the DB. |
||
408 | * |
||
409 | * @return boolean |
||
410 | */ |
||
411 | 1 | public function canCancel() |
|
426 | |||
427 | /** |
||
428 | * Check if an order can be paid for. |
||
429 | * |
||
430 | * @return boolean |
||
431 | */ |
||
432 | 2 | public function canPay($member = null) |
|
442 | |||
443 | /* |
||
444 | * Prevent deleting orders. |
||
445 | * @return boolean |
||
446 | */ |
||
447 | public function canDelete($member = null) |
||
451 | |||
452 | /** |
||
453 | * Check if an order can be viewed. |
||
454 | * |
||
455 | * @return boolean |
||
456 | */ |
||
457 | public function canView($member = null) |
||
461 | |||
462 | /** |
||
463 | * Check if an order can be edited. |
||
464 | * |
||
465 | * @return boolean |
||
466 | */ |
||
467 | public function canEdit($member = null) |
||
471 | |||
472 | /** |
||
473 | * Prevent standard creation of orders. |
||
474 | * |
||
475 | * @return boolean |
||
476 | */ |
||
477 | public function canCreate($member = null, $context = array()) |
||
481 | |||
482 | /** |
||
483 | * Return the currency of this order. |
||
484 | * Note: this is a fixed value across the entire site. |
||
485 | * |
||
486 | * @return string |
||
487 | */ |
||
488 | 3 | public function Currency() |
|
492 | |||
493 | /** |
||
494 | * Get the latest email for this order. |
||
495 | */ |
||
496 | 3 | public function getLatestEmail() |
|
503 | |||
504 | /** |
||
505 | * Gets the name of the customer. |
||
506 | */ |
||
507 | public function getName() |
||
513 | |||
514 | public function getTitle() |
||
518 | |||
519 | /** |
||
520 | * Get shipping address, or member default shipping address. |
||
521 | */ |
||
522 | 1 | public function getShippingAddress() |
|
526 | |||
527 | /** |
||
528 | * Get billing address, if marked to use seperate address, otherwise use shipping address, |
||
529 | * or the member default billing address. |
||
530 | */ |
||
531 | 1 | public function getBillingAddress() |
|
539 | |||
540 | /** |
||
541 | * @param string $type - Billing or Shipping |
||
542 | * @return Address |
||
543 | * @throws Exception |
||
544 | */ |
||
545 | 1 | protected function getAddress($type) |
|
560 | |||
561 | /** |
||
562 | * Check if the two addresses saved differ. |
||
563 | * |
||
564 | * @return boolean |
||
565 | */ |
||
566 | public function getAddressesDiffer() |
||
570 | |||
571 | /** |
||
572 | * Has this order been sent to the customer? |
||
573 | * (at "Sent" status). |
||
574 | * |
||
575 | * @return boolean |
||
576 | */ |
||
577 | public function IsSent() |
||
581 | |||
582 | /** |
||
583 | * Is this order currently being processed? |
||
584 | * (at "Sent" OR "Processing" status). |
||
585 | * |
||
586 | * @return boolean |
||
587 | */ |
||
588 | public function IsProcessing() |
||
592 | |||
593 | /** |
||
594 | * Return whether this Order has been paid for (Status == Paid) |
||
595 | * or Status == Processing, where it's been paid for, but is |
||
596 | * currently in a processing state. |
||
597 | * |
||
598 | * @return boolean |
||
599 | */ |
||
600 | public function IsPaid() |
||
604 | |||
605 | public function IsCart() |
||
609 | |||
610 | /** |
||
611 | * Create a unique reference identifier string for this order. |
||
612 | */ |
||
613 | public function generateReference() |
||
626 | |||
627 | /** |
||
628 | * Get the reference for this order, or fall back to order ID. |
||
629 | */ |
||
630 | public function getReference() |
||
634 | |||
635 | /** |
||
636 | * Force creating an order reference |
||
637 | */ |
||
638 | public function onBeforeWrite() |
||
651 | |||
652 | /** |
||
653 | * delete attributes, statuslogs, and payments |
||
654 | */ |
||
655 | public function onBeforeDelete() |
||
663 | |||
664 | public function debug() |
||
685 | |||
686 | /** |
||
687 | * Provide i18n entities for the order class |
||
688 | * |
||
689 | * @return array |
||
690 | */ |
||
691 | public function provideI18nEntities() |
||
706 | } |
||
707 |
Too many fields generally indicate a class which does too much and does not follow the single responsibility principle.
We suggest taking a look at the “Code” section for further suggestions on how to fix this.