File Source for HTMLLink.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package html
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
exit();
}
/**
* Including the base class for html-tags.
*/
require_once( CLASSPATH."html/ABSTHTMLTag.class.php" );
/**
*
*/
include_once( CLASSPATH."html/JavaScript.class.php" );
/**
* Creating HTML-Tags
*
* @package html
* @final
* @version 0.2.01
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (c) 2004 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class HTMLLink extends ABSTHTMLTag
{
/**
* @var string $href
* @access public
*/
var $href;
/**
* @var string $label
* @access public
*/
var $label;
/**
* @var string $target
* @access public
*/
var $target;
/**
* @var string $str_parameter_add_on_mouseover
* @access public
*/
var $str_parameter_add_on_mouseover;
/**
* Constructor.
*
* @version 1.2
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $href The value of the href-attribute of this
* anker.
* @param string $label The label of this anker.
* @param string $style_class
* @param string $target
* @return void
*/
function HTMLLink( $href, $label, $style_class = "", $target = "" )
{
$this->href = $href;
$this->label = $label;
$this->style_class = $style_class;
$this->target = $target;
}
/**
* Sets the value of the href-attribute of this link.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string The value of the href-attribute of this anker.
* @return void
*/
function setHREF( $string )
{ $this->href = $string; }
/**
* Sets the label of this link.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string The value of the label of this anker.
* @return void
*/
function setLabel( $string )
{ $this->label = $string; }
/**
* Sets the target of this link.
*
* @version 1.0
* @since 0.1.6
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string The value of the label of this anker.
* @return void
*/
function setTarget( $string )
{ $this->target = $string; }
/**
* Sets the mouseup that should add to all anker, that is defined in a
* script. It will concatenate befor the instance specified mouseup.
*
* @version 1.0
* @since 0.1.8
* @static
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $str_mouse_up The static value of "onMouseup"-Attribute.
* @return string
*/
function manageStaticMouseUp( $str_mouse_up = "" )
{
static $str_stat_mouse_up = "";
if ( !empty( $str_mouse_up ) )
$str_stat_mouse_up = $str_mouse_up;
return $str_stat_mouse_up;
}
/**
* Sets the parameter that should be add on each link by a javascript on
* mouseover. This is useful to carry a session-id through all scripts.
*
* @version 1.0
* @since 0.2.0
* @static
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $str_mouse_up The static value of "onMouseup"-Attribute.
* @return string
*/
function manageStaticParameterAdd( $str_parameter_add = "" )
{
static $str_stat_parameter_add = "";
if ( !empty( $str_parameter_add ) )
$str_stat_parameter_add = $str_parameter_add;
return $str_stat_parameter_add;
}
/**
* Adds a javascript that adds parameter to the hyper reference of this
* anker. This is useful for search engine optimated sites. For example you
* can add a session-id or parameter that should hide from search-spiders.
*
* @version 1.0
* @since 0.1.9
* @static
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $withJSdeclaration
* @return void
*/
function getJavaScriptToAddParameterToHREF( $withJSdeclaration = false )
{
static $alreadyIncluded = false;
if ( !$alreadyIncluded )
{
$str_out = <<<JSCODE
function addParameter( which_obj, str_param )
{
if ( which_obj.getAttribute( 'parameterAdded' ) != 'true' )
{
str_href = which_obj.getAttribute( 'href' );
which_obj.setAttribute( 'href', str_href + str_param );
which_obj.setAttribute( 'parameterAdded', 'true' );
}
}
JSCODE;
if ( $withJSdeclaration === true )
{
$js = new JavaScript();
$js->add( $str_out );
$str_out = $js->get();
}
$alreadyIncluded = true;
}
return $str_out;
}
/**
* Adds a javascript that adds parameter to the hyper reference of this
* anker. This is useful for search engine optimated sites. For example you
* can add a session-id or parameter that should hide from search-spiders.
*
* @version 1.0
* @since 0.1.9
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $str_parameter
* @return void
*/
function addParameterOnMouseOver( $str_parameter )
{ $this->str_parameter_add_on_mouseover = $str_parameter; }
/**
* Returns a generated string based on the attributes of this HTML-Object.
*
* @version 1.62
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function get()
{
$outputstr = "";
if (
!empty( $this->str_parameter_add_on_mouseover )
&& $this->href != "#"
)
if ( class_exists( "HTMLDocument" ) )
$GLOBALS["javascript_content"][]
= $this->getJavaScriptToAddParameterToHREF();
else
$outputstr .= $this->getJavaScriptToAddParameterToHREF( true );
$this->idExists( $this->id, true );
$str_stat_mouse_up = HTMLLink::manageStaticMouseUp();
if (
!empty( $str_stat_mouse_up )
&& strpos( $this->mouseup, $str_stat_mouse_up ) === false
&& $this->href != "#"
)
$this->mouseup = $str_stat_mouse_up.";".$this->mouseup;
$str_stat_parameter_add = HTMLLink::manageStaticParameterAdd();
if (
!empty( $str_stat_parameter_add )
&& $this->href != "#"
)
{
if ( preg_match( "!^[^?&]!", $str_stat_parameter_add ) )
if ( empty( $this->str_parameter_add_on_mouseover ) )
$this->str_parameter_add_on_mouseover = "?";
else
$this->str_parameter_add_on_mouseover .= "&";
$this->str_parameter_add_on_mouseover .= $str_stat_parameter_add;
}
$outputstr .= "<a ".(
!empty( $this->href )
? "href=\"".$this->href."\" "
: ""
)
."onFocus=\"if(this.blur)this.blur()\""
.( !empty( $this->name )
? " name=\"".$this->name."\""
: ""
)
.( !empty( $this->id )
? " id=\"".$this->id."\""
: ""
)
.(
!empty( $this->freestyle )
? " style=\"".$this->freestyle."\""
: ""
)
.( !empty( $this->blur )
? " onBlur=\"".$this->blur."\""
: ""
)
.( !empty( $this->click )
? " onClick=\"".$this->click."\""
: ""
)
.( !empty( $this->mousemove )
? " onMousemove=\"".$this->mousemove."\""
: ""
)
.( !empty( $this->mouseup )
? " onMouseup=\"".$this->mouseup."\""
: ""
)
.( !empty( $this->mouseout )
? " onMouseout=\"".$this->mouseout."\""
: ""
)
.(
!empty( $this->mouseover )
|| !empty( $this->str_parameter_add_on_mouseover )
? " onMouseover=\"".(
!empty( $this->str_parameter_add_on_mouseover )
&& $this->href != "#"
? "addParameter( "
."this, '"
.$this->str_parameter_add_on_mouseover."'"
." );"
: ""
).$this->mouseover."\""
: ""
)
.( !empty( $this->style_class )
? " class=\"".$this->style_class."\""
: ""
)
.( !empty( $this->target )
? " target=\"".$this->target."\""
: ""
)
.">"
.$this->label."</a"
.(
$this->no_format
? ""
: "\r\n"
).">";
return $outputstr;
}
} // END of class HTMLLink
?>

Source for file HTMLLink.class.php