FileCompilerModule class

Provides the base class for FileCompiler modules

FileCompiler modules must use the name format: FileCompiler[Name].module For example, FileCompilerTags.module

This file is licensed under the MIT license

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.

Common
Properties

Common

Name	Return	Summary
FileCompilerModule::compile() FileCompilerModule::compile(string $data) FileCompilerModule::compile(string $data)	`string` `array`	The compile method processes the contents of a file
FileCompilerModule::compileMarkup() FileCompilerModule::compileMarkup(string $data) FileCompilerModule::compileMarkup(string $data)	`string`	Compile a section of markup
FileCompilerModule::getModuleConfigInputfields() FileCompilerModule::getModuleConfigInputfields(InputfieldWrapper $inputfields) FileCompilerModule::getModuleConfigInputfields(InputfieldWrapper $inputfields)	None	Configure the FileCompiler module
FileCompilerModule::getSourceFile() FileCompilerModule::getSourceFile() FileCompilerModule::getSourceFile()	`string`	Get the source file (full path and filename) that this module is acting upon
FileCompilerModule::init() FileCompilerModule::init() FileCompilerModule::init()	None	Optional method to initialize the module.
FileCompilerModule::install() FileCompilerModule::install() FileCompilerModule::install()	None	Perform any installation procedures specific to this module, if needed.
FileCompilerModule::setSourceFile() FileCompilerModule::setSourceFile($file) FileCompilerModule::setSourceFile($file)	None
FileCompilerModule::uninstall() FileCompilerModule::uninstall() FileCompilerModule::uninstall()	None	Perform any uninstall procedures specific to this module, if needed.

Properties

Name	Return	Summary	Default
FileCompilerModule::runOrder	`int`	Order that the module executes in relative to other FileCompiler modules.

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.251