PhpSpreadsheet/tests/PhpSpreadsheetTests/Reader/Xlsx/HyperlinkTest.php

<?php

declare(strict_types=1);

namespace PhpOffice\PhpSpreadsheetTests\Reader\Xlsx;

use PhpOffice\PhpSpreadsheet\NamedRange;
use PhpOffice\PhpSpreadsheet\Reader\Xlsx as XlsxReader;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheetTests\Functional\AbstractFunctional;

class HyperlinkTest extends AbstractFunctional
{
    public function testReadAndWriteHyperlinks(): void
    {
        $spreadsheet = new Spreadsheet();
        $sheet1 = $spreadsheet->getActiveSheet();
        $sheet1->setTitle('Sheet One');
        $sheet1->getCell('A1')->setValue(100);
        $sheet1->getCell('B1')->setValue('this is b1');
        $spreadsheet->addNamedRange(new NamedRange('namedb1', $sheet1, '$B$1'));
        $sheet1->setCellValue('A2', 'link to same sheet');
        $sheet1->getCell('A2')->getHyperlink()
            ->setUrl("sheet://'Sheet One'!A1");
        $sheet1->getStyle('A2')->getFont()->setHyperlinkTheme();
        $sheet1->setCellValue('A3', 'link to defined name');
        $sheet1->getCell('A3')->getHyperlink()
            ->setUrl('sheet://namedb1');
        $sheet1->getStyle('A3')->getFont()->setHyperlinkTheme();

        $sheet2 = $spreadsheet->createSheet();
        $sheet2->setTitle('Sheet Two');
        $sheet2->setCellValue('A2', 'link to other sheet');
        $sheet2->getCell('A2')->getHyperlink()
            ->setUrl("sheet://'Sheet One'!A1");
        $sheet2->getStyle('A2')->getFont()->setHyperlinkTheme();
        $sheet2->setCellValue('A3', 'external link');
        $sheet2->getCell('A3')->getHyperlink()
            ->setUrl('https://www.example.com');
        $sheet2->getStyle('A3')->getFont()->setHyperlinkTheme();
        $sheet2->setCellValue('A4', 'external link with anchor');
        $sheet2->getCell('A4')->getHyperlink()
            ->setUrl('https://www.example.com#anchor');
        $sheet2->getCell('A4')->getHyperlink()->setTooltip('go to anchor tag on example.com');
        $sheet2->getStyle('A4')->getFont()->setHyperlinkTheme();

        $reloadedSpreadsheet = $this->writeAndReload($spreadsheet, 'Xlsx');
        $spreadsheet->disconnectWorksheets();
        $rsheet1 = $reloadedSpreadsheet->getSheet(0);
        self::assertSame('link to same sheet', $rsheet1->getCell('A2')->getValue());
        self::assertSame("sheet://'Sheet One'!A1", $rsheet1->getCell('A2')->getHyperlink()->getUrl());

        self::assertSame('link to defined name', $rsheet1->getCell('A3')->getValue());
        self::assertSame('sheet://namedb1', $rsheet1->getCell('A3')->getHyperlink()->getUrl());

        $rsheet2 = $reloadedSpreadsheet->getSheet(1);
        self::assertSame('link to other sheet', $rsheet2->getCell('A2')->getValue());
        self::assertSame("sheet://'Sheet One'!A1", $rsheet2->getCell('A2')->getHyperlink()->getUrl());
         self::assertSame(
             'FF0000FF',
             $rsheet2
                 ->getStyle('A2')
                 ->getFont()->getColor()->getARGB(),
             'argb is set in addition to theme'
         );

        self::assertSame('external link', $rsheet2->getCell('A3')->getValue());
        self::assertSame('https://www.example.com', $rsheet2->getCell('A3')->getHyperlink()->getUrl());

        self::assertSame('https://www.example.com#anchor', $rsheet2->getCell('A4')->getHyperlink()->getUrl());
        self::assertSame('external link with anchor', $rsheet2->getCell('A4')->getValue());
        self::assertSame('go to anchor tag on example.com', $rsheet2->getCell('A4')->getHyperlink()->getToolTip());

        $testCells = [
            [0, 'A2'],
            [0, 'A3'],
            [0, 'A2'],
            [1, 'A3'],
            [1, 'A4'],
        ];
        foreach ($testCells as $sheetAndCell) {
            [$sheetIndex, $cell] = $sheetAndCell;
            $rsheet = $reloadedSpreadsheet->getSheet($sheetIndex);
            self::assertSame(
                10,
                $rsheet->getStyle($cell)
                    ->getFont()->getColor()->getTheme(),
                "theme sheet $sheetIndex cell $cell"
            );
            self::assertSame(
                'single',
                $rsheet->getStyle('A2')->getFont()->getUnderline(),
                "underline sheet $sheetIndex cell $cell"
            );
        }

        $reloadedSpreadsheet->disconnectWorksheets();
    }

    public function testDisplay(): void
    {
        $spreadsheet = new Spreadsheet();

        $sheet = $spreadsheet->getActiveSheet();
        $sheet->getCell('A1')->setValue('A1 text');
        $hy1 = $sheet->getCell('A1')->getHyperlink();
        $hy1->setUrl('http://www.example.com');
        $hy1->setTooltip('Go to example.com');

        $sheet->getCell('A2')->setValue('A2 text');
        $hy2 = $sheet->getCell('A2')->getHyperlink();
        $hy2->setUrl('http://www.example.org');
        $hy2->setTooltip('Go to example.org');
        $hy2->setDisplay('A2 display');

        $reloadedSpreadsheet = $this->writeAndReload($spreadsheet, 'Xlsx');
        $spreadsheet->disconnectWorksheets();
        $rsheet = $reloadedSpreadsheet->getActiveSheet();

        self::assertSame('A1 text', $rsheet->getCell('A1')->getValue());
        $rhy1 = $rsheet->getCell('A1')->getHyperlink();
        self::assertSame('http://www.example.com', $rhy1->getUrl());
        self::assertSame('Go to example.com', $rhy1->getTooltip());
        self::assertSame('Go to example.com', $rhy1->getDisplay(), 'display is set to tooltip if unset');

        self::assertSame('A2 text', $rsheet->getCell('A2')->getValue());
        $rhy2 = $rsheet->getCell('A2')->getHyperlink();
        self::assertSame('http://www.example.org', $rhy2->getUrl());
        self::assertSame('Go to example.org', $rhy2->getTooltip());
        self::assertSame('A2 display', $rhy2->getDisplay(), 'display is explicitly set');

        $reloadedSpreadsheet->disconnectWorksheets();
    }

    public function testExcelWrittenHyperlinkWithAnchor(): void
    {
        $infil = 'tests/data/Reader/XLSX/issue.4842.xlsx';
        $reader = new XlsxReader();
        $spreadsheet = $reader->load($infil);
        $sheet = $spreadsheet->getActiveSheet();
        $link1 = $sheet->getCell('A1')->getHyperlink();
        self::assertSame('sheet://Sheet2!H48', $link1->getUrl());
        $link2 = $sheet->getCell('A2')->getHyperlink();
        self::assertSame('http://example.com/', $link2->getUrl());
        $link3 = $sheet->getCell('A3')->getHyperlink();
        self::assertSame('http://example.com/#anchor', $link3->getUrl());
        $link4 = $sheet->getCell('A4')->getHyperlink();
        self::assertSame('http://example.com/x.html#link', $link4->getUrl());
        $spreadsheet->disconnectWorksheets();
    }
}