xref: /webtrees/app/Report/ReportBaseFootnote.php (revision e7f56f2af615447ab1a7646851f88b465ace9e04)

<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2018 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace Fisharebest\Webtrees\Report;

/**
 * Class ReportBaseFootnote
 */
class ReportBaseFootnote extends ReportBaseElement
{
    /**
     * The name of the style for this element
     *
     * @var string
     */
    public $styleName = '';

    /**
     * Numbers for the links
     *
     * @var int
     */
    public $num;

    /**
     * The text that will be printed with the number
     *
     * @var string
     */
    public $numText = '';

    /**
     * Remaining width of a cell
     *
     * @var float User unit (points)
     */
    public $wrapWidthRemaining;

    /**
     * Original width of a cell
     *
     * @var float User unit (points)
     */
    public $wrapWidthCell;

    /** @var string A link */
    public $addlink;

    /**
     * Createa an element.
     *
     * @param string $style
     */
    public function __construct($style = '')
    {
        $this->text = '';
        if (!empty($style)) {
            $this->styleName = $style;
        } else {
            $this->styleName = 'footnote';
        }
    }

    /**
     * Add text.
     *
     * @param $t
     *
     * @return void
     */
    public function addText(string $t)
    {
        $t          = trim($t, "\r\n\t");
        $t          = str_replace([
            '<br>',
            '&nbsp;',
        ], [
            "\n",
            ' ',
        ], $t);
        $t          = strip_tags($t);
        $t          = htmlspecialchars_decode($t);
        $this->text .= $t;
    }

    /**
     * Set the width to wrap text.
     *
     * @param $wrapwidth
     * @param $cellwidth
     *
     * @return int
     */
    public function setWrapWidth($wrapwidth, $cellwidth): int
    {
        $this->wrapWidthCell = $cellwidth;
        if (strpos($this->numText, "\n") !== false) {
            $this->wrapWidthRemaining = $cellwidth;
        } else {
            $this->wrapWidthRemaining = $wrapwidth;
        }

        return $this->wrapWidthRemaining;
    }

    /**
     * Set the number.
     *
     * @param $n
     *
     * @return int
     */
    public function setNum($n): int
    {
        $this->num     = $n;
        $this->numText = "$n ";

        return 0;
    }

    /**
     * Add a link.
     *
     * @param $a
     *
     * @return int
     */
    public function setAddlink($a): int
    {
        $this->addlink = $a;

        return 0;
    }
}