EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 EspoCRM, Inc.
* Website: https://www.espocrm.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Tools\Formula;
use Espo\Core\Formula\Exceptions\SyntaxError;
use Espo\Core\Formula\Exceptions\Error;
use Espo\Core\Formula\Utils\PositionUtil;
use stdClass;
class SyntaxCheckResult
{
private bool $isSuccess;
private ?string $message = null;
private ?Error $exception = null;
private ?int $line = null;
private ?int $column = null;
private function __construct(bool $isSuccess)
{
$this->isSuccess = $isSuccess;
}
public static function createSuccess(): self
{
return new self(true);
}
public static function createError(SyntaxError $exception, ?string $expression = null): self
{
$obj = new self(false);
if ($expression !== null && $exception->getPosition() !== null) {
[$line, $column] = PositionUtil::getLineAndColumn($expression, $exception->getPosition());
$obj->line = $line;
$obj->column = $column;
}
$obj->message = $exception->getShortMessage();
$obj->exception = $exception;
return $obj;
}
public function isSuccess(): bool
{
return $this->isSuccess;
}
public function getMessage(): ?string
{
return $this->message;
}
public function getException(): ?Error
{
return $this->exception;
}
public function toStdClass(): stdClass
{
$data = (object) [];
$data->isSuccess = $this->isSuccess();
if (!$this->isSuccess) {
$data->message = $this->message;
}
if ($this->line !== null && $this->column !== null) {
$data->line = $this->line;
$data->column = $this->column;
}
return $data;
}
/**
* @since 10.1.0
*/
public function getLine(): ?int
{
return $this->line;
}
/**
* @since 10.1.0
*/
public function getColumn(): ?int
{
return $this->column;
}
}