Class RSDEngineMethod

Description

A class for generating an entire PHP-Class.

The access restriction for this class should be treated as 'friendly' - only accessable by classes in the same package.

Located in /code/framework/RSDEngine/RSDEngineDBTable.php (line 5811)


	
			
Variable Summary
String $body
mixed $indent
String $name
mixed $parameters
Method Summary
RSDEngineMethod RSDEngineMethod (String $name, String $parameters, String $methodComments, String $body, [String $indent = ""])
String getCode ()
void setIndent (String $indent)
String toString ()
Variables
String $body = "" (line 5833)
  • var: The method body.
mixed $indent = "" (line 5840)
mixed $methodComments = "" (line 5828)
  • see: RSDEngineMethod::RSDEngineMethod
String $name = "" (line 5816)
  • var: The method name. Is set in the construtor method.
  • see: RSDEngineMethod::RSDEngineMethod
mixed $parameters = "" (line 5822)
  • see: RSDEngineMethod::RSDEngineMethod
Methods
Constructor RSDEngineMethod (line 5850)

Constructor method that initializes this instance.

RSDEngineMethod RSDEngineMethod (String $name, String $parameters, String $methodComments, String $body, [String $indent = ""])
  • String $name: The method name.
  • String $parameters: The parameter string as it is inserted between the opening and the closing brace in the method declaration.
  • String $methodComments: The comment block preceeding the method.
  • String $body: The method body.
  • String $indent: A String to be placed in front of every line. This argument is optional. The default value is an empty string.
getCode (line 5885)

Returns the code of this method.

  • return: The code including the method comments, the method declaration and the founction body.
String getCode ()
setIndent (line 5864)

Sets the property indent.

void setIndent (String $indent)
  • String $indent: The value to assign to $this->indent.
toString (line 5876)

Returns the method declaration.

Looks like this:


1 function toString()
2 {
3 return $this->name . "(" . $this->parameters . ")";
4 }

  • return: the method declaration.
String toString ()

Documentation generated on Mon, 8 Dec 2003 13:12:25 +0100 by phpDocumentor 1.2.3