SilverShop\Tasks\ShopMigrationTask

Complexity

Total Complexity

28

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	migrateShippingTaxValues()	0	2	1
A	migrateProductImages()	0	3	1
A	migrate()	0	8	1
A	migrateProductPrice()	0	9	3
A	migrateStatuses()	0	9	3
A	up()	0	6	1
A	migrateShippingValues()	0	22	6
A	migrateProductVariationsAttribues()	0	10	2
A	migrateOrders()	0	14	3
A	migrateOrderCalculation()	0	5	3
A	migrateMemberFields()	0	18	4

<?php

namespace SilverShop\Tasks;

use SilverShop\Model\Modifiers\Shipping\Base;
use SilverShop\Model\Order;
use SilverStripe\Dev\MigrationTask;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;

/**
 * TODO: Implement for 2.x to 3.x
 * Updates database to work with latest version of the code.
 */
class ShopMigrationTask extends MigrationTask
{
    /**
     * Choose how many orders get processed at a time.
     */
    public static $batch_size = 250;

    protected $title = 'Migrate Shop';

    protected $description = 'Where dev/build is not enough, this task updates database to work with latest version of shop module.
You may want to run the CartCleanupTask before migrating if you want to discard past carts.';

    /**
     * Migrate upwards
     */
    public function up()
    {
        $this->migrateOrders();
        $this->migrateProductPrice();
        $this->migrateProductVariationsAttribues();
        $this->migrateProductImages();
        //TODO: migrate CheckoutPage->TermsPageID to ShopConfig
    }

    /**
     * batch process orders
     */
    public function migrateOrders()
    {
        $start = $count = 0;
        $batch = Order::get()->sort('Created', 'ASC')->limit($start, self::$batch_size);
        while ($batch->exists()) {
            foreach ($batch as $order) {
                $this->migrate($order);
                echo '. ';
                $count++;
            }
            $start += self::$batch_size;
            $batch = $batch->limit($start, self::$batch_size);
        };
        echo "$count orders updated.\n<br/>";
    }

    /**
     * Perform migration scripts on a single order.
     */
    public function migrate(Order $order)
    {
        //TODO: set a from / to version to preform a migration with
        $this->migrateStatuses($order);
        $this->migrateMemberFields($order);
        $this->migrateShippingValues($order);
        $this->migrateOrderCalculation($order);
        $order->write();
    }

    public function migrateProductPrice()
    {
        $db = DB::get_conn();
        //if BasePrice has no values, but Price does, then copy from Price
        if ($db->hasTable('Product') && !DataObject::get_one('Product', '"BasePrice" > 0')) {

The method hasTable() does not exist on SilverStripe\ORM\Connect\Database.

            //TODO: warn against lost data
            DB::query('UPDATE "Product" SET "BasePrice" = "Price";');
            DB::query('UPDATE "Product_Live" SET "BasePrice" = "Price";');
            DB::query('UPDATE "Product_versions" SET "BasePrice" = "Price";');
            //TODO: rename, if possible without breaking migraton task next time it runs
            //$db->renameField("Product","Price","Price_obselete");
            //$db->renameField("Product_Live","Price","Price_obselete");
        }
    }

    /**
     * Rename all Product_Image ClassNames to Image
     * Added in v1.0
     */
    public function migrateProductImages()
    {
        DB::query('UPDATE "File" SET "ClassName"=\'Image\' WHERE "ClassName" = \'Product_Image\'');
    }

    /**
     * Customer and shipping details have been added to Order,
     * so that memberless (guest) orders can be placed.
     */
    public function migrateMemberFields($order)
    {
        if ($member = $order->Member()) {
            $fieldstocopy = [
                'FirstName',
                'Surname',
                'Email',
                'Address',
                'AddressLine2',
                'City',
                'Country',
                'HomePhone',
                'MobilePhone',
                'Notes',
            ];
            foreach ($fieldstocopy as $field) {
                if (!$order->$field) {
                    $order->$field = $member->$field;
                }
            }
        }
    }

    /**
     * Migrate old statuses
     */
    public function migrateStatuses($order)
    {
        switch ($order->Status) {
            case "Cancelled": //Pre version 0.5
                $order->Status = 'AdminCancelled';
                break;
            case "":
                $order->Status = 'Cart';
                break;
        }
    }

    /**
     * Convert shipping and tax columns into modifiers
     *
     * Applies to pre 0.6 sites
     */
    public function migrateShippingValues($order)
    {
        //TODO: see if this actually works..it probably needs to be writeen to a SQL query
        if ($order->hasShippingCost && abs($order->Shipping)) {
            $modifier1 = Base::create();
            $modifier1->Amount = $order->Shipping < 0 ? abs($order->Shipping) : $order->Shipping;
            $modifier1->Type = 'Chargable';
            $modifier1->OrderID = $order->ID;
            $modifier1->ShippingChargeType = 'Default';
            $modifier1->write();
            $order->hasShippingCost = null;
            $order->Shipping = null;
        }
        if ($order->AddedTax) {
            $modifier2 = \SilverShop\Model\Modifiers\Tax\Base::create();
            $modifier2->Amount = $order->AddedTax < 0 ? abs($order->AddedTax) : $order->AddedTax;
            $modifier2->Type = 'Chargable';
            $modifier2->OrderID = $order->ID;
            //$modifier2->Name = 'Undefined After Ecommerce Upgrade';
            $modifier2->TaxType = 'Exclusive';
            $modifier2->write();
            $order->AddedTax = null;
        }
    }

    /**
     * Performs calculation function on un-calculated orders.
     */
    public function migrateOrderCalculation($order)
    {
        if (!is_numeric($order->Total) || $order->Total <= 0) {
            $order->calculate();
            $order->write();
        }
    }

    public function migrateProductVariationsAttribues()
    {
        $db = DB::get_conn();
        //TODO: delete Product_VariationAttribute, if it's empty
        if ($db->hasTable(
            'Product_VariationAttributes'
        )
        ) { //TODO: check if Product_VariationAttributeTypes table is empty
            DB::query('DROP TABLE "Product_VariationAttributeTypes"');
            $db->renameTable('Product_VariationAttributes', 'Product_VariationAttributeTypes');

The method renameTable() does not exist on SilverStripe\ORM\Connect\Database.

        }
    }

    public function migrateShippingTaxValues()
    {
        //rename obselete columns
        //DB::query("ALTER TABLE \"Order\" CHANGE COLUMN \"hasShippingCost\" \"_obsolete_hasShippingCost\" tinyint(1)");
        //DB::query("ALTER TABLE \"Order\" CHANGE COLUMN \"Shipping\" \"_obsolete_Shipping\" decimal(9,2)");
        //DB::query("ALTER TABLE \"Order\" CHANGE COLUMN \"AddedTax\" \"_obsolete_AddedTax\" decimal(9,2)");
    }
}