FileCompilerModule class

Located in file /wire/core/FileCompilerModule.php

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

Show class?             Show args?        

Common

NameReturnSummary 
compile(string $data)
string arrayThe compile method processes the contents of a file 
compileMarkup(string $data)
stringCompile a section of markup 
getModuleConfigInputfields(InputfieldWrapper $inputfields)
(nothing)Configure the FileCompiler module 
getSourceFile()
stringGet the source file (full path and filename) that this module is acting upon 
init()
(nothing)Optional method to initialize the module. 
install()
(nothing)Perform any installation procedures specific to this module, if needed.
isAutoload()
(nothing) 
isSingular()
(nothing) 
runOrder int Order that the module executes in relative to other FileCompiler modules.  
setSourceFile($file)
(nothing) 
uninstall()
(nothing)Perform any uninstall procedures specific to this module, if needed.

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.244

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer