hiqdev / hipanel-module-finance

src/controllers/PlanController.php

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\controllers;

use hipanel\actions\Action;
use hipanel\actions\IndexAction;
use hipanel\actions\SmartCreateAction;
use hipanel\actions\SmartDeleteAction;
use hipanel\actions\SmartPerformAction;
use hipanel\actions\SmartUpdateAction;
use hipanel\actions\ValidateFormAction;
use hipanel\actions\ViewAction;
use hipanel\base\CrudController;
use hipanel\filters\EasyAccessControl;
use hipanel\helpers\ArrayHelper;
use hipanel\modules\finance\collections\PricesCollection;
use hipanel\modules\finance\helpers\PlanInternalsGrouper;
use hipanel\modules\finance\helpers\PriceChargesEstimator;
use hipanel\modules\finance\helpers\PriceSort;
use hipanel\modules\finance\models\factories\PriceModelFactory;
use hipanel\modules\finance\models\Plan;
use hipanel\modules\finance\models\Price;
use hipanel\modules\finance\models\PriceSuggestionRequestForm;
use hipanel\modules\finance\models\TargetObject;
use hiqdev\hiart\ResponseErrorException;
use Yii;
use yii\base\Event;
use yii\base\Module;
use yii\web\NotFoundHttpException;
use yii\web\Response;
use yii\web\UnprocessableEntityHttpException;

class PlanController extends CrudController
{
    /**
     * @var PriceModelFactory
     */
    public $priceModelFactory;

    /**
     * PlanController constructor.
     * @param string $id
     * @param Module $module
     * @param PriceModelFactory $priceModelFactory
     * @param array $config
     */
    public function __construct(string $id, Module $module, PriceModelFactory $priceModelFactory, array $config = [])
    {
        parent::__construct($id, $module, $config);

        $this->priceModelFactory = $priceModelFactory;
    }

    public function behaviors()
    {
        return array_merge(parent::behaviors(), [
            [
                'class' => EasyAccessControl::class,
                'actions' => [
                    'create' => 'plan.create',
                    'update' => 'plan.update',
                    'update-prices' => 'plan.update',
                    'templates' => 'plan.create',
                    'create-prices' => 'plan.create',
                    'delete' => 'plan.delete',
                    '*' => 'plan.read',
                ],
            ],
        ]);
    }

    public function actions()
    {
        return array_merge(parent::actions(), [
            'create' => [
                'class' => SmartCreateAction::class,
                'success' => Yii::t('hipanel.finance.plan', 'Plan was successfully created'),
            ],
            'update' => [
                'class' => SmartUpdateAction::class,
                'success' => Yii::t('hipanel.finance.plan', 'Plan was successfully updated'),
            ],
            'index' => [
                'class' => IndexAction::class,
            ],
            'view' => [
                'class' => ViewAction::class,
                'on beforePerform' => function (Event $event) {
                    $action = $event->sender;
                    $action->getDataProvider()->query
                        ->joinWith('sales')
                        ->andWhere(['state' => ['ok', 'deleted']])
                        ->withPrices();
                },
                'data' => function (Action $action, array $data) {
                    return array_merge($data, array_filter([
                        'grouper' => new PlanInternalsGrouper($data['model']),
                        'parentPrices' => Yii::$app->user->can('plan.update') ? $this->getParentPrices($data['model']['id']) : null,
                    ]));
                },
            ],
            'set-note' => [
                'class' => SmartUpdateAction::class,
                'success' => Yii::t('hipanel', 'Note changed'),
            ],
            'validate-form' => [
                'class' => ValidateFormAction::class,
            ],
            'validate-single-form' => [
                'class' => ValidateFormAction::class,
                'validatedInputId' => false,
            ],
            'delete' => [
                'class' => SmartDeleteAction::class,
                'success' => Yii::t('hipanel.finance.plan', 'Plan was successfully deleted'),
            ],
            'restore' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel.finance.plan', 'Plan was successfully restored'),
            ],
            'copy' => [
                'class' => SmartUpdateAction::class,
                'view' => 'modals/copy',
                'queryOptions' => ['batch' => false],
            ],
        ]);
    }

    public function actionCreatePrices(int $plan_id, int $template_plan_id)
    {
        $plan = $this->findTemplatePlan($plan_id, $plan_id, $template_plan_id);

        $suggestions = (new Price())->batchQuery('suggest', [
            'object_id' => $plan_id,
            'plan_id' => $plan_id,
            'template_plan_id' => $template_plan_id,
            'type' => $plan->type,
        ]);
        $this->populateWithPrices($plan, $suggestions);

        $parentPrices = $this->getParentPrices($plan_id);

        $targetPlan = Plan::findOne(['id' => $plan_id]);

        $grouper = new PlanInternalsGrouper($plan);
        [$plan->name, $plan->id] = [$targetPlan->name, $targetPlan->id];
        $action = ['@plan/update-prices', 'id' => $plan->id, 'scenario' => 'create'];

        return $this->render($plan->type . '/' . 'createPrices',
            compact('plan', 'grouper', 'parentPrices', 'action', 'plan_id'));
    }

    public function actionSuggestPricesModal($id)
    {
        /** @var Plan $plan */
        $plan = $this->findPlan($id);
        $model = new PriceSuggestionRequestForm([
            'plan_id' => $plan->id,
            'plan_type' => $plan->type,
        ]);

        return $this->renderAjax('modals/suggestPrices', compact('plan', 'model'));
    }

    public function actionSuggestGroupingPricesModal($id)
    {
        /** @var Plan $plan */
        $plan = $this->findPlan($id);
        $model = new PriceSuggestionRequestForm([
            'plan_id' => $plan->id,
            'plan_type' => $plan->type,
            'object_id' => $plan->id,
            'scenario' => PriceSuggestionRequestForm::SCENARIO_PREDEFINED_OBJECT,
        ]);

        return $this->renderAjax('modals/suggestPrices', compact('plan', 'model'));
    }

    public function actionSuggestSharedPricesModal($id)
    {
        /** @var Plan $plan */
        $plan = $this->findPlan($id);
        $model = new PriceSuggestionRequestForm([
            'plan_id' => $plan->id,
            'plan_type' => $plan->type,
            'scenario' => PriceSuggestionRequestForm::SCENARIO_PREDEFINED_OBJECT,
        ]);

        return $this->renderAjax('modals/suggestPrices', compact('plan', 'model'));
    }

    private function findTemplatePlan(int $targetPlan, int $object_id, int $expectedTemplateId): Plan
    {
        $result = Plan::perform('search-templates', [
            'id' => $targetPlan,
            'object_id' => $object_id,
        ]);
        $plans = ArrayHelper::index($result, 'id');

        if (!isset($plans[$expectedTemplateId])) {
            throw new NotFoundHttpException('Requested template plan not found');
        }

        $plan = Plan::instantiate($plans[$expectedTemplateId]);
        Plan::populateRecord($plan, $plans[$expectedTemplateId]);

        return $plan;
    }

    /**
     * @param $id integer
     * @throws NotFoundHttpException
     * @return Plan|null
     */
    private function findPlan(int $id): ?Plan
    {
        $plan = Plan::findOne(['id' => $id]);
        if ($plan === null) {
            throw new NotFoundHttpException('Not found');
        }

        return $plan;
    }

    /**
     * @param string $plan_id
     * @param string|null $object_id Object ID or `null`
     * when the desired templates are not related to a specific object
     * @param string $name_ilike
     * @return array
     */
    public function actionTemplates($plan_id, $object_id = null, string $name_ilike = null)
    {
        $templates = (new Plan())->query('search-templates', [
            'id' => $plan_id,
            'object_id' => $object_id ?? $plan_id,
            'name_ilike' => $name_ilike,
        ]);

        Yii::$app->response->format = Response::FORMAT_JSON;

        return $templates;
    }

    public function actionCalculateCharges()
    {
        Yii::$app->response->format = Response::FORMAT_JSON;
        $request = Yii::$app->request;

        $periods = ['now', 'first day of +1 month', 'first day of +1 year'];
        $calculations = Plan::perform('calculate-charges', [
            'actions' => $request->post('actions'),
            'prices' => $request->post('prices'),
            'times' => $periods,
        ]);
        /** @var PriceChargesEstimator $calculator */
        $calculator = Yii::$container->get(PriceChargesEstimator::class, [$calculations]);

        try {
            return $calculator->calculateForPeriods($periods);
        } catch (ResponseErrorException $exception) {
            Yii::$app->response->setStatusCode(412, $exception->getMessage());

            return [
                'formula' => $exception->getResponse()->getData()['_error_ops']['formula'] ?? null,
            ];
        }
    }

    public function actionCalculateValues($planId)
    {
        Yii::$app->response->format = Response::FORMAT_JSON;
        $periods = ['now', 'first day of +1 month', 'first day of +1 year'];
        try {
            $calculations = Plan::perform('calculate-values', ['id' => $planId, 'times' => $periods]);
            $calculator = Yii::$container->get(PriceChargesEstimator::class, [$calculations]);

            return $calculator->calculateForPeriods($periods);
        } catch (ResponseErrorException $exception) {
            Yii::$app->response->setStatusCode(412, $exception->getMessage());

            return [
                'formula' => $exception->getResponse()->getData()['_error_ops']['formula'] ?? null,
            ];
        }
    }

    public function actionUpdatePrices(int $id, string $scenario = 'update')
    {
        $plan = Plan::find()
            ->byId($id)
            ->withPrices()
            ->one();

        $request = Yii::$app->request;
        if ($request->isPost) {
            try {
                $collection = new PricesCollection($this->priceModelFactory, ['scenario' => $scenario]);
                $collection->load();
                if ($collection->save() === false) {
                    if ($scenario === 'create') {
                        Yii::$app->session->addFlash('error', Yii::t('hipanel.finance.price', 'Error occurred during creation of prices'));
                    } elseif ($scenario === 'update') {
                        Yii::$app->session->addFlash('error', Yii::t('hipanel.finance.price', 'Error occurred during prices update'));
                    }
                } else {
                    if ($scenario === 'create') {
                        Yii::$app->session->addFlash('success', Yii::t('hipanel.finance.price', 'Prices were successfully created'));
                    } elseif ($scenario === 'update') {
                        Yii::$app->session->addFlash('success', Yii::t('hipanel.finance.price', 'Prices were successfully updated'));
                    }
                }

                return $this->redirect(['@plan/view', 'id' => $id]);
            } catch (\Exception $e) {
                throw new UnprocessableEntityHttpException($e->getMessage(), 0, $e);
            }
        }

        $grouper = new PlanInternalsGrouper($plan);

$plan is of type object<hiqdev\hiart\ActiveRecord>|array|null, but the function expects a object<hipanel\modules\finance\models\Plan>.

        $parentPrices = $this->getParentPrices($id);

        return $this->render($plan->type . '/' . 'updatePrices',
            compact('plan', 'grouper', 'parentPrices'));
    }

    /**
     * @param int $plan_id
     * @return Price[]|null Array of parent plan prices or `null`, when parent plan was not found
     */
    private function getParentPrices(int $plan_id)
    {
        $plan = Plan::find()
            ->addAction('get-parent')
            ->where(['id' => $plan_id])
            ->joinWithPrices()
            ->one();

        if ($plan === null || $plan->id === null) {
            return null;
        }

        return (new PlanInternalsGrouper($plan))->group();
    }

    /**
     * @param Plan $plan
     * @param array $pricesData
     */
    private function populateWithPrices(Plan $plan, $pricesData): void
    {
        $prices = [];
        foreach ($pricesData as $priceData) {
            $object = ArrayHelper::remove($priceData, 'object');
            if (isset($priceData['plan_type']) &&
                $priceData['plan_type'] === 'certificate') {
                $priceData['class'] = 'CertificatePrice';
            }

            /** @var Price $price */
            $price = Price::instantiate($priceData);
            $price->setScenario('create');
            $price->setAttributes($priceData);
            $price->populateRelation('object', new TargetObject($object));
            $price->trigger(Price::EVENT_AFTER_FIND);
            $prices[] = $price;
        }
        $prices = PriceSort::anyPrices()->values($prices, true);

        $plan->populateRelation('prices', $prices);
    }
}