View file vendor/league/commonmark/src/Extension/Footnote/Node/Footnote.php

File size: 1.44Kb
<?php

/*
 * This file is part of the league/commonmark package.
 *
 * (c) Colin O'Dell <[email protected]>
 * (c) Rezo Zero / Ambroise Maupate
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace League\CommonMark\Extension\Footnote\Node;

use League\CommonMark\Block\Element\AbstractBlock;
use League\CommonMark\Cursor;
use League\CommonMark\Reference\ReferenceInterface;

/**
 * @method children() AbstractBlock[]
 */
final class Footnote extends AbstractBlock
{
    /**
     * @var FootnoteBackref[]
     */
    private $backrefs = [];

    /**
     * @var ReferenceInterface
     */
    private $reference;

    public function __construct(ReferenceInterface $reference)
    {
        $this->reference = $reference;
    }

    public function canContain(AbstractBlock $block): bool
    {
        return true;
    }

    public function isCode(): bool
    {
        return false;
    }

    public function matchesNextLine(Cursor $cursor): bool
    {
        return false;
    }

    public function getReference(): ReferenceInterface
    {
        return $this->reference;
    }

    public function addBackref(FootnoteBackref $backref): self
    {
        $this->backrefs[] = $backref;

        return $this;
    }

    /**
     * @return FootnoteBackref[]
     */
    public function getBackrefs(): array
    {
        return $this->backrefs;
    }
}