Sign in Join
FPDoc Onlineexperiment

TCustomFPWebModule class

In unit FpWeb

Base class for web modules with action and template support

Declaration

pascal
TCustomFPWebModule = class(TSessionHTTPModule)

Inheritance

  1. TCustomFPWebModule
  2. TSessionHTTPModule
  3. TCustomHTTPModule
  4. TDataModule
  5. TComponent
  6. TPersistent
  7. TObject

Descends from it: TFPWebModule

Description

TCustomFPWebModule extends TSessionHTTPModule with support for web actions, template processing, and advanced request handling. This class provides the foundation for building complex web applications with structured request routing and dynamic content generation.

The module manages a collection of web actions, template variables, and provides hooks for request preprocessing and response postprocessing.

See also

Properties

ActionspublicCollection of web actions for this module
ActionVarpublicName of the request parameter used to identify actions
BeforeRequestpublicEvent called before request processing
AfterResponsepublicEvent called after response processing
DefActionWhenUnknownpublicWhether to use the default action when no specific action is found
ModuleTemplatepublicTemplate used for content generation
RequestpublicThe current HTTP request being processed
ResponsepublicThe current HTTP response being generated

Methods

CreateTemplateVarsprotected
CreateTemplateprotected
CreateActionsprotected
IsWriteRequestprotected
HasTokenprotected
HandleActionsprotected
DoOnRequestprotected
DoBeforeRequestprotected
DoAfterResponseprotected
GetParamprotected
GetTemplateContentprotected
GetContentprotected
CreateNewpublicCreates a new web module instance
DestroypublicDestroys the web module instance
HandleRequestpublicProcesses an incoming HTTP request

Events

OnRequestpublicEvent called for request processing
OnGetActionpublicEvent called to determine which action to execute
OnGetParampublicEvent called to resolve template parameters
OnTemplateContentpublicEvent called for template content processing

Inherited

From TSessionHTTPModule (9)

CheckSession CreateSession DoneSession InitSession Notification OnNewSession OnSessionExpired Session UpdateSession

From TCustomHTTPModule (9)

AfterInitModule BaseURL CORS CreateCORSSUpport DefaultModuleName DefaultSkipStreaming DoAfterInitModule Kind RegisterModule

From TDataModule (15)

AfterConstruction BeforeDestruction Create DefineProperties DesignOffset DesignPPI DesignSize DoCreate DoDestroy GetChildren HandleCreateException OldCreateOrder OnCreate OnDestroy ReadState

From TComponent (69)

_AddRef _Release CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetParentComponent GetTypeInfo GetTypeInfoCount HasParent iicrGetComponent InsertComponent Invoke IsImplementorOf Loaded Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetName SetParentComponent SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (5)

Assign AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (36)

CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.