FieldSubstitution.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\components\DataCollection\Fields\Formula\FormulaParser\Substitution;
 
use ILIAS\components\DataCollection\Fields\Formula\FormulaParser\Token\Tokenizer;
use ILIAS\components\DataCollection\Fields\Formula\FormulaParser\Token\Token;
 
class FieldSubstitution
{
    private static array $field_cache = [];
    private \ilLanguage $lng;
 
    public function __construct(
        private \ilDclBaseRecordModel $record,
        private \ilDclBaseFieldModel $field
    ) {
        global $DIC;
        $this->lng = $DIC->language();
    }
 
    public function getFieldId(): int
    {
        return (int) $this->field->getId();
    }
 
    public function substituteFieldValue(string $placeholder): string
    {
        if (isset(self::$field_cache[$placeholder])) {
            $field = self::$field_cache[$placeholder];
        } else {
            $field = $this->getFieldFromPlaceholder($placeholder);
        }
 
        return $this->record->getRecordFieldFormulaValue($field->getId());
    }
 
    public function substituteFieldValues(array $tokens): array
    {
        $replaced = [];
        foreach ($tokens as $token) {
            if ($token instanceof Token) {
                $token = $token->getValue();
            }
            if (str_starts_with($token, Tokenizer::FIELD_OPENER)) {
                $replaced[] = new Token($this->substituteFieldValue($token));
            } else {
                $replaced[] = new Token($token);
            }
        }
 
        return $replaced;
    }
 
    public function getFieldFromPlaceholder(string $placeholder): \ilDclBaseFieldModel
    {
        $table = \ilDclCache::getTableCache($this->record->getTableId()); // TODO May need caching per table in future
        $field_title = preg_replace('#^\[\[(.*)\]\]#', "$1", $placeholder);
        $field = $table->getFieldByTitle($field_title);
        if ($field === null) {
            // Workaround for standardfields - title my be ID
            $field = $table->getField($field_title);
            if ($field === null) {
                throw new \ilException(sprintf($this->lng->txt('dcl_err_formula_field_not_found'), $field_title));
            }
        }
        self::$field_cache[$placeholder] = $field;
        return $field;
    }
}