phpDocumentor base
[ class tree: base ] [ index: base ] [ all elements ]
base
Packages:
base
cache
component
db
db-init
ecommerce
file
form
layout
log
menu
mvc
myPHP
page
profiler
sax
showsource
sms
summa
tab
table
template
tree-node
util

Files:
BodyEnd.php
BodyStart.php
Configuration.php
Css.php
Css.php
CssBase.php
DataReader.php
Debug.php
Default.php
Define.php
DocType.php
Fieldset.php
HeadStart.php
Html.php
Image.php
ImageLink.php
Images.php
index.php
Info.php
init.php
Initialize.php
Javascript.php
Layout.php
Legend.php
Link.php
Links.php
Meta.php
myphp-package.php
Noscript.php
Object.php
Picture.php
Raw.php
Rowcolor.php
Setup.php
ShortcutIcon.php
Skin.php
Title.php

Classes:
BodyEnd
BodyStart
Css
CssBase
DataReader
Debug
DocType
Fieldset
HeadStart
Html
Image
ImageLink
Images
Info
Javascript
Legend
Link
Links
Meta
Noscript
Object
Picture
Raw
Rowcolor
ShortcutIcon
Skin
Title

Class: Html

Source Location: /myphp-1.9/myphp-1.9-base/html/Html.php

Class Html

Class Overview
Class Overview | Descendants | Inherited Properties, Constants, and Methods | Properties Summary | Properties Detail | Method Summary | Methods Detail

The base class for all the HTML classes

You must extend this class and write your own getHtml() method 

  1.  Usage:
    2. 

  2.     class Demo extends Html {
    3. 

  3.        function Demo() { $this->Html(); }      // Constructor
    4. 

  4.        
    5. 

  5.        function getHtml() { return 'Hey Demo'; } // Abstract
    6. 

  6.     
    7. 

  7.     }
    8.

Located in /myphp-1.9/myphp-1.9-base/html/Html.php [line 38] 

Object
   |
   --Html

Properties

Methods
[ Top ]
Direct descendents
Class Overview | Descendents | Inherited Properties and Methods | Properties Summary | Properties Detail | Method Summary | Methods Detail
Child Class Description
BodyEnd Generates the Body/Html End tags: </body></html>
BodyStart Generates the Body Start
Css Generates the html for the css filename
DocType Generates the html for the Doc Type
HeadStart The Head Start.
Info Generates the hidden Info as html
Javascript Javascript file.
Meta The Meta Object.
Noscript Generates the html for the noscript tag
ShortcutIcon The ShortcutIcon.
Title The Title for a page.
Fieldset Generates an FIELDSET form element
Image Returns a complete Image as HTML
ImageLink Returns a complete Image surronded by a link as HTML
Legend Generates an LEGEND form element
Link Returns a complete Link as HTML
Picture Create the link/image for all the pictures in /images/w200/
Raw The Raw html.
Skin The Skin object which is rendering a command as a link/image
Domains List the Domains and creates a link to each domain
Imagerotator Image Rotator. An image is shown in an round robin fasion
Rejseplanen Used to popup the Travel form for Rejseplanen
Shipping Returns the calculated Shipping
Tax Returns the calculated tax
Form Generates a html form
Input Generates an INPUT element for a form
Label Generates a html form LABEL element
Option Generates an OPTION form element
Select Generates a SELECT form element
Textarea Generates a html form elements, TEXTAREA
Banner Generates a Banner
Bannerif Generates a Banner within an IFRAME
Branding Generates a Branding Top
Company Used to get/display the Company Information
Copyright Used to get/display the Copyright Information
Customer Used to get/display the Customer Information
Firma Used to get/display the Company Information
Footer Used to get/display the Footer Information
Locator Display the navigation path
Top Generates a Top banner with image links
Design Design the system constants as checkbox, radio box or input fields
Line Used to draw a line, in order to show some visual effects
EngineGoogle The Engine is the controller for a google search
Google Generates a Google search box
Icons Generates the Icons to show
Menu Generates a Menu element (tab,top,left,right or bottom menu)
MenuLink Used to View subdirectories via the web This is not considered a hacker tool, because every skilled web developer can do this stuff.
EngineObject The EngineObject is the base class for other engines
Grid Generates the html for a Grid
Page Generates the html for a Page. This is the taglib
Comment Generates a Comment object
Div Generates a <div class="$class" align="$align">$text</div>
Document Generates a javascript
Iframe Returns a complete IFRAME as HTML
Paragraph Generates a plain Paragraph object, surronded by a the '<p>' html element
Span Generates an <span>...</span>
Text Generates a plain Text object, surronded by a html element
SmsEngine The SMS Engine for a sms messages
SmsErrorView Get the View of the SMS Error messages
SmsThanksView Get the View of the SMS Thanks messages
SmsView Get the View of the SMS View Form for a sms messages
SummaSummarum Summa Summarum.
Index Generates a list of links, like in an Index
Tab Generates a Tab navigation menu
TabBody Generates a Tab navigation menu
Table Generates the html for a table
TableHeader Generates a table header
Td Generates a table Data column
Th The Table Header Data.
Tr Generates a table row
Tree The Tree class builds a complete navigation tree
Node The Node class
NodeView The NodeView class reflects a node with a link and an image
Referer The Referer object.

[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Descendants | | Inherited Properties, Constants, and Methods | Properties Summary | Properties Detail | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Object

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

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
Class Overview | Descendents | Inherited Properties and Methods | Property Summary | Properties Detail Method Summary | Methods Detail
array   $elements  
int   $sizeof  

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

[ Top ]
Properties
Class Overview | Descendents | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
array   $elements = array() [line 42]

[ Top ]
int   $sizeof = 0 [line 47]

[ Top ]
Methods
Class Overview | Descendents Inherited Properties and Methods | | Property Summary | Properties Detail | Method Summary | Methods Detail
Constructor Html  [line 52]

  Html Html( )

Constructor



[ Top ]
add  [line 205]

  void add( Object $element  )

Add an element, the number of elements are stored internally in an array.

Parameters:
Object   $element:  The element to add to array


[ Top ]
content  [line 300]

  String content( String $filename  )

Read the content of the specified filename 

  1.  Usage:
    2. 

  2.     Html::content($filename);
    3.

Parameters:
String   $filename:  The filename to read

API Tags:
Return:  The content or empty
Static:  


[ Top ]
display  [line 424]

  void display( [String $value = ''], [String $tag = '']  )

Display the html 

  1.  Usage:
    2. 

  2.     Html::display($value,$tag);
    3. 

  3.     i.e. Html::display('p','my tag')
    4.

Parameters:
String   $value:  The inner html for the tag,
String   $tag:  The tag to get

API Tags:
Static:  

Redefined in descendants as:

[ Top ]
get  [line 119]

  String get( String $key, [String $default = '']  )

Get the complete html for a key

Display an error message and exit, If not a known attribute i.e. You MUST define the 'key' at class scope as ... var $mykey='';

 Parameters:
String   $key:  The value to return
String   $default:  The default value to use if no match

API Tags:
Return:  the html for the attribute (key)

Redefined in descendants as:

[ Top ]
getAttribute  [line 160]

  String getAttribute( String $attribute, [String $default = '']  )

Get the complete html for an attribute, i.e. <a class="myclass" ...

Usage: print '<a '.$html->getAttribute('href').'>test</a>';

 Parameters:
String   $attribute:  The attribute to return
String   $default:  The value to return, if attribute is specified, but empty

API Tags:
Return:  the html for the attribute


[ Top ]
getElement  [line 231]

  Object getElement( mixed $i, int $i,  )

Get the element at position $i in array

Parameters:
int   $i,:  the element $i in array

API Tags:
Return:  The element in question or '' if not found

Redefined in descendants as:

[ Top ]
getElements  [line 243]

  String getElements( )

Get all the elements as html


API Tags:
Return:  The html for all the element in the array


[ Top ]
getHtml  [line 259]

  String getHtml( )

Get Html

Returns the html for the element
API Tags:
Return:  The complete html
Abstract:  

Redefinition of:
Object::getHtml()
Returns the html for the element
Redefined in descendants as:

[ Top ]
getHtmlHelp  [line 277]

  String getHtmlHelp( )

Get html help

Link to open a new window with online help (PHPDoc) and/or ShowSourceCode Returns the html help for the element
API Tags:
Return:  The complete html help
Abstract:  


[ Top ]
getSizeof  [line 222]

  int getSizeof( )

Get the number of elements added


API Tags:
Return:  The number of elements in array


[ Top ]
getTag  [line 183]

  String getTag( String $value, String $tag  )

Get the complete html for a html tag, i.e. <p>My paragraph</p>

Usage: print '$html->getTag('My paragraph','p'); Returns '', if value is empty

 Parameters:
String   $value:  The inner html for the tag,
String   $tag:  The tag to get

API Tags:
Return:  the html for the attribute

Redefined in descendants as:
  • Css::getTag() : Returns the css details for the specified html tag(s)

[ Top ]
read  [line 337]

  String read( String $filename, [String $language = ''], [String $domainname = '']  )

Read the content of the specified filename and language

Use default filename, if no language found 

  1.  Usage:
    2. 

  2.     Html::read($filename,$language,$domainname);
    3.

Parameters:
String   $filename:  The filename to read
String   $language:  The language to use
String   $domainname:  The Domain Name to use

API Tags:
Return:  The content or empty
Static:  


[ Top ]
set  [line 95]

  void set( String $key, String $value  )

Set the named attribute (key) of a class to specified value

Display an error message and exit, If not a known attribute i.e. You MUST define the attribute at class scope as ... var $myattr='';

 Parameters:
String   $key:  The key to set
String   $value:  The value of the key


[ Top ]
setObject  [line 61]

  void setObject( String $key, Object $object  )

Set the named object to the class attribute (key), with same name

Parameters:
String   $key:  The key to associate with the object
Object   $object:  The object to set


[ Top ]
showsource  [line 440]

  void showsource( [String $path = 'HTML_PATH'], [String $aux = '']  )

Show source 

  1.  Usage:
    2. 

  2.     Classname:showsource($path,$aux);
    3. 

  3.  i.e. Classname:showsource();
    4.

Parameters:
String   $path:  The name of the path to the source file. I.e. HTML_PATH
String   $aux:  The type of link to use: BR LI

API Tags:
Static:  


[ Top ]
update  [line 383]

  boolean update( String $content, String $filename, [String $language = '']  )

Save the content of the specified filename and language

Use default filename, if no language found 

  1.  Usage:
    2. 

  2.     $rc = Html::update($content,$filename,$language);
    3.

Parameters:
String   $content:  The Content to save
String   $filename:  The filename to use
String   $language:  The language to use

API Tags:
Return:  The result true on success, false on failure
Static:  


[ Top ]
Documentation generated on Thu, 22 Dec 2005 17:09:28 +0100 by phpDocumentor 1.3.0RC3
  @copyright 1999-2006 Web Expert Finn Rasmussen