org_openpsa_invoices_scheduler::run_cycle()

Complexity

Conditions	13
Paths	65

Size

Total Lines	75
Code Lines	47

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	44
CRAP Score	13.0437

Importance

Changes

0

<?php
    public function run_cycle($cycle_number, bool $send_invoice = true) : bool
    {
        if (time() < $this->_deliverable->start) {
            debug_add('Subscription hasn\'t started yet, register the start-up event to $start');
            return $this->_create_at_entry($cycle_number, $this->_deliverable->start);
        }

        debug_add('Running cycle ' . $cycle_number . ' for deliverable "' . $this->_deliverable->title . '"');

        $this_cycle_start = $this->get_cycle_start($cycle_number, time());
        if ($this->subscription_day && $cycle_number == 1) {
            // If there's a fixed day for invoicing, get_cycle_start already picked a future date for cycle 1
            $next_cycle_start = $this_cycle_start + 2; // +2 so we don't get overlaps in task
        } else {
            $next_cycle_start = $this->calculate_cycle_next($this_cycle_start);
        }
        $product = org_openpsa_products_product_dba::get_cached($this->_deliverable->product);

        if ($this->_deliverable->state < org_openpsa_sales_salesproject_deliverable_dba::STATE_STARTED) {
            $this->_deliverable->state = org_openpsa_sales_salesproject_deliverable_dba::STATE_STARTED;
            $this->_deliverable->update();
        }

        if ($send_invoice) {
            $calculator = new org_openpsa_invoices_calculator();
            $this_cycle_amount = $calculator->process_deliverable($this->_deliverable, $cycle_number);
        }

        $tasks_completed = [];
        $tasks_not_completed = [];
        $new_task = null;

        if ($product->orgOpenpsaObtype == org_openpsa_products_product_dba::TYPE_SERVICE) {

The property orgOpenpsaObtype does not exist on midcom_core_dbaobject. Since you implemented __get, consider adding a @property annotation.

            // Close previous task(s)
            $last_task = null;

            $qb = org_openpsa_projects_task_dba::new_query_builder();
            $qb->add_constraint('agreement', '=', $this->_deliverable->id);
            $qb->add_constraint('status', '<', org_openpsa_projects_task_status_dba::COMPLETED);

            foreach ($qb->execute() as $task) {
                if (org_openpsa_projects_workflow::complete($task, sprintf($this->_i18n->get_string('completed by subscription %s', 'org.openpsa.sales'), $cycle_number))) {
                    $tasks_completed[] = $task;
                } else {
                    $tasks_not_completed[] = $task;
                }
                $last_task = $task;
            }

            // Create task for the duration of this cycle
            $task_title = $this->_deliverable->get_cycle_identifier($this_cycle_start);
            $new_task = $this->create_task($this_cycle_start, $next_cycle_start - 1, $task_title, $last_task);
        }

        // TODO: Warehouse management: create new order
        if (   $this->_deliverable->end < $next_cycle_start
            && $this->_deliverable->end != 0) {
            debug_add('Do not register next cycle, the contract ends before');
            return $this->_deliverable->end_subscription();
        }

        if (!$this->_create_at_entry($cycle_number + 1, $next_cycle_start)) {

It seems like $next_cycle_start can also be of type false; however, parameter $start of org_openpsa_invoices_scheduler::_create_at_entry() does only seem to accept integer, maybe add an additional type check?

            return false;
        }
        if ($send_invoice) {
            $data = [
                'cycle_number' => $cycle_number,
                'next_run' => $next_cycle_start,
                'invoiced_sum' => $this_cycle_amount,

The variable $this_cycle_amount does not seem to be defined for all execution paths leading up to this point.

                'tasks_completed' => $tasks_completed,
                'tasks_not_completed' => $tasks_not_completed
            ];
            $this->_notify_owner($calculator, $new_task, $data);

The variable $calculator does not seem to be defined for all execution paths leading up to this point.

        }
        return true;
    }