Class: Text

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

Class Text

Class Overview

Generates a plain Text object, surronded by a html element

 Usage:
   $text = new Text($text,$element,$class,$name);
   print $text->getHtml();
 Or
   Text::display($text,$element,$class,$name);

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

Object
   |
   --Html
      |
      --Text

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
Header	Generates a plain Header object, surronded by a html element
Hr	Generates a html tag <hr />
Li	Generates an <li>...</li>
Ol	Generates an OL tag
Tag	This is just a wrapper class in order to allow usage of one 'Tag::xyz()'
Ul	Generates an UL tag

[ 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

mixed	$class
mixed	$element
mixed	$name
mixed	$text

[ Top ]

Method Summary

Text	Text()	Constructor
void	display()	Display html
void	end()	Display end
String	getEnd()	Returns the end html for the text, optional surronded by the html element
String	getHtml()	Returns the html for the text, optional surronded by the html element
String	getStart()	Returns the start html for the text, optional surronded by the html element
void	start()	Display start

[ Top ]

Properties

mixed $class = '' [line 36]

[ Top ]

mixed $element = '' [line 35]

[ Top ]

mixed $name = '' [line 37]

[ Top ]

mixed $text = '' [line 34]

[ Top ]

Methods

Constructor Text [line 46]

Text Text(
[String
$text = ''], [String
$element = ''], [String
$class = ''], [String
$name = ''] 
)

Constructor

Parameters:

String	$text:	The text to show
String	$element:	The html element, if any
String	$class:	The css class name
String	$name:	The name/id attribute for a link identifier

[ Top ]

display [line 226]

void display(
[String
$text = ''], [String
$element = ''], [String
$class = ''], [String
$name = ''] 
)

Display html

 Usage:
    Text::display($text,$element,$class,$name);

Parameters:

String	$text:	The text to show
String	$element:	The html element, if any
String	$class:	The css class name
String	$name:	The name/id attribute for a link identifier

API Tags:

Static:

Redefinition of:

Html::display(): Display the html

Redefined in descendants as:

Header::display() : Display html
Hr::display() : Display html
Li::display() : Display html
Ol::display() : Display html
Tag::display() : Display html
Ul::display() : Display html

[ Top ]

end [line 209]

void end(
[String
$element = ''] 
)

Display end

 Usage:
    Text::end($element);

Parameters:

String

$element:

The html element, if any

API Tags:

Static:

Redefined in descendants as:

Li::end() : Display end
Ol::end() : Display end
Ul::end() : Display end

[ Top ]

getEnd [line 120]

String getEnd(
)

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

API Tags:

Return:

the complete html

[ Top ]

getHtml [line 136]

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 ]

getStart [line 87]

String getStart(
)

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

API Tags:

Return:

the complete html

[ Top ]

start [line 195]

void start(
[String
$element = ''], [String
$class = ''] 
)

Display start

 Usage:
    Text::start($element,$class);

Parameters:

String	$element:	The html element, if any
String	$class:	The css class name

API Tags:

Static:

Redefined in descendants as:

Li::start() : Display start
Ol::start() : Display start
Ul::start() : Display start

[ Top ]

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