Class: Comment

Source Location: /myphp-1.9/myphp-1.9-page/html/util/Comment.php

Class Comment

Class Overview

Generates a Comment object

 Usage:
   $comment = new Comment($text,$commmentStart,$commmentEnd);
   print $comment->getHtml();
 Or
   Comment::display($text,$commmentStart,$commmentEnd);

Located in /myphp-1.9/myphp-1.9-page/html/util/Comment.php [line 33]

Object
   |
   --Html
      |
      --Comment

Properties

Methods

[ 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	$commmentEnd
String	$commmentStart
String	$text

[ Top ]

Method Summary

Comment	Comment()	Constructor
void	display()	Display html
String	getHtml()	Returns the html for the text, optional surronded by the html element

[ Top ]

Properties

String $commmentEnd = '' [line 46]

[ Top ]

String $commmentStart = '' [line 41]

[ Top ]

String $text = '' [line 37]

[ Top ]

Methods

Constructor Comment [line 54]

Comment Comment(
[String
$text = ''], [String
$commmentStart = ''], [String
$commmentEnd = ''] 
)

Constructor

Parameters:

String	$text:	The text to show
String	$commmentStart:	The comment start tag
String	$commmentEnd:	The comment end tag

[ Top ]

display [line 112]

void display(
[String
$text = ''], [String
$commmentStart = ''], [String
$commmentEnd = ''] 
)

Display html

 Usage:
    Comment::display($text,$commmentStart,$commmentEnd);

Parameters:

String	$text:	The text to show in comment
String	$commmentStart:	The comment start tag
String	$commmentEnd:	The comment end tag

API Tags:

Static:

Redefinition of:

Html::display(): Display the html

[ Top ]

getHtml [line 91]

String getHtml(
)

Returns the html for the text, optional surronded by the html element

API Tags:

Return:

the complete html

Redefinition of:

Html::getHtml(): Get Html

[ Top ]

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