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

Class: Format

Source Location: /myphp-1.9/myphp-1.9-util/html/component/Format.php

Class Format

Class Overview

Format the text accordingly to predefined styles

  1. Usage:
  2. $html = new Format($text,$style,$pattern);
  3. print $html->getHtml();
  4. OR
  5. Format::display($text,$style,$pattern);

Located in /myphp-1.9/myphp-1.9-util/html/component/Format.php [line 30]

Object
   |
   --Format
Author(s):
Information Tags:
Todo:  use number_format() with locale

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
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
String   $pattern  
String   $style  
String   $text  

[ Top ]
Method Summary
Format   Format()   Constructor
String   convert()   Returns the text as formatted html
void   display()   Display html
String   getHtml()   Returns the text as formatted html

[ Top ]
Properties
String   $pattern = '' [line 42]

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

[ Top ]
String   $text = '' [line 34]

[ Top ]
Methods
Constructor Format  [line 50]

  Format Format( String $text, [String $style = ''], [String $pattern = '']  )

Constructor

Parameters:
String   $text:  The text to format accordingly
String   $style:  The format style
String   $pattern:  The pattern to use


[ Top ]
convert  [line 73]

  String convert( )

Returns the text as formatted html


API Tags:
Return:  The text formatted as specified by style


[ Top ]
display  [line 138]

  void display( String $text, [String $style = ''], [String $pattern = '']  )

Display html

  1. Usage:
  2. Format::display($text,$style,$pattern);

Parameters:
String   $text:  The text to format accordingly to style
String   $style:  The format style
String   $pattern:  The pattern to use

API Tags:
Static:  


[ Top ]
getHtml  [line 121]

  String getHtml( )

Returns the text as formatted html


API Tags:
Return:  The text formatted as specified by style


Redefinition of:
Object::getHtml()
Returns the html for the element

[ Top ]

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