Class: eDUtilities

Source Location: Program_Root/eDFramework/eDUtilities.php

Class Overview [line 15]


eDFramework Utilities Class (inspired by PHPDoc)

Author(s):

Version:

Copyright:

Variables

Methods


Child classes:

eDSkin
Class - eDContainer Skin Object
MenuBuilder
Class - eDContainer Menu Builder
eDDataFile
eDDataFile - Data File Generator
eDFormBuilder
'eDFormBuilder - eDreamers HTML Form Builder'
eDMySQLMS
MySQL Management System - DB Schema Builder
eDObject
'eDObject - eDreamers Object'
eDQuery
MySQL Select Query Generator

Inherited Variables

Inherited Methods



Class Details

eDFramework Utilities Class (inspired by PHPDoc)

As a kind of common base class, this class holds configuration values (e.g. error handling) and provides useful methods (e.g. introspection()) to all kind of classes. It does not have a constructor, so you can always inherit classes from this class without any trouble. Original version's author is: Ulf Wendel <ulf.wendel@phpdoc.de>

Change Log 14/01/2003 BPO the function nameToUrl was removed, not relevant to this class anymore

Tags:

[ Top ]


Class Variables

$CR_html =  "<br>\n"

[line 20]

Boiler plates

Tags:

Type: mixed

Overrides:

[ Top ]

$CR_text =  "\n"

[line 21]

Type: mixed

Overrides:

[ Top ]

$format =  'text'

[line 36]

Type: mixed

Overrides:

[ Top ]

$mode =  'log'

[line 31]

Type: mixed

Overrides:

[ Top ]

$str_file =  'trace.log'

[line 41]

Type: mixed

Overrides:

[ Top ]

$traceEnabled =  FALSE

[line 26]

Type: mixed

Overrides:

[ Top ]


Class Methods

introspection

void introspection( [string $title = 'Introspection'], [mixed $data = ""], [boolean $userfunction = true])

[line 146]

Dumps objects and arrays.

Use this function to get an idea of the internal datastructures used. The function dumps arrays and objects. It renders the content in an HTML table. Play with it, you'll see it's very helpful for debugging.

Tags:

  • access - public

Parameters:

  • string $title - Optional title used in the HTML Table
  • mixed $data - Optional array or object that you want to dump. Fallback to $this.
  • boolean $userfunction - Optional flag. If set to false userfunction in an object are not shown (default). If set to true, userfunctions are rendered

[ Top ]

is_defined

TRUE is_defined( string $str_)

[line 193]

Is the string $str_ defined From what I know, yet no PHP function allows to test if a string is defined.

Defined here means is set and has a positive length

Tags:

  • return - is the string is defined, else FALSE
  • since - 15/01/2003 BPO SFFR#668458 eDFramework :: Null & Empty String Test

Parameters:

  • string $str_ - a string

[ Top ]

setTrace

1 setTrace( [boolean $boo_ = false], [string $str_mode = 'log'], [string $str_format = 'text'], [string $str_file = 'trace.log'])

[line 57]

Sets the TRACE flag, mode and format

If set to true the trace() will print messages sent to it. If no, the trace() function will do nothing. Use this function as an intelligent echo/print function to log, trace, debug the activity of our classes.

Tags:

Parameters:

  • boolean $boo_ - TRUE or FALSE to activate or de-activate the tracing
  • string $str_mode - 'screen' | 'log' to send trace to the screen or to a log file
  • string $str_format - 'text' | 'html' to wrap trace message as text or html
  • string $str_file - log file relative pathname

[ Top ]

trace

void trace( mixed $str_message, [mixed $str_display = 'inline'], string $message, string $format, string $display, string $trace)

[line 89]

Print a string and flushes the output buffer

Change Log 2/01/2003 BPO SFFR#661093 eDFramework - eDUtilities Trace Mode

  • Function name has changed from out(...) to trace(...)
  • Function parameters now have default values
  • $mode parameter is now named $display
  • $mode parameter is no used to set the output stream
  • applying variable naming convention, adding variable type prefix to variable names

Parameters:

  • string $message - The message to print
  • string $format - text | html Display the message as text or HTML
  • string $display - inline | block Display the message inline or within a block
  • string $trace - log | screen Set the output stream to file or screen

[ Top ]


Documentation generated on Wed, 10 Dec 2003 21:47:52 +0100 by phpDocumentor 1.2.2