<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

namespace TYPO3\CMS\Core\Database\Schema\Parser\AST;

/**
 * Syntax node to represent identifiers used in various parts of a
 * SQL statements like table, field or index names.
 */
class Identifier
{
    /**
     * @var string
     */
    public $schemaObjectName;

    /**
     * @var string
     */
    protected $quoteChar = '`';

    /**
     * Identifier constructor.
     *
     * @param string $schemaObjectName
     */
    public function __construct(?string $schemaObjectName = null)
    {
        $this->schemaObjectName = (string)$schemaObjectName;
    }

    /**
     * Quotes the schema object name.
     *
     * @return string
     */
    public function getQuotedName(): string
    {
        $c = $this->quoteChar;

        return $c . str_replace($c, $c . $c, $this->schemaObjectName) . $c;
    }
}
