stepper.php

<?php
namespace Bitrix\Translate\Controller;
 
use Bitrix\Main;
use Bitrix\Translate;
 
trait Stepper
{
    protected ?string $processToken;
 
    protected bool $isNewProcess = true;
 
    protected bool $isProcessCompleted = false;
 
    protected int $processedItems = 0;
 
    protected int $totalItems = 0;
 
    protected ?Translate\Controller\Timer $timer = null;
 
 
    protected function onBeforeRun()
    {
        if ($this instanceof IProcessParameters)
        {
            $this->keepField([
                'processedItems',
                'totalItems',
            ]);
 
            $this->processToken = $this->getController()->getRequest()->get('PROCESS_TOKEN');
 
            $progressData = $this->getProgressParameters();
            if (\count($progressData) > 0)
            {
                $this->isNewProcess = (empty($progressData['processToken']) || $progressData['processToken'] !== $this->processToken);
                if (!$this->isNewProcess)
                {
                    // restore state
                    $this->restoreProgressParameters();
                }
            }
 
            $this->keepField('processToken');
        }
 
        if (empty($this->processToken))
        {
            $this->addError(new Main\Error('Process token is not specified.'));
        }
 
        return \count($this->getErrors()) === 0;
    }
 
    protected function performStep($action, array $params = [])
    {
        if ($this->isNewProcess)
        {
            $this->processedItems = 0;
            $this->totalItems = 0;
 
            if ($this instanceof IProcessParameters)
            {
                $this->saveProgressParameters();
            }
        }
 
        $this->startTimer();
 
        if ($action instanceof \Closure)
        {
            $result = $action->call($this, $params);
        }
        elseif (\is_callable($action))
        {
            $result = \call_user_func($action, $params);
        }
        elseif (\is_string($action) && \is_callable([$this, $action]))
        {
            $result = \call_user_func([$this, $action], $params);
        }
        else
        {
            $this->addError(new Main\Error('Wrong action parameter!'));
        }
 
        if ($this->hasErrors())
        {
            $result['STATUS'] = Translate\Controller\STATUS_COMPLETED;
        }
        elseif ($this->hasProcessCompleted())
        {
            $result['STATUS'] = Translate\Controller\STATUS_COMPLETED;
        }
        else
        {
            $result['STATUS'] = Translate\Controller\STATUS_PROGRESS;
        }
 
        if ($this instanceof IProcessParameters)
        {
            // Save progress
            $this->saveProgressParameters();
        }
 
        return $result;
    }
 
    public function declareAccomplishment(bool $flag = true): void
    {
        $this->isProcessCompleted = $flag;
    }
 
    public function hasProcessCompleted(): bool
    {
        return $this->isProcessCompleted;
    }
 
 
    public function hasErrors(): bool
    {
        if ($this->errorCollection instanceof Main\ErrorCollection)
        {
            return $this->errorCollection->isEmpty() !== true;
        }
 
        return false;
    }
 
    public function instanceTimer(): Translate\Controller\Timer
    {
        if ($this->timer === null)
        {
            $this->timer = new Translate\Controller\Timer();
        }
 
        return $this->timer;
    }
 
    public function startTimer(): void
    {
        $this->instanceTimer()->startTimer((int)\START_EXEC_TIME);
    }
 
    public function hasTimeLimitReached(): bool
    {
        return $this->instanceTimer()->hasTimeLimitReached();
    }
}