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() |
||
| 234 | { |
||
| 235 | $context = parent::getDefaultSearchContext(); |
||
| 236 | $fields = $context->getFields(); |
||
| 237 | $fields->push( |
||
| 238 | ListboxField::create("Status", _t('Order.db_Status', "Status")) |
||
| 239 | ->setSource( |
||
| 240 | array_combine( |
||
| 241 | self::config()->placed_status, |
||
| 242 | self::config()->placed_status |
||
| 243 | ) |
||
| 244 | ) |
||
| 245 | ->setMultiple(true) |
||
| 246 | ); |
||
| 247 | |||
| 248 | // add date range filtering |
||
| 249 | $fields->insertBefore( |
||
| 250 | DateField::create("DateFrom", _t('Order.DateFrom', "Date from")) |
||
| 251 | ->setConfig('showcalendar', true), |
||
| 252 | 'Status' |
||
| 253 | ); |
||
| 254 | $fields->insertBefore( |
||
| 255 | DateField::create("DateTo", _t('Order.DateTo', "Date to")) |
||
| 256 | ->setConfig('showcalendar', true), |
||
| 257 | 'Status' |
||
| 258 | ); |
||
| 259 | |||
| 260 | // get the array, to maniplulate name, and fullname seperately |
||
| 261 | $filters = $context->getFilters(); |
||
| 262 | $filters['DateFrom'] = GreaterThanFilter::create('Placed'); |
||
| 263 | $filters['DateTo'] = LessThanFilter::create('Placed'); |
||
| 264 | |||
| 265 | // filter customer need to use a bunch of different sources |
||
| 266 | $filters['FirstName'] = new MultiFieldPartialMatchFilter( |
||
| 267 | 'FirstName', false, |
||
| 268 | array('SplitWords'), |
||
| 269 | array( |
||
| 270 | 'Surname', |
||
| 271 | 'Member.FirstName', |
||
| 272 | 'Member.Surname', |
||
| 273 | 'BillingAddress.FirstName', |
||
| 274 | 'BillingAddress.Surname', |
||
| 275 | 'ShippingAddress.FirstName', |
||
| 276 | 'ShippingAddress.Surname', |
||
| 277 | ) |
||
| 278 | ); |
||
| 279 | |||
| 280 | $context->setFilters($filters); |
||
| 281 | |||
| 282 | $this->extend('updateDefaultSearchContext', $context); |
||
| 283 | return $context; |
||
| 284 | } |
||
| 285 | |||
| 286 | /** |
||
| 287 | * Hack for swapping out relation list with OrderItemList |
||
| 288 | */ |
||
| 289 | 36 | public function getComponents($componentName, $filter = "", $sort = "", $join = "", $limit = null) |
|
| 303 | |||
| 304 | /** |
||
| 305 | * Returns the subtotal of the items for this order. |
||
| 306 | */ |
||
| 307 | 19 | public function SubTotal() |
|
| 315 | |||
| 316 | /** |
||
| 317 | * Calculate the total |
||
| 318 | * |
||
| 319 | * @return the final total |
||
| 320 | */ |
||
| 321 | 15 | public function calculate() |
|
| 329 | |||
| 330 | /** |
||
| 331 | * This is needed to maintain backwards compatiability with |
||
| 332 | * some subsystems using modifiers. eg discounts |
||
| 333 | */ |
||
| 334 | public function getModifier($className, $forcecreate = false) |
||
| 339 | |||
| 340 | /** |
||
| 341 | * Enforce rounding precision when setting total |
||
| 342 | */ |
||
| 343 | 67 | public function setTotal($val) |
|
| 347 | |||
| 348 | /** |
||
| 349 | * Get final value of order. |
||
| 350 | * Retrieves value from DataObject's record array. |
||
| 351 | */ |
||
| 352 | 15 | public function Total() |
|
| 356 | |||
| 357 | /** |
||
| 358 | * Alias for Total. |
||
| 359 | */ |
||
| 360 | 13 | public function GrandTotal() |
|
| 364 | |||
| 365 | /** |
||
| 366 | * Calculate how much is left to be paid on the order. |
||
| 367 | * Enforces rounding precision. |
||
| 368 | * |
||
| 369 | * Payments that have been authorized via a non-manual gateway should count towards the total paid amount. |
||
| 370 | * However, it's possible to exclude these by setting the $includeAuthorized parameter to false, which is |
||
| 371 | * useful to determine the status of the Order. Order status should only change to 'Paid' when all |
||
| 372 | * payments are 'Captured'. |
||
| 373 | * |
||
| 374 | * @param bool $includeAuthorized whether or not to include authorized payments (excluding manual payments) |
||
| 375 | * @return float |
||
| 376 | */ |
||
| 377 | 11 | public function TotalOutstanding($includeAuthorized = true) |
|
| 384 | |||
| 385 | /** |
||
| 386 | * Get the order status. This will return a localized value if available. |
||
| 387 | * |
||
| 388 | * @return string the payment status |
||
| 389 | */ |
||
| 390 | 2 | public function getStatusI18N() |
|
| 394 | |||
| 395 | /** |
||
| 396 | * Get the link for finishing order processing. |
||
| 397 | */ |
||
| 398 | 2 | public function Link() |
|
| 405 | |||
| 406 | /** |
||
| 407 | * Returns TRUE if the order can be cancelled |
||
| 408 | * PRECONDITION: Order is in the DB. |
||
| 409 | * |
||
| 410 | * @return boolean |
||
| 411 | */ |
||
| 412 | 1 | public function canCancel() |
|
| 427 | |||
| 428 | /** |
||
| 429 | * Check if an order can be paid for. |
||
| 430 | * |
||
| 431 | * @return boolean |
||
| 432 | */ |
||
| 433 | 2 | public function canPay($member = null) |
|
| 443 | |||
| 444 | /* |
||
| 445 | * Prevent deleting orders. |
||
| 446 | * @return boolean |
||
| 447 | */ |
||
| 448 | public function canDelete($member = null) |
||
| 452 | |||
| 453 | /** |
||
| 454 | * Check if an order can be viewed. |
||
| 455 | * |
||
| 456 | * @return boolean |
||
| 457 | */ |
||
| 458 | public function canView($member = null) |
||
| 462 | |||
| 463 | /** |
||
| 464 | * Check if an order can be edited. |
||
| 465 | * |
||
| 466 | * @return boolean |
||
| 467 | */ |
||
| 468 | public function canEdit($member = null) |
||
| 472 | |||
| 473 | /** |
||
| 474 | * Prevent standard creation of orders. |
||
| 475 | * |
||
| 476 | * @return boolean |
||
| 477 | */ |
||
| 478 | public function canCreate($member = null, $context = array()) |
||
| 482 | |||
| 483 | /** |
||
| 484 | * Return the currency of this order. |
||
| 485 | * Note: this is a fixed value across the entire site. |
||
| 486 | * |
||
| 487 | * @return string |
||
| 488 | */ |
||
| 489 | 3 | public function Currency() |
|
| 493 | |||
| 494 | /** |
||
| 495 | * Get the latest email for this order. |
||
| 496 | */ |
||
| 497 | 3 | public function getLatestEmail() |
|
| 504 | |||
| 505 | /** |
||
| 506 | * Gets the name of the customer. |
||
| 507 | */ |
||
| 508 | public function getName() |
||
| 514 | |||
| 515 | public function getTitle() |
||
| 519 | |||
| 520 | /** |
||
| 521 | * Get shipping address, or member default shipping address. |
||
| 522 | */ |
||
| 523 | 1 | public function getShippingAddress() |
|
| 527 | |||
| 528 | /** |
||
| 529 | * Get billing address, if marked to use seperate address, otherwise use shipping address, |
||
| 530 | * or the member default billing address. |
||
| 531 | */ |
||
| 532 | 1 | public function getBillingAddress() |
|
| 540 | |||
| 541 | /** |
||
| 542 | * @param string $type - Billing or Shipping |
||
| 543 | * @return Address |
||
| 544 | * @throws Exception |
||
| 545 | */ |
||
| 546 | 1 | protected function getAddress($type) |
|
| 561 | |||
| 562 | /** |
||
| 563 | * Check if the two addresses saved differ. |
||
| 564 | * |
||
| 565 | * @return boolean |
||
| 566 | */ |
||
| 567 | public function getAddressesDiffer() |
||
| 571 | |||
| 572 | /** |
||
| 573 | * Has this order been sent to the customer? |
||
| 574 | * (at "Sent" status). |
||
| 575 | * |
||
| 576 | * @return boolean |
||
| 577 | */ |
||
| 578 | public function IsSent() |
||
| 582 | |||
| 583 | /** |
||
| 584 | * Is this order currently being processed? |
||
| 585 | * (at "Sent" OR "Processing" status). |
||
| 586 | * |
||
| 587 | * @return boolean |
||
| 588 | */ |
||
| 589 | public function IsProcessing() |
||
| 593 | |||
| 594 | /** |
||
| 595 | * Return whether this Order has been paid for (Status == Paid) |
||
| 596 | * or Status == Processing, where it's been paid for, but is |
||
| 597 | * currently in a processing state. |
||
| 598 | * |
||
| 599 | * @return boolean |
||
| 600 | */ |
||
| 601 | public function IsPaid() |
||
| 605 | |||
| 606 | public function IsCart() |
||
| 610 | |||
| 611 | /** |
||
| 612 | * Create a unique reference identifier string for this order. |
||
| 613 | */ |
||
| 614 | public function generateReference() |
||
| 627 | |||
| 628 | /** |
||
| 629 | * Get the reference for this order, or fall back to order ID. |
||
| 630 | */ |
||
| 631 | public function getReference() |
||
| 635 | |||
| 636 | /** |
||
| 637 | * Force creating an order reference |
||
| 638 | */ |
||
| 639 | public function onBeforeWrite() |
||
| 652 | |||
| 653 | /** |
||
| 654 | * delete attributes, statuslogs, and payments |
||
| 655 | */ |
||
| 656 | public function onBeforeDelete() |
||
| 664 | |||
| 665 | public function debug() |
||
| 686 | |||
| 687 | /** |
||
| 688 | * Provide i18n entities for the order class |
||
| 689 | * |
||
| 690 | * @return array |
||
| 691 | */ |
||
| 692 | public function provideI18nEntities() |
||
| 707 | } |
||
| 708 |
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.