SilverCommerce\OrdersAdmin\Tasks\OrdersMigrationTask

Complexity

Total Complexity

22

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	down()	0	5	1
A	run()	0	6	2
F	up()	0	100	16
A	log()	0	8	3

<?php

namespace SilverCommerce\OrdersAdmin\Tasks;

use SilverStripe\ORM\DB;
use SilverStripe\Control\Director;
use SilverStripe\Dev\MigrationTask;
use SilverStripe\ORM\DatabaseAdmin;
use SilverStripe\Control\Controller;
use SilverCommerce\GeoZones\Model\Zone;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\Subsites\Model\Subsite;

The type SilverStripe\Subsites\Model\Subsite was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverCommerce\OrdersAdmin\Model\Invoice;
use SilverCommerce\OrdersAdmin\Model\Estimate;
use SilverCommerce\OrdersAdmin\Model\LineItem;
use SilverCommerce\OrdersAdmin\Model\LineItemCustomisation;

/**
 * Task to handle migrating orders/items to newer versions
 */
class OrdersMigrationTask extends MigrationTask
{

    /**
     * Should this task be invoked automatically via dev/build?
     *
     * @config
     *
     * @var bool
     */
    private static $run_during_dev_build = true;

The private property $run_during_dev_build is not used, and could be removed.

    private static $segment = 'OrdersMigrationTask';

The private property $segment is not used, and could be removed.

    protected $description = "Upgrade Orders/Items";

    /**
     * Run this task
     *
     * @param HTTPRequest $request The current request

The type SilverCommerce\OrdersAdmin\Tasks\HTTPRequest was not found. Did you mean HTTPRequest? If so, make sure to prefix the type with \.

     *
     * @return void
     */
    public function run($request)
    {
        if ($request->getVar('direction') == 'down') {
            $this->down();
        } else {
            $this->up();
        }
    }

    /**
     * {@inheritdoc}
     */
    public function up()
    {
        // Migrate estimate/invoice numbers to new ref field
        $this->log('- Migrating estimate/invoice numbers');
        $total = 0;

The assignment to $total is dead and can be removed.

        if (class_exists(Subsite::class)) {
            $items = Subsite::get_from_all_subsites(Estimate::class);
        } else {
            $items = Estimate::get();
        }
        
        $count = false;
        if ($items) {
            $this->log('- '.$items->count().' items to convert.');
            $count = $items->count();
        }
        $i = 0;

        foreach ($items as $item) {
            if ($item->Number !== null) {
                $config = SiteConfig::current_site_config();
                $inv_prefix = $config->InvoiceNumberPrefix;
                $est_prefix = $config->EstimateNumberPrefix;
                $number = $item->Number;

                // Strip off current prefix and convert to a ref
                if ($item instanceof Invoice) {
                    $ref = str_replace($inv_prefix . "-", "", $number);
                    $ref = str_replace('-', '', $ref);
                    $item->Ref = (int)$ref;

The property Ref does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                    $item->Prefix = $inv_prefix;

The property Prefix does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                } else {
                    $ref = str_replace($est_prefix . "-", "", $number);
                    $ref = str_replace('-', '', $ref);
                    $item->Ref = (int)$ref;
                    $item->Prefix = $est_prefix;
                }

                $item->Number = null;

The property Number does not exist on SilverCommerce\OrdersAdmin\Model\Invoice. Since you implemented __set, consider adding a @property annotation.

                $item->write();
            }
            $i++;
            $this->log('- '.$i.'/'.$count.' items migrated.', true);

The call to SilverCommerce\OrdersAdmin\Tasks\OrdersMigrationTask::log() has too many arguments starting with true.

        }

        unset($items);

        // Change price/tax on line items to use new fields from extension
        $items = LineItem::get();
        $count = $items->count();
        $this->log("Migrating {$count} Line Items");
        $i = 0;

        foreach ($items as $item) {
            $write = false;

            if ((int)$item->Price && (int)$item->BasePrice == 0) {
                $item->BasePrice = $item->Price;
                $write = true;
            }

            if ($item->TaxID != 0 && $item->TaxRateID == 0) {
                $item->TaxRateID = $item->TaxID;
                $write = true;
            }

            if ($write) {
                $item->write();
                $i++;
            }
        }

        unset($items);
        
        $this->log("Migrated {$i} Line Item Customisations");

        // Change price/tax on line items to use new fields from extension
        $items = LineItemCustomisation::get();
        $count = $items->count();
        $this->log("Migrating {$count} Line Items");
        $i = 0;

        foreach ($items as $item) {
            $write = false;

            if ((int)$item->Price && (int)$item->BasePrice == 0) {
                $item->BasePrice = $item->Price;
                $write = true;
            }

            if ($write) {
                $item->write();
                $i++;
            }
        }

        unset($items);
        
        $this->log("Migrated {$i} Line Items");
    }

    /**
     * {@inheritdoc}
     */
    public function down()
    {
        $zones = Zone::get();

The assignment to $zones is dead and can be removed.

        $this->log('No Downgrade Required');
    }

    /**
     * @param string $text
     */
    protected function log($text)
    {
        if (Controller::curr() instanceof DatabaseAdmin) {
            DB::alteration_message($text, 'obsolete');
        } elseif (Director::is_cli()) {
            echo $text . "\n";
        } else {
            echo $text . "<br/>";
        }
    }
}