File Source for HTMLImage.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 basic class of all HTML-tags.
*/
require_once( CLASSPATH."html/ABSTSourceObject.class.php" );
/**
* Creating HTML-Images
*
* @package html
* @version 0.1.51
* @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 HTMLImage extends ABSTSourceObject
{
/**
* The alt-attribute of the image-tag.
*
* @var string $alt
* @access public
*/
var $alt;
/**
* The title-attribute of the image-tag.
*
* @var string $title
* @access public
*/
var $title;
/**
* The path of the source to the image on mouseover.
*
* @var boolean $over_src_set
* @access public
*/
var $over_src_set = false;
/**
* Stores the value of the border-attribute of this image.
*
* @var integer $border
* access public
*/
var $border;
/**
* Stores whether the image should be a gallery image.
*
* @var boolean $gallery_img
* access public
*/
var $gallery_img = false;
/**
* Constructor
* Note: you can set the value of $validate_path for last parameter; you
* don't need to give values of $width, $height or $border if they have
* no value!
*
* @version 1.1
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $src Source of the image.
* @param integer $width
* @param integer $height
* @param boolean $validate_path
* @return void
*/
function HTMLImage(
$src, $width = 0, $height = 0,
$border = 0, $validate_path = true
)
{
// Get the value of $validate_path. Do not check the first parameter!
for ( $i = 1; $i < func_num_args(); $i++ )
if ( is_bool( func_get_arg( $i ) ) )
{
$validate_path = func_get_arg( $i );
break;
}
$this->setSRC( $src, $validate_path );
$this->setWidth( $width );
$this->setHeight( $height );
$this->setBorder( $border );
}
/**
* Sets the source of this image.
*
* @version 1.4
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $string
* @param boolean $validate_path
* @return void
*/
function setSRC( $string, $validate_path = true )
{
if (
!$validate_path
|| preg_match( "!\.(?:gif|jpg|jpeg|png)$!i", $string )
)
parent::setSRC( $string, $validate_path );
else
if ( !empty( $string ) )
{
echo "<pre>\r\n";
echo "The value \"".$string."\" is not valid for the source of an "
."image. "
."The value has to be a path to an image! \r\n";
$debugArr = debug_backtrace();
print_r( $debugArr[count( $debugArr )-1] );
echo "</pre>\r\n";
exit();
}
}
/**
* Sets the source of this image on mouseover.
*
* @version 1.0
* @since 0.1.2
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setOverSRC( $string )
{
if(
$this->over_src_set
&& defined( "DEBUG" )
)
{
echo "<pre>\r\n";
echo "The over state of this image is already set. \r\n";
$debugArr = debug_backtrace();
print_r( $debugArr[count( $debugArr )-1] );
echo "</pre>\r\n";
exit();
}
if(
preg_match(
"!^(?:[-._A-Za-z0-9]+/)*"
."[-._A-Za-z0-9]+\."
."(?:gif|jpg|jpeg|png)$!", $string
)
)
{
$this->mouseover = "swapImage( this, '".$string."' )"
.$this->mouseover;
$this->mouseout = "swapImage( this, '".$this->src."' )"
.$this->mouseout;
$this->over_src_set = true;
}
else
if( !empty( $string ) )
{
echo "<pre>\r\n";
echo "The value \"".$string."\" is not valid for the source of an "
."image. "
."The value has to be a path to an image! \r\n";
$debugArr = debug_backtrace();
print_r( $debugArr[count( $debugArr )-1] );
echo "</pre>\r\n";
exit();
}
}
/**
* Sets the border of this image.
*
* @version 1.0
* @since 0.1.1
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param integer $int
* @return void
*/
function setBorder( $int = 0 )
{
if( preg_match( "!^".UNSIGNEDINTEGER."$!", $int ) )
$this->border = $int;
else
die(
"The value \"".$int."\" is not valid for the border of an "
."image. "
."The value has to be a number!"
);
}
/**
* Sets the alt-attribute of this image.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setAlt( $string = "" )
{
$this->alt = $string;
$this->setTitle( $string, true );
}
/**
* Sets the title-attribute of this image.
*
* @version 1.0
* @since 0.1.5
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $string
* @param string $invoke_from_alt
* @return void
*/
function setTitle( $string = "", $invoke_from_alt = false )
{
static $tset = false;
if (
!$tset
|| !$invoke_from_alt
)
$this->title = $string;
$tset = false;
}
/**
/**
* Returns a javascript-function to swap a given image to given source.
*
* @static
* @version 1.0
* @since 0.1.8
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param boolean $withJSdeclaration
* @return string
*/
function getJS2swapImages( $withJSdeclaration = false )
{
if( !$withJSdeclaration )
$out = JavaScript::getInArray();
else
{
$js = new Javascript();
$js->setInArray();
}
# Put this function in the onMouseup-attribute of the img-tag!
# Use this function never before using the function swapImage,
# this will cause no changing-effect.
$js1 = " stateIMG = undefined;\r\n"
." imgObj = new Array();\r\n"
." function swapImage( which, path )\r\n"
." {\r\n"
." if( !in_array( which, imgObj ) )\r\n"
." {\r\n"
." imgObj[imgObj.length] = new Array();\r\n"
." imgObj[imgObj.length - 1][0] = which;\r\n"
." imgObj[imgObj.length - 1][1] = which.src;\r\n"
." }\r\n\r\n"
." if( !stateIMG || which != stateIMG )\r\n"
." which.src = path;\r\n"
." }\r\n\r\n";
$js2 = " function stateImage( which )\r\n"
." {\r\n"
." for( i = 0; i < imgObj.length; i++ )\r\n"
." if( imgObj[i][0] == stateIMG )\r\n"
." {\r\n"
." imgObj[i][0].src = imgObj[i][1];\r\n"
." break;\r\n"
." }\r\n\r\n"
." stateIMG = which;\r\n"
." }\r\n\r\n";
# Put this function in the onMouseout-attribute of the img-tag!
$js3 = " function restoreImage( which )\r\n"
." {\r\n"
." for( i = 0; i < imgObj.length; i++ )\r\n"
." if( which != stateIMG "
."&& imgObj[i][0] == which )\r\n"
." {\r\n"
." imgObj[i][0].src = imgObj[i][1];\r\n"
." return;\r\n"
." }\r\n"
." }\r\n\r\n";
if( !$withJSdeclaration )
$out .= $js1.$js2.$js3;
else
{
$js->add( $js1 );
$js->add( $js2 );
$js->add( $js3 );
$out = $js->get();
}
return $out;
}
/**
* Returns a generated string based on the attributes of this HTML-Object.
*
* @version 1.43
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function get()
{
static $overJSoutput = false;
$out = "";
if(
!$overJSoutput
&& preg_match ( "!swapImage\(!", $this->mouseover )
)
{
if ( class_exists( "HTMLDocument" ) )
$GLOBALS["javascript_content"][] = HTMLImage::getJS2swapImages();
else
$out .= HTMLImage::getJS2swapImages( true );
$overJSoutput = true;
}
$out .= "<img alt=\"".$this->alt."\" "
.( !empty( $this->title )
? "title=\"".$this->title."\" "
: ""
)
.( !empty( $this->src )
? "src=\"".$this->src."\" "
: ""
)
.(
(
!empty( $this->width )
&& preg_match( "!^".UNSIGNEDINTEGER."%?$!", $this->width )
)
? "width=\"".$this->width."\" "
: ""
)
.(
(
!empty( $this->height )
&& preg_match( "!^".UNSIGNEDINTEGER."%?$!", $this->height )
)
? "height=\"".$this->height."\" "
: ""
)
.(
$this->gallery_img
? ""
: "galleryimg=\"no\" "
)
.( !empty( $this->name )
? "name=\"".$this->name."\" "
: ""
)
.( !empty( $this->id )
? "id=\"".$this->id."\" "
: ""
)
.( !empty( $this->style_class )
? "class=\"".$this->style_class."\" "
: ""
)
.( !empty( $this->click )
? "onClick=\"".$this->click."\" "
: ""
)
.( !empty( $this->mouseup )
? "onMouseup=\"".$this->mouseup."\" "
: ""
)
.( !empty( $this->mouseout )
? "onMouseout=\"".$this->mouseout."\" "
: ""
)
.( !empty( $this->mouseover )
? "onMouseover=\"".$this->mouseover."\" "
: ""
)
.( !empty( $this->freestyle )
? "style=\"".$this->freestyle."\" "
: ""
)
.( preg_match( "!^".UNSIGNEDINTEGER."$!", $this->border )
? "border=\"".$this->border."\" "
: ""
)
.( !empty( $this->other_attributes )
? " ".$this->other_attributes." "
: ""
)
."/>";
return $out;
}
} // End of class HTMLImages
?>

Source for file HTMLImage.class.php