<?php

/*
 * This file is part of the Doctrine Behavioral Extensions package.
 * (c) Gediminas Morkevicius <gediminas.morkevicius@gmail.com> http://www.gediminasm.org
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gedmo\Mapping\Annotation;

use Attribute;
use Doctrine\Common\Annotations\Annotation;
use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;

/**
 * TreePath annotation for Tree behavioral extension
 *
 * @Annotation
 * @NamedArgumentConstructor
 * @Target("PROPERTY")
 *
 * @author Gustavo Falco <comfortablynumb84@gmail.com>
 * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
 * @author <rocco@roccosportal.com>
 */
#[Attribute(Attribute::TARGET_PROPERTY)]
final class TreePath implements GedmoAnnotation
{
    /** @var string */
    public $separator = ',';

    /** @var bool|null */
    public $appendId;

    /** @var bool */
    public $startsWithSeparator = false;

    /** @var bool */
    public $endsWithSeparator = true;

    public function __construct(
        array $data = [],
        string $separator = ',',
        ?bool $appendId = null,
        bool $startsWithSeparator = false,
        bool $endsWithSeparator = true
    ) {
        if ([] !== $data) {
            @trigger_error(sprintf(
                'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                __METHOD__
            ), E_USER_DEPRECATED);
        }

        $this->separator = $data['separator'] ?? $separator;
        $this->appendId = $data['appendId'] ?? $appendId;
        $this->startsWithSeparator = $data['startsWithSeparator'] ?? $startsWithSeparator;
        $this->endsWithSeparator = $data['endsWithSeparator'] ?? $endsWithSeparator;
    }
}
