Twig/src/Source.php

<?php

/*
 * This file is part of Twig.
 *
 * (c) Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Twig;

/**
 * Holds information about a non-compiled Twig template.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
final class Source
{
    /**
     * @param string $code The template source code
     * @param string $name The template logical name
     * @param string $path The filesystem path of the template if any
     */
    public function __construct(
        private string $code,
        private string $name,
        private string $path = '',
    ) {
    }

    public function getCode(): string
    {
        return $this->code;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * Returns the 1-based column for a 0-based byte offset in the source code.
     *
     * A negative offset means the position is unknown and yields null.
     *
     * @return positive-int|null
     */
    public function getColumn(int $offset): ?int
    {
        if ($offset < 0) {
            return null;
        }

        $before = str_replace(["\r\n", "\r"], "\n", substr($this->code, 0, $offset));
        $lineStart = strrpos($before, "\n");

        return false === $lineStart ? \strlen($before) + 1 : \strlen($before) - $lineStart;
    }
}