Constant.php

<?php

/**
 * This file is part of the Zephir.
 *
 * (c) Phalcon Team <team@zephir-lang.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Zephir\Class;

use ReflectionException;
use Zephir\CompilationContext;
use Zephir\Exception;
use Zephir\Expression\Constants;
use Zephir\Expression\StaticConstantAccess;

/**
 * Represents a class constant
 */
class Constant
{
    public function __construct(
        protected string $name,
        protected array $value,
        protected ?string $docblock = null,
    ) {
    }

    /**
     * Produce the code to register a class constant.
     *
     * @throws Exception
     * @throws ReflectionException
     */
    public function compile(CompilationContext $compilationContext): void
    {
        $this->processValue($compilationContext);
        $constantValue = $this->value['value'] ?? null;
        $compilationContext->backend->declareConstant(
            $this->value['type'],
            $this->getName(),
            $constantValue,
            $compilationContext
        );
    }

    /**
     * Returns the docblock related to the constant.
     */
    public function getDocBlock(): ?string
    {
        return $this->docblock;
    }

    /**
     * Returns the constant's name.
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Get type of class constant.
     */
    public function getType(): string
    {
        return $this->value['type'];
    }

    /**
     * Returns the constant's value.
     */
    public function getValue(): array
    {
        return $this->value;
    }

    /**
     * Get the type of the value of the constant.
     */
    public function getValueType(): string
    {
        return $this->value['type'];
    }

    /**
     * Get value of the value of the constant.
     */
    public function getValueValue(): mixed
    {
        return $this->value['value'] ?? null;
    }

    /**
     * Process the value of the class constant if needed.
     *
     * @throws Exception
     * @throws ReflectionException
     */
    public function processValue(CompilationContext $compilationContext): void
    {
        if ('constant' === $this->value['type']) {
            $compiledExpression = (new Constants())->compile($this->value, $compilationContext);

            $this->value = [
                'type'  => $compiledExpression->getType(),
                'value' => $compiledExpression->getCode(),
            ];

            return;
        }

        if ('static-constant-access' === $this->value['type']) {
            $compiledExpression = (new StaticConstantAccess())->compile($this->value, $compilationContext);

            $this->value = [
                'type'  => $compiledExpression->getType(),
                'value' => $compiledExpression->getCode(),
            ];
        }
    }
}