<?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;

use TYPO3\CMS\Core\Database\Schema\Parser\AST\DataType\AbstractDataType;

/**
 * Syntax tree node for column definitions within a create statements.
 * Holds basic attributes common to all types of columns.
 */
class CreateColumnDefinitionItem extends AbstractCreateDefinitionItem
{
    /**
     * @var \TYPO3\CMS\Core\Database\Schema\Parser\AST\Identifier
     */
    public $columnName;

    /**
     * @var \TYPO3\CMS\Core\Database\Schema\Parser\AST\DataType\AbstractDataType
     */
    public $dataType;

    /**
     * Allow NULL values
     *
     * @var bool
     */
    public $allowNull = true;

    /**
     * Explicit default value
     *
     * @var bool
     */
    public $hasDefaultValue = false;

    /**
     * The explicit default value
     *
     * @var mixed
     */
    public $defaultValue;

    /**
     * Set auto increment flag
     *
     * @var bool
     */
    public $autoIncrement = false;

    /**
     * Create non-unique index for column
     *
     * @var bool
     */
    public $index = false;

    /**
     * Create unique constraint for column
     *
     * @var bool
     */
    public $unique = false;

    /**
     * Use column as primary key for table
     *
     * @var bool
     */
    public $primary = false;

    /**
     * Column comment
     *
     * @var string
     */
    public $comment;

    /**
     * The column format (DYNAMIC or FIXED)
     *
     * @var string
     */
    public $columnFormat;

    /**
     * The storage type for the column (ignored unless MySQL Cluster with NDB Engine)
     *
     * @var string
     */
    public $storage;

    /**
     * @var ReferenceDefinition
     */
    public $reference;

    /**
     * CreateColumnDefinitionItem constructor.
     */
    public function __construct(Identifier $columnName, AbstractDataType $dataType)
    {
        $this->columnName = $columnName;
        $this->dataType = $dataType;
    }
}
