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

Class: Object

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

Class Object

Class Overview

The base class for all other classes

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

  1. Usage:
  2. class Demo extends Object {
  3. function Demo() { $this->Object(); } // Constructor
  4. function getHtml() { return 'Hey Demo'; } // Abstract
  5. }

Located in /myphp-1.9/myphp-1.9-base/html/Object.php [line 35]



		
		
		
		

Properties

Methods

[ Top ]
Direct descendents
Child Class Description
Html The base class for all the HTML classes
Connection The connection interface towards the mysql database
DatabaseCommon Common functions for the different database calls
Timer Used as a Profiler to track down bottle necks
Sax Used to parse an xml file utilizing the SAX model
Format Format the text accordingly to predefined styles
Server The Server object.

[ Top ]
Property Summary
String   $cachefile  
String   $html  
String   $sql  

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

[ Top ]
Properties
String   $cachefile = '' [line 49]

[ Top ]
String   $html = '' [line 39]

[ Top ]
String   $sql = '' [line 44]

Redefined in descendants as:

[ Top ]
Methods
Constructor Object  [line 54]

  Object Object( )

Constructor



[ Top ]
addHtml  [line 224]

  void addHtml( [String $html = '']  )

Add the current html to the SourceCode object

  1. Usage:
  2. $element = new Element();
  3. $element->addHtml();
  4. Or
  5. $element = new Element();
  6. $element->addHtml($element->getStart());

Parameters:
String   $html:  Use other html than fetched from $element->getHtml()


[ Top ]
getCacheFileName  [line 75]

  String getCacheFileName( [String $path = '']  )

Returns the name of the cache file name

If empty name, create a cache file name

Parameters:
String   $path:  The Path, Where to store the cache files

API Tags:
Return:  The path/name of the cache file


[ Top ]
getClassName  [line 65]

  String getClassName( )

Returns the name of the instanciated class


API Tags:
Return:  The name of the class
Static:  


[ Top ]
getHtml  [line 248]

  String getHtml( )

Returns the html for the element


API Tags:
Return:  The complete html
Abstract:  


Redefined in descendants as:

[ Top ]
getMsg  [line 157]

  String getMsg( int $level, String $msg  )

Get the formatted message and debug level and Log to file ?

Parameters:
int   $level:  The debug level. ALL, QUERY, USER, DEBUG, INFO, WARN, ERROR, FATAL, EMAIL or NONE
String   $msg:  The message to log

API Tags:
Return:  The message in question


[ Top ]
save  [line 294]

  boolean save( String $content  )

Save the SQL cache file

Parameters:
String   $content:  The html content to save as sql cache

API Tags:
Return:  True on succes, false if failure


[ Top ]
setCacheFileName  [line 147]

  void setCacheFileName( String $cachefile  )

Set the path/name of the cache file

Parameters:
String   $cachefile:  Where to store the cache file


[ Top ]
toString  [line 271]

  String toString( [String $path = ''], [String $class = '']  )

Returns the information for this class

  1. Usage:
  2. print Link::toString('Link'); // static or
  3. print Link->toString();

Parameters:
String   $path:  The path to the source files
String   $class:  The name of a valid class name or $this

API Tags:
Return:  The complete info for the class in html


[ Top ]
write  [line 360]

  boolean write( String $content  )

Write the content to the file opened by fp

Parameters:
String   $content:  The content to write

API Tags:
Return:  Returns true on success


[ Top ]

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