<?php

namespace TablePress\PhpOffice\PhpSpreadsheet\Calculation\LookupRef;

use TablePress\PhpOffice\PhpSpreadsheet\Calculation\Functions;
use TablePress\PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
use TablePress\PhpOffice\PhpSpreadsheet\Cell\Cell;
use TablePress\PhpOffice\PhpSpreadsheet\Shared\StringHelper;

class Hyperlink
{
	/**
	 * HYPERLINK.
	 *
	 * Excel Function:
	 *        =HYPERLINK(linkURL, [displayName])
	 *
	 * @param mixed $linkURL Expect string. Value to check, is also the value returned when no error
	 * @param mixed $displayName Expect string. Value to return when testValue is an error condition
	 * @param ?Cell $cell The cell to set the hyperlink in
	 *
	 * @return string The value of $displayName (or $linkURL if $displayName was blank)
	 */
	public static function set($linkURL = '', $displayName = null, ?Cell $cell = null): string
	{
		$linkURL = ($linkURL === null) ? '' : StringHelper::convertToString(Functions::flattenSingleValue($linkURL));
		$displayName = ($displayName === null) ? '' : Functions::flattenSingleValue($displayName);

		if ((!is_object($cell)) || (trim($linkURL) == '')) {
			return ExcelError::REF();
		}

		if (is_object($displayName)) {
			$displayName = $linkURL;
		}
		$displayName = StringHelper::convertToString($displayName);
		if (trim($displayName) === '') {
			$displayName = $linkURL;
		}

		$cell->getHyperlink()
			->setUrl($linkURL);
		$cell->getHyperlink()->setTooltip($displayName);

		return $displayName;
	}
}
