Prado\Util\Behaviors\TPageTopAnchorBehavior

Complexity

Total Complexity

5

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getTopAnchor()	0	3	1
A	addFormANameAnchor()	0	6	2
A	setTopAnchor()	0	3	1
A	events()	0	3	1

<?php

/**
 * TPageTopAnchorBehavior class file.
 *
 * @author Brad Anderson <belisoful@icloud.com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

namespace Prado\Util\Behaviors;

use Prado\Util\TBehavior;
use Prado\TPropertyValue;

/**
 * TPageTopAnchorBehavior class.
 *
 * TPageTopAnchorBehavior adds an "<a name='top'>" anchor at the top of
 * every page just before the TForm.
 * @author Brad Anderson <belisoful@icloud.com>
 * @package Prado\Util\Behaviors
 * @since 4.2.0
 */
class TPageTopAnchorBehavior extends TBehavior
{
	/**
	 * @var string the page theme is set to this parameter key
	 */
	private $_topAnchor = 'top';
	
	/**
	 * This handles the TPage.OnSaveStateComplete event to place the
	 * '<a name="">' at the last moment and have least interference with
	 * anything else
	 * @return array of events as keys and methods as values
	 */
	public function events()
	{
		return ['OnSaveStateComplete' => 'addFormANameAnchor'];
	}
	
	/**
	 * This method places an '<a name="">' before the TForm
	 * @param $page object raising the event
	 * @param $param mixed the parameter of the raised event
	 */
	public function addFormANameAnchor($page, $param)

The parameter $param is not used and could be removed.

	{
		$topanchor = '<a name="' . $this->_topAnchor . '"></a>';
		
		if ($form = $page->getForm()) {
			$form->getParent()->getControls()->insertBefore($form, $topanchor);
		}
	}
	 
	/**
	 * @return string the top anchor name, defaults to 'top'.
	 */
	public function getTopAnchor()
	{
		return $this->_topAnchor;
	}
	 
	/**
	 * @param $value string the top anchor name.
	 */
	public function setTopAnchor($value)
	{
		$this->_topAnchor = TPropertyValue::ensureString($value);
	}
}