ProcessController class

A Controller for Process* Modules

Intended to be used by templates that call upon Process objects

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessController class also inherits all the methods and properties of: Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
ProcessController::execute()
string

Execute the process and return the resulting content generated by the process

ProcessController::getProcess()
Process

Determine and return the Process to execute

 
ProcessController::getProcessMethodName($process)
string

Get the name of the method to execute with the Process

 
ProcessController::isAjax()
bool

Is this an AJAX request?

 
ProcessController::jsonMessage($msg)
string

Generate a message in JSON format, for use with AJAX output

 
ProcessController::setPrefix(string $prefix)
None

Set the class name prefix used by all related Processes

 
ProcessController::setProcess(Process $process)
None

Set the Process to execute.

 
ProcessController::setProcessMethodName(string $processMethod)
None

Set the name of the method to execute in the Process

 
ProcessController::setProcessName(string $processName)
None

Set the name of the Process to execute.

 

Additional methods and properties

In addition to the methods and properties above, ProcessController also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.257