phpDocumentor base
[ class tree: base ] [ index: base ] [ all elements ]

Class: Image

Source Location: /myphp-1.9/myphp-1.9-base/html/util/Image.php

Class Image

Class Overview

Returns a complete Image as HTML

  1. <img src="$src" width="$width" height="$height"
  2. alt="$alt" class="$class" border="$border" />
  3. Usage:
  4. $image = new Image($src,$width,$height,$alt,$class,$border,$aux);
  5. print $image->getHtml();
  6. Or
  7. Image::display($src,$width,$height,$alt,$class,$border,$aux);

Located in /myphp-1.9/myphp-1.9-base/html/util/Image.php [line 34]

Object
   |
   --Html
      |
      --Image

Properties

Methods

[ Top ]
Direct descendents
Child Class Description
Images Returns a complete Image as HTML

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Html

Html::$elements
Html::$sizeof

Inherited From Object

Object::$cachefile
Object::$html
Object::$sql

Inherited From Html

Html::Html()
Constructor
Html::add()
Add an element, the number of elements are stored internally in an array.
Html::content()
Read the content of the specified filename
Html::display()
Display the html
Html::get()
Get the complete html for a key
Html::getAttribute()
Get the complete html for an attribute, i.e. <a class="myclass" ...
Html::getElement()
Get the element at position $i in array
Html::getElements()
Get all the elements as html
Html::getHtml()
Get Html
Html::getHtmlHelp()
Get html help
Html::getSizeof()
Get the number of elements added
Html::getTag()
Get the complete html for a html tag, i.e. <p>My paragraph</p>
Html::read()
Read the content of the specified filename and language
Html::set()
Set the named attribute (key) of a class to specified value
Html::setObject()
Set the named object to the class attribute (key), with same name
Html::showsource()
Show source
Html::update()
Save the content of the specified filename and language

Inherited From Object

Object::Object()
Constructor
Object::addHtml()
Add the current html to the SourceCode object
Object::getCacheFileName()
Returns the name of the cache file name
Object::getClassName()
Returns the name of the instanciated class
Object::getHtml()
Returns the html for the element
Object::getMsg()
Get the formatted message and debug level and Log to file ?
Object::save()
Save the SQL cache file
Object::setCacheFileName()
Set the path/name of the cache file
Object::toString()
Returns the information for this class
Object::write()
Write the content to the file opened by fp

[ Top ]
Property Summary
String   $alt  
String   $aux  
String   $border  
String   $class  
String   $height  
String   $src  
String   $width  

[ Top ]
Method Summary
Image   Image()   Constructor
void   calculateWidthHeight()   Calculate the width and height, if not specified
void   display()   Display html
String   getHtml()   Get the complete html for an image

[ Top ]
Properties
String   $alt = '' [line 53]

[ Top ]
String   $aux = '' [line 68]

[ Top ]
String   $border = '' [line 63]

[ Top ]
String   $class = '' [line 58]

[ Top ]
String   $height = '' [line 48]

[ Top ]
String   $src = '' [line 38]

[ Top ]
String   $width = '' [line 43]

[ Top ]
Methods
Constructor Image  [line 83]

  Image Image( [String $src = ''], [String $width = ''], [String $height = ''], [String $alt = ''], [String $class = ''], [String $border = ''], [String $aux = '']  )

Constructor

Parameters:
String   $src:  The source path for the image i.e. /logo.gif
String   $width:  The width
String   $height:  The height
String   $alt:  The alt text
String   $class:  The css class for the image
String   $border:  The border of an image
String   $aux:  The new line indicator (nl)

API Tags:
Global:  String 0: IMAGE_SKIN_URL Defines the relative sub url from docroot
Global:  String 1: PROJECT_PATH Defines the full path on the disk to the Project docroot


[ Top ]
calculateWidthHeight  [line 101]

  void calculateWidthHeight( )

Calculate the width and height, if not specified



[ Top ]
display  [line 175]

  void display( [String $src = ''], [String $width = ''], [String $height = ''], [String $alt = ''], [String $class = ''], [String $border = ''], [String $aux = '']  )

Display html

  1. Usage:
  2. Image::display($src,$width,$height,$alt,$class,$border,$aux);

Parameters:
String   $src:  The source path for the image
String   $width:  The width
String   $height:  The height
String   $alt:  The alt text
String   $class:  The css class for the image
String   $border:  The border of an image
String   $aux:  The new line indicator (nl)

API Tags:
Static:  


Redefinition of:
Html::display()
Display the html

Redefined in descendants as:

[ Top ]
getHtml  [line 137]

  String getHtml( )

Get the complete html for an image


API Tags:
Return:  the html


Redefinition of:
Html::getHtml()
Get Html

[ Top ]

Documentation generated on Thu, 22 Dec 2005 17:09:51 +0100 by phpDocumentor 1.3.0RC3