Class SampleBase

Description

Defines the base class for the sample code applications

  • abstract:

Located in /lib/SampleBase.class.php (line 12)


	
			
Direct descendents
Class Description
SampleAuthenticationBase Demonstrates the Tarîqa authentication mechanism
DefaultSample Default application
Class Constant Summary
 config_file = "config/config.xml"
 config_format = "xml"
 samples_file = "samples/samples.xml"
 samples_format = "xml"
 session_name = "tariqa_soap_demo"
Variable Summary
array $config
string $display_code
float[] $timing
string[] $timing_names
string $title
Method Summary
SampleBase __construct ()
void addTimeMark ([string $name = ""])
boolean destroy ()
void execute ()
string htmlFoot ()
string htmlHead ()
string htmlMenu ()
boolean initialize ()
string printTimeMarks ()
void run ()
Variables
array $config (line 30)
  • var: Configuration array
  • access: public
array $descriptions (line 36)
  • var: Samples descriptions
  • access: public
string $display_code (line 42)
  • var: Default value: false. If set to a class name, the code of this class will be outputed (use __CLASS__ to output the current class's code)
  • access: public
float[] $timing (line 48)
  • var: Timers of the application
  • access: protected
string[] $timing_names (line 53)
  • var: Name of the timers of the application
  • access: protected
string $title (line 24)
  • var: Title of the sample
  • access: public
Methods
Constructor __construct (line 58)

Default constructor

  • access: public
SampleBase __construct ()

Redefined in descendants as:
addTimeMark (line 152)

Add an entry in the timer array

  • access: public
void addTimeMark ([string $name = ""])
  • string $name: Name of the timer
destroy (line 92)

Do some cleanup after execution.

This method is always called after execute. You should not throw any exception from here!

  • abstract:
  • access: public
boolean destroy ()

Redefined in descendants as:
execute (line 82)

Method that should contain the processing of the sample

This method should throw an Exception in case of error, to stop the processing

  • abstract:
  • access: public
void execute ()

Redefined in descendants as:
htmlFoot (line 217)

Return the trailing part of the HTML document (as from the </body> tag)

  • final:
  • access: public
string htmlFoot ()
htmlHead (line 163)

Return the heading part of the HTML document (up to the <body> tag)

  • final:
  • access: public
string htmlHead ()
htmlMenu (line 252)

Return the Menu's application

  • final:
  • access: protected
string htmlMenu ()
initialize (line 73)

Initialize the code.

This method should return false (or throw an exception) in case of error to stop the processing

  • abstract:
  • access: public
boolean initialize ()

Redefined in descendants as:
printTimeMarks (line 375)

Return the list of timers as a string

  • final:
  • access: protected
string printTimeMarks ()
run (line 99)

Run the sample

  • final:
  • access: public
void run ()
Class Constants
config_file = "config/config.xml" (line 14)
config_format = "xml" (line 15)
samples_file = "samples/samples.xml" (line 16)
samples_format = "xml" (line 17)
session_name = "tariqa_soap_demo" (line 18)

Documentation generated on Mon, 30 Mar 2009 16:36:27 +0200 by phpDocumentor 1.4.1