PhpOffice\PhpSpreadsheet\Cell\Hyperlink Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Cell\Hyperlink:

Public Member Functions
	__construct ($pUrl='', $pTooltip='')
	Create a new Hyperlink. More...
	getUrl ()
	Get URL. More...
	setUrl ($value)
	Set URL. More...
	getTooltip ()
	Get tooltip. More...
	setTooltip ($value)
	Set tooltip. More...
	isInternal ()
	Is this hyperlink internal? (to another worksheet). More...
	getTypeHyperlink ()
	getHashCode ()
	Get hash code. More...

Private Attributes
	$url
	$tooltip

Detailed Description

Definition at line 5 of file Hyperlink.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::__construct	(		$pUrl = '',
			$pTooltip = ''
	)

Create a new Hyperlink.

Parameters

string	$pUrl	Url to link the cell to
string	$pTooltip	Tooltip to display on the hyperlink

Definition at line 27 of file Hyperlink.php.

    {
        // Initialise member variables
        $this->url = $pUrl;
        $this->tooltip = $pTooltip;
    }

Member Function Documentation

getHashCode()

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::getHashCode

(

)

Get hash code.

Returns

string Hash code

Definition at line 105 of file Hyperlink.php.

    {
        return md5(
            $this->url .
            $this->tooltip .
            __CLASS__
        );
    }

getTooltip()

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::getTooltip

(

)

Get tooltip.

Returns

string

Definition at line 63 of file Hyperlink.php.

    {
        return $this->tooltip;
    }

References PhpOffice\PhpSpreadsheet\Cell\Hyperlink\$tooltip.

getTypeHyperlink()

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::getTypeHyperlink

(

)

Returns

string

Definition at line 95 of file Hyperlink.php.

    {
        return $this->isInternal() ? '' : 'External';
    }

References PhpOffice\PhpSpreadsheet\Cell\Hyperlink\isInternal().

Here is the call graph for this function:

getUrl()

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::getUrl

(

)

Get URL.

Returns

string

Definition at line 39 of file Hyperlink.php.

    {
        return $this->url;
    }

References PhpOffice\PhpSpreadsheet\Cell\Hyperlink\$url.

isInternal()

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::isInternal

(

)

Is this hyperlink internal? (to another worksheet).

Returns

bool

Definition at line 87 of file Hyperlink.php.

    {
        return strpos($this->url, 'sheet://') !== false;
    }

Referenced by PhpOffice\PhpSpreadsheet\Cell\Hyperlink\getTypeHyperlink().

Here is the caller graph for this function:

setTooltip()

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::setTooltip

(

$value

)

Set tooltip.

Parameters

string

$value

Returns

$this

Definition at line 75 of file Hyperlink.php.

    {
        $this->tooltip = $value;
 
        return $this;
    }

setUrl()

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::setUrl

(

$value

)

Set URL.

Parameters

string

$value

Returns

$this

Definition at line 51 of file Hyperlink.php.

    {
        $this->url = $value;
 
        return $this;
    }

Field Documentation

$tooltip

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::$tooltip

private

Definition at line 19 of file Hyperlink.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Hyperlink\getTooltip().

$url

PhpOffice\PhpSpreadsheet\Cell\Hyperlink::$url

private

Definition at line 12 of file Hyperlink.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Hyperlink\getUrl().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Cell/Hyperlink.php