#include <Element.h>

Inheritance diagram for ESIElement:
Collaboration diagram for ESIElement:

Public Types

enum  ESIElementType_t {
  ESI_ELEMENT_NONE,
  ESI_ELEMENT_INCLUDE,
  ESI_ELEMENT_COMMENT,
  ESI_ELEMENT_REMOVE,
  ESI_ELEMENT_TRY,
  ESI_ELEMENT_ATTEMPT,
  ESI_ELEMENT_EXCEPT,
  ESI_ELEMENT_VARS,
  ESI_ELEMENT_CHOOSE,
  ESI_ELEMENT_WHEN,
  ESI_ELEMENT_OTHERWISE,
  ESI_ELEMENT_ASSIGN
}
 
typedef RefCount< ESIElementPointer
 

Public Member Functions

virtual bool addElement (ESIElement::Pointer)
 
virtual void render (ESISegment::Pointer)=0
 
virtual esiProcessResult_t process (int dovars)
 
virtual bool mayFail () const
 
virtual Pointer makeCacheable () const =0
 
virtual Pointer makeUsable (esiTreeParentPtr, ESIVarState &) const =0
 
virtual void finish ()=0
 
virtual void provideData (ESISegment::Pointer data, ESIElement *source)
 
virtual void fail (ESIElement *source, char const *reason=NULL)
 

Static Public Member Functions

static ESIElementType_t IdentifyElement (const char *)
 

Detailed Description

Definition at line 40 of file Element.h.

Member Typedef Documentation

Definition at line 44 of file Element.h.

Member Enumeration Documentation

Enumerator
ESI_ELEMENT_NONE 
ESI_ELEMENT_INCLUDE 
ESI_ELEMENT_COMMENT 
ESI_ELEMENT_REMOVE 
ESI_ELEMENT_TRY 
ESI_ELEMENT_ATTEMPT 
ESI_ELEMENT_EXCEPT 
ESI_ELEMENT_VARS 
ESI_ELEMENT_CHOOSE 
ESI_ELEMENT_WHEN 
ESI_ELEMENT_OTHERWISE 
ESI_ELEMENT_ASSIGN 

Definition at line 47 of file Element.h.

Member Function Documentation

virtual bool ESIElement::addElement ( ESIElement::Pointer  )
inlinevirtual

Reimplemented in esiChoose, esiTry, esiRemove, ESIAssign, and esiSequence.

Definition at line 62 of file Element.h.

References debugs.

Referenced by ESIContext::addLiteral(), and ESIContext::addStackElement().

virtual void esiTreeParent::fail ( ESIElement source,
char const *  reason = NULL 
)
inlinevirtualinherited
virtual bool ESIElement::mayFail ( ) const
inlinevirtual

Reimplemented in esiSequence.

Definition at line 75 of file Element.h.

Referenced by ESIContext::send().

virtual esiProcessResult_t ESIElement::process ( int  dovars)
inlinevirtual

Reimplemented in esiChoose, esiTry, ESIInclude, ESIAssign, esiSequence, and esiLiteral.

Definition at line 70 of file Element.h.

References debugs, and ESI_PROCESS_COMPLETE.

Referenced by esiTry::process(), ESIContext::process(), and esiChoose::process().

virtual void esiTreeParent::provideData ( ESISegment::Pointer  data,
ESIElement source 
)
inlinevirtualinherited
virtual void ESIElement::render ( ESISegment::Pointer  )
pure virtual

The documentation for this class was generated from the following files:

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors