PHPExcel_Cell_Hyperlink Class Reference

Collaboration diagram for PHPExcel_Cell_Hyperlink:

Public Member Functions
	__construct (PHPExcel_Cell $pCell=null, $pUrl= '', $pTooltip= '')
	Create a new PHPExcel_Cell_Hyperlink.
	getUrl ()
	Get URL.
	setUrl ($value= '')
	Set URL.
	getTooltip ()
	Get tooltip.
	setTooltip ($value= '')
	Set tooltip.
	isInternal ()
	Is this hyperlink internal? (to another sheet)
	getParent ()
	Get parent.
	setParent ($value=null)
	Set Parent.
	getHashCode ()
	Get hash code.

Private Attributes
	$_cell
	$_url
	$_tooltip

Detailed Description

Definition at line 36 of file Hyperlink.php.

Constructor & Destructor Documentation

PHPExcel_Cell_Hyperlink::__construct	(	PHPExcel_Cell	$pCell = null,
			$pUrl = '',
			$pTooltip = ''
	)

Create a new PHPExcel_Cell_Hyperlink.

Parameters

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

Exceptions

Exception

Definition at line 67 of file Hyperlink.php.

    {
        // Initialise member variables
                $this->_url             = $pUrl;
                $this->_tooltip         = $pTooltip;
        
        // Set cell
        $this->_parent          = $pCell;
    }

Member Function Documentation

PHPExcel_Cell_Hyperlink::getHashCode

(

)

Get hash code.

Returns

string Hash code

Definition at line 151 of file Hyperlink.php.

                                      {
        return md5(
                  $this->_url
                . $this->_tooltip
                . $this->_parent->getCoordinate()
                . __CLASS__
        );
    }

PHPExcel_Cell_Hyperlink::getParent

(

)

Get parent.

Returns

PHPExcel_Cell

Definition at line 131 of file Hyperlink.php.

                                {
        return $this->_parent;
    }

PHPExcel_Cell_Hyperlink::getTooltip

(

)

Get tooltip.

Returns

string

Definition at line 102 of file Hyperlink.php.

References $_tooltip.

                                     {
                return $this->_tooltip;
        }

PHPExcel_Cell_Hyperlink::getUrl

(

)

Get URL.

Returns

string

Definition at line 82 of file Hyperlink.php.

References $_url.

                                 {
                return $this->_url;
        }

PHPExcel_Cell_Hyperlink::isInternal

(

)

Is this hyperlink internal? (to another sheet)

Returns

boolean

Definition at line 122 of file Hyperlink.php.

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

PHPExcel_Cell_Hyperlink::setParent

(

$value = null

)

Set Parent.

Parameters

PHPExcel_Cell

$value

Returns

PHPExcel_Cell_Hyperlink

Definition at line 141 of file Hyperlink.php.

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

PHPExcel_Cell_Hyperlink::setTooltip

(

$value = ''

)

Set tooltip.

Parameters

string

$value

Returns

PHPExcel_Cell_Hyperlink

Definition at line 112 of file Hyperlink.php.

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

PHPExcel_Cell_Hyperlink::setUrl

(

$value = ''

)

Set URL.

Parameters

string

$value

Returns

PHPExcel_Cell_Hyperlink

Definition at line 92 of file Hyperlink.php.

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

Field Documentation

PHPExcel_Cell_Hyperlink::$_cell

private

Definition at line 43 of file Hyperlink.php.

PHPExcel_Cell_Hyperlink::$_tooltip

private

Definition at line 57 of file Hyperlink.php.

Referenced by getTooltip().

PHPExcel_Cell_Hyperlink::$_url

private

Definition at line 50 of file Hyperlink.php.

Referenced by getUrl().

---

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

• Services/Excel/classes/PHPExcel/Cell/Hyperlink.php