Main Page | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals

IncludeRule Class Reference

Used for including rules from other files. More...

#include <rtreeincluderule.h>

Inheritance diagram for IncludeRule:

Rule

Public Member Functions

 IncludeRule (Constant *iname, RunRuleList &irunRuleList)
 Constructor.

virtual ~IncludeRule ()
virtual bool execute (RuleContext *context, List *phpIn, List *phpOut, List *tplOut, Node::Assignment &assign) const
 Executer the rule on php.

virtual Rule * copy ()
 Copies the rule.

virtual Rule * substitute (const Node::Assignment &assign)
 Substitutes variables used in the rule.

virtual ostream & print (ostream &os) const
 Writes the rule to the stream.


Private Attributes

const string name
 A name of the rules to include.

RunRuleList & runRuleList
 The referece to rulelist in RuleSystem.


Detailed Description

Used for including rules from other files.

Definition at line 7 of file rtreeincluderule.h.


Constructor & Destructor Documentation

IncludeRule::IncludeRule (  Constant *  iname,
RunRuleList &  irunRuleList
) 
 

Constructor.

Definition at line 5 of file rtreeincluderule.cpp.

IncludeRule::~IncludeRule (   )  [virtual]
 

Definition at line 11 of file rtreeincluderule.cpp.


Member Function Documentation

Rule * IncludeRule::copy (   )  [virtual]
 

Copies the rule.

Implements Rule.

Definition at line 44 of file rtreeincluderule.cpp.

bool IncludeRule::execute (  RuleContext *  context,
List *  phpIn,
List *  phpOut,
List *  tplOut,
Node::Assignment &  assign
)  const [virtual]
 

Executer the rule on php.

Parameters:
context context in which rule is executed
phpIn input php
phpOut output php
tplOut output smarty template
assign the assignment used to match the rule
Returns:
true is rule was succefully executed
If rule was succefully executed refactored php is deleted from the begining of phpIn list.

Implements Rule.

Definition at line 14 of file rtreeincluderule.cpp.

References name, List::print(), and runRuleList.

ostream & IncludeRule::print (  ostream &  os  )  const [virtual]
 

Writes the rule to the stream.

Implements Rule.

Definition at line 39 of file rtreeincluderule.cpp.

References name.

Rule * IncludeRule::substitute (  const Node::Assignment &  assign  )  [virtual]
 

Substitutes variables used in the rule.

Implements Rule.

Definition at line 48 of file rtreeincluderule.cpp.


Field Documentation

const string IncludeRule::name [private]
 

A name of the rules to include.

Definition at line 11 of file rtreeincluderule.h.

Referenced by execute(), and print().

RunRuleList& IncludeRule::runRuleList [private]
 

The referece to rulelist in RuleSystem.

Definition at line 13 of file rtreeincluderule.h.

Referenced by execute().


The documentation for this class was generated from the following files:
Generated on Fri Nov 21 17:54:07 2003 for PHPX by doxygen 1.3.3