Prado\Web\UI\WebControls\THyperLink

Complexity

Total Complexity

33

Size/Duplication

Total Lines	234
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	getTagName()	0	3	1
A	addAttributesToRender()	0	12	6
A	renderContents()	0	12	4
A	getData()	0	3	1
A	setText()	0	3	1
A	getText()	0	3	1
A	getImageHeight()	0	3	1
A	getNavigateUrl()	0	3	1
A	getImageWidth()	0	3	1
A	setNavigateUrl()	0	3	1
A	getImageAlign()	0	3	1
A	setImageAlign()	0	3	1
A	getImageStyle()	0	7	2
A	getImageUrl()	0	3	1
A	getTarget()	0	3	1
A	setImageUrl()	0	3	1
A	createImage()	0	14	4
A	setTarget()	0	3	1
A	setImageWidth()	0	3	1
A	setData()	0	3	1
A	setImageHeight()	0	3	1

<?php
/**
 * THyperLink class file.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.xisc.com/
 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
 * @package Prado\Web\UI\WebControls
 */

namespace Prado\Web\UI\WebControls;

use Prado\Prado;
use Prado\Web\THttpUtility;

/**
 * THyperLink class
 *
 * THyperLink displays a hyperlink on a page. The hyperlink URL is specified
 * via the {@link setNavigateUrl NavigateUrl} property, and link text is via
 * the {@link setText Text} property. It is also possible to display an image
 * by setting the {@link setImageUrl ImageUrl} property. In this case,
 * the style of the image displayed can be set using the
 * {@link setImageStyle ImageStyle} property and {@link getText Text} is
 * displayed as the alternate text of the image.
 *
 * The link target is specified via the {@link setTarget Target} property.
 * If both {@link getImageUrl ImageUrl} and {@link getText Text} are empty,
 * the content enclosed within the control tag will be rendered.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @package Prado\Web\UI\WebControls
 * @since 3.0
 */
class THyperLink extends \Prado\Web\UI\WebControls\TWebControl implements \Prado\IDataRenderer
{
	/**
	 * @return string tag name of the hyperlink
	 */
	protected function getTagName()
	{
		return 'a';
	}

	/**
	 * Adds attributes related to a hyperlink element to renderer.
	 * @param THtmlWriter $writer the writer used for the rendering purpose

The type Prado\Web\UI\WebControls\THtmlWriter was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	protected function addAttributesToRender($writer)
	{
		$isEnabled = $this->getEnabled(true);
		if ($this->getEnabled() && !$isEnabled) {
			$writer->addAttribute('disabled', 'disabled');
		}
		parent::addAttributesToRender($writer);
		if (($url = $this->getNavigateUrl()) !== '' && $isEnabled) {
			$writer->addAttribute('href', $url);
		}
		if (($target = $this->getTarget()) !== '') {
			$writer->addAttribute('target', $target);
		}
	}

	/**
	 * Renders the body content of the hyperlink.
	 * @param THtmlWriter $writer the writer for rendering
	 */
	public function renderContents($writer)
	{
		if (($imageUrl = $this->getImageUrl()) === '') {
			if (($text = $this->getText()) !== '') {
				$writer->write(THttpUtility::htmlEncode($text));
			} elseif ($this->getHasControls()) {
				parent::renderContents($writer);
			} else {
				$writer->write(THttpUtility::htmlEncode($this->getNavigateUrl()));
			}
		} else {
			$this->createImage($imageUrl)->renderControl($writer);
		}
	}

	/**
	 * Gets the TImage for rendering the ImageUrl property. This is not for
	 * creating dynamic images.
	 * @param string $imageUrl image url.
	 * @return TImage image control for rendering.
	 */
	protected function createImage($imageUrl)
	{
		$image = new TImage;
		$image->setImageUrl($imageUrl);
		if (($toolTip = $this->getToolTip()) !== '') {
			$image->setToolTip($toolTip);
		}
		if (($text = $this->getText()) !== '') {
			$image->setAlternateText($text);
		}
		if (($style = $this->getViewState('ImageStyle', null)) !== null) {
			$image->getStyle()->copyFrom($style);
		}
		return $image;
	}

	/**
	 * @return string the text caption of the THyperLink
	 */
	public function getText()
	{
		return $this->getViewState('Text', '');
	}

	/**
	 * Sets the text caption of the THyperLink.
	 * @param string $value the text caption to be set
	 */
	public function setText($value)
	{
		$this->setViewState('Text', $value, '');
	}

	/**
	 * @return string the alignment of the image with respective to other elements on the page, defaults to empty.
	 * @deprecated use the ImageStyle property to get the float and/or vertical-align CSS properties instead
	 */
	public function getImageAlign()
	{
		return $this->getImageStyle()->getImageAlign();

The method getImageAlign() does not exist on Prado\Web\UI\WebControls\TStyle. Since you implemented __call, consider adding a @method annotation.

	}

	/**
	 * Sets the alignment of the image with respective to other elements on the page.
	 * Possible values include: absbottom, absmiddle, baseline, bottom, left,
	 * middle, right, texttop, and top. If an empty string is passed in,
	 * imagealign attribute will not be rendered.
	 * @param string $value the alignment of the image
	 * @deprecated use the ImageStyle property to set the float and/or vertical-align CSS properties instead
	 */
	public function setImageAlign($value)
	{
		$this->getImageStyle()->setImageAlign($value);

The method setImageAlign() does not exist on Prado\Web\UI\WebControls\TStyle. Since you implemented __call, consider adding a @method annotation.

	}

	/**
	 * @return string height of the image in the THyperLink
	 * @deprecated use the ImageStyle.Height property to get the height instead
	 */
	public function getImageHeight()
	{
		return $this->getImageStyle()->getHeight();
	}

	/**
	 * Sets the height of the image in the THyperLink
	 * @param string $value height of the image in the THyperLink
	 * @deprecated use the ImageStyle property to set the height CSS property instead
	 */
	public function setImageHeight($value)
	{
		$this->getImageStyle()->setHeight($value);
	}

	/**
	 * @return string the location of the image file for the THyperLink
	 */
	public function getImageUrl()
	{
		return $this->getViewState('ImageUrl', '');
	}

	/**
	 * Sets the location of image file of the THyperLink.
	 * @param string $value the image file location
	 */
	public function setImageUrl($value)
	{
		$this->setViewState('ImageUrl', $value, '');
	}

	/**
	 * @return string width of the image in the THyperLink
	 * @deprecated use the ImageStyle.Width property to get the width property instead
	 */
	public function getImageWidth()
	{
		return $this->getImageStyle()->getWidth();
	}

	/**
	 * Sets the width of the image in the THyperLink
	 * @param string $value width of the image
	 * @deprecated use the ImageStyle property to set the width CSS property instead
	 */
	public function setImageWidth($value)
	{
		$this->getImageStyle()->setWidth($value);
	}

	/**
	 * @return TStyle the style for the inner image
	 */
	public function getImageStyle()
	{
		if (($style = $this->getViewState('ImageStyle', null)) === null) {
			$style = new TStyle;
			$this->setViewState('ImageStyle', $style, null);
		}
		return $style;
	}

	/**
	 * @return string the URL to link to when the THyperLink component is clicked.
	 */
	public function getNavigateUrl()
	{
		return $this->getViewState('NavigateUrl', '');
	}

	/**
	 * Sets the URL to link to when the THyperLink component is clicked.
	 * @param string $value the URL
	 */
	public function setNavigateUrl($value)
	{
		$this->setViewState('NavigateUrl', $value, '');
	}

	/**
	 * Returns the URL to link to when the THyperLink component is clicked.
	 * This method is required by {@link \Prado\IDataRenderer}.
	 * It is the same as {@link getText()}.
	 * @return string the text caption
	 * @see getText
	 * @since 3.1.0
	 */
	public function getData()
	{
		return $this->getText();
	}

	/**
	 * Sets the URL to link to when the THyperLink component is clicked.
	 * This method is required by {@link \Prado\IDataRenderer}.
	 * It is the same as {@link setText()}.
	 * @param string $value the text caption to be set
	 * @see setText
	 * @since 3.1.0
	 */
	public function setData($value)
	{
		$this->setText($value);
	}

	/**
	 * @return string the target window or frame to display the Web page content linked to when the THyperLink component is clicked.
	 */
	public function getTarget()
	{
		return $this->getViewState('Target', '');
	}

	/**
	 * Sets the target window or frame to display the Web page content linked to when the THyperLink component is clicked.
	 * @param string $value the target window, valid values include '_blank', '_parent', '_self', '_top' and empty string.
	 */
	public function setTarget($value)
	{
		$this->setViewState('Target', $value, '');
	}
}