baseactivity.php

См. документацию.

<?php
 
namespace Bitrix\Bizproc\Activity;
 
use Bitrix\Bizproc\FieldType;
use Bitrix\Main\Error;
use Bitrix\Main\ErrorCollection;
use Bitrix\Main\IO\File;
use Bitrix\Main\IO\Path;
use Bitrix\Main\Loader;
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\Result;
 
abstract class BaseActivity extends \CBPActivity
{
    protected static $requiredModules = [];
    protected $preparedProperties = [];
 
    public function __get($name)
    {
        return $this->preparedProperties[$name] ?? parent::__get($name);
    }
 
    public function execute()
    {
        if (!static::checkModules())
        {
            return \CBPActivityExecutionStatus::Closed;
        }
        $this->prepareProperties();
 
        $errorCollection = $this->checkProperties();
        if ($errorCollection->isEmpty())
        {
            $errorCollection = $this->internalExecute();
        }
 
        foreach ($errorCollection as $error)
        {
            $this->logError($error->getMessage());
        }
 
        return \CBPActivityExecutionStatus::Closed;
    }
 
    protected function prepareProperties(): void
    {
        $fieldsMap = static::getPropertiesDialogMap();
 
        foreach (array_keys($this->arProperties) as $propertyId)
        {
            $propertyValue = $this->getRawProperty($propertyId);
 
            $type = '';
            if (isset($this->arPropertiesTypes) && isset($this->arPropertiesTypes[$propertyId]))
            {
                $type = $this->arPropertiesTypes[$propertyId]['Type'] ?? '';
            }
            if (!$type && isset($fieldsMap[$propertyId]))
            {
                $type = $fieldsMap[$propertyId]['Type'] ?? '';
            }
 
            $parsedValue = $this->ParseValue($propertyValue);
            $this->preparedProperties[$propertyId] = $this->convertPropertyValue($type, $parsedValue);
        }
    }
 
    protected function convertPropertyValue(string $type, $value)
    {
        if ($value === null)
        {
            return null;
        }
 
        switch ($type)
        {
            case FieldType::INT:
                if (is_array($value))
                {
                    if (count($value) === 1)
                    {
                        $value = array_shift($value);
                    }
                    else
                    {
                        $value = 0;
                        // to avoid situation when casting array to int returns 1 (element with such ID can exist)
                        // and other situations when value can be ambiguous so it's impossible to cast it to int
                    }
                }
                return (int)$value;
 
            case FieldType::BOOL:
                return \CBPHelper::getBool($value);
 
            case FieldType::DOUBLE:
                return (double)$value;
 
            default:
                return $value;
        }
    }
 
    protected function checkProperties(): ErrorCollection
    {
        return new ErrorCollection();
    }
 
    protected function internalExecute(): ErrorCollection
    {
        return new ErrorCollection();
    }
 
    protected function logError(string $message = '', int $userId = 0): void
    {
        $this->log($message, $userId, \CBPTrackingType::Error);
    }
 
    protected function log(string $message = '', int $userId = 0, int $type = -1): void
    {
        $this->WriteToTrackingService($message, $userId, $type);
    }
 
    public static function getPropertiesDialog(
        $documentType,
        $activityName,
        $workflowTemplate,
        $workflowParameters,
        $workflowVariables,
        $currentValues = null,
        $formName = '',
        $popupWindow = null,
        $siteId = ''
    )
    {
        if (!static::checkModules())
        {
            return false;
        }
 
        $dialog = new \Bitrix\Bizproc\Activity\PropertiesDialog(static::getFileName(), [
            'documentType' => $documentType,
            'activityName' => $activityName,
            'workflowTemplate' => $workflowTemplate,
            'workflowParameters' => $workflowParameters,
            'workflowVariables' => $workflowVariables,
            'currentValues' => $currentValues,
            'formName' => $formName,
            'siteId' => $siteId
        ]);
 
        $dialog
            ->setMapCallback([static::class, 'getPropertiesDialogMap'])
            ->setRuntimeData(static::getRuntimeData())
        ;
 
        if (!static::hasRenderer())
        {
            $dialog->setRenderer([static::class, 'renderPropertiesDialog']);
        }
 
        return $dialog;
    }
 
    private static function hasRenderer(): bool
    {
        $dir = Path::getDirectory(Path::normalize(static::getFileName()));
 
        return
            File::isFileExists(Path::combine($dir, 'properties_dialog.php'))
            || File::isFileExists(Path::combine($dir, 'robot_properties_dialog.php'))
        ;
    }
 
    public static function renderPropertiesDialog(PropertiesDialog $dialog)
    {
        $propertiesDialogHtml = '';
        $isRobot = $dialog->getDialogFileName() === 'robot_properties_dialog.php';
        foreach ($dialog->getMap() as $field)
        {
            $propertiesDialogHtml .=
                $isRobot
                    ? static::renderRobotProperty($dialog, $field)
                    : static::renderBizprocProperty($dialog, $field)
            ;
        }
 
        return $propertiesDialogHtml;
    }
 
    protected static function renderBizprocProperty(PropertiesDialog $dialog, array $field): string
    {
        $controlHtml = $dialog->renderFieldControl(
            $field,
            $dialog->getCurrentValue($field),
            true,
            FieldType::RENDER_MODE_DESIGNER
        );
 
        return sprintf(
            '<tr><td align="right" width="40%%">%s:</td><td width="60%%">%s</td></tr>',
            htmlspecialcharsbx($field['Name']),
            $controlHtml
        );
    }
 
    protected static function renderRobotProperty(PropertiesDialog $dialog, array $field): string
    {
        $propertyHtml = '
            <div class="bizproc-automation-popup-settings">
                <span class="bizproc-automation-popup-settings-title bizproc-automation-popup-settings-title-autocomplete">
                    %s:
                </span>
                %s
            </div>
        ';
 
        return sprintf(
            $propertyHtml,
            htmlspecialcharsbx($field['Name']),
            $dialog->renderFieldControl($field, $dialog->getCurrentValue($field))
        );
    }
 
    public static function getPropertiesDialogValues(
        $documentType,
        $activityName,
        &$workflowTemplate,
        &$workflowParameters,
        &$workflowVariables,
        $currentValues,
        &$errors
    ): bool
    {
        if (!static::checkModules())
        {
            return false;
        }
 
        $dialog = new PropertiesDialog(static::getFileName(), [
            'documentType' => $documentType,
            'activityName' => $activityName,
            'workflowTemplate' => $workflowTemplate,
            'workflowParameters' => $workflowParameters,
            'workflowVariables' => $workflowVariables,
            'currentValues' => $currentValues,
        ]);
 
        $extractingResult = static::extractPropertiesValues($dialog, static::getPropertiesDialogMap($dialog));
        if (!$extractingResult->isSuccess())
        {
            foreach ($extractingResult->getErrors() as $error)
            {
                $errors[] = [
                    'code' => $error->getCode(),
                    'message' => $error->getMessage(),
                    'parameter' => $error->getCustomData(),
                ];
            }
        }
        else
        {
            $errors = static::ValidateProperties(
                $extractingResult->getData(),
                new \CBPWorkflowTemplateUser(\CBPWorkflowTemplateUser::CurrentUser)
            );
        }
 
        if ($errors)
        {
            return false;
        }
 
        $currentActivity = &\CBPWorkflowTemplateLoader::FindActivityByName(
            $workflowTemplate,
            $activityName
        );
        $currentActivity['Properties'] = $extractingResult->getData();
 
        return true;
    }
 
    protected static function extractPropertiesValues(PropertiesDialog $dialog, array $fieldsMap): Result
    {
        $result = new Result();
 
        $properties = [];
        $errors = [];
        $currentValues = $dialog->getCurrentValues();
        $documentService = static::getDocumentService();
 
        foreach ($fieldsMap as $propertyKey => $fieldProperties)
        {
            $field = $documentService->getFieldTypeObject($dialog->getDocumentType(), $fieldProperties);
            if(!$field)
            {
                continue;
            }
 
            $properties[$propertyKey] = $field->extractValue(
                ['Field' => $fieldProperties['FieldName']],
                $currentValues,
                $errors
            );
        }
 
        if ($errors)
        {
            foreach ($errors as $error)
            {
                $result->addError(
                    new Error(
                        $error['message'] ?? '',
                        $error['code'] ?? '',
                        $error['parameter'] ?? ''
                    )
                );
            }
        }
        else
        {
            $result->setData($properties);
        }
 
        return $result;
    }
 
    abstract protected static function getFileName(): string;
 
    public static function validateProperties($testProperties = [], \CBPWorkflowTemplateUser $user = null)
    {
        $errors = [];
 
        if (!static::checkModules())
        {
            return $errors;
        }
 
        foreach (static::getPropertiesDialogMap() as $propertyKey => $fieldProperties)
        {
            if(
                \CBPHelper::getBool($fieldProperties['Required'] ?? null)
                && \CBPHelper::isEmptyValue($testProperties[$propertyKey] ?? null)
            )
            {
                $errors[] = [
                    'code' => 'NotExist',
                    'parameter' => 'FieldValue',
                    'message' => Loc::getMessage('BIZPROC_BA_EMPTY_PROP', ['#PROPERTY#' => $fieldProperties['Name']]),
                ];
            }
        }
 
        return array_merge($errors, parent::ValidateProperties($testProperties, $user));
    }
 
    protected static function checkModules(): bool
    {
        foreach (static::$requiredModules as $module)
        {
            if (!Loader::includeModule($module))
            {
                return false;
            }
        }
 
        return true;
    }
 
    protected static function getDocumentService(): \CBPDocumentService
    {
        return \CBPRuntime::GetRuntime(true)->getDocumentService();
    }
 
    public static function getPropertiesDialogMap(?PropertiesDialog $dialog = null): array
    {
        return [];
    }
 
    protected static function getRuntimeData(): array
    {
        return [];
    }
}