Class \Prado\Util\TPluginModule

TPluginModule class.

TPluginModule is for extending PRADO through Composer packages. This installs its own Pages, where available, and its own error message file for the module.

Plugin pages should implement their *.page with the following page code:

<com:TContent ID=<%$ PluginContentId %>>
	...  your page content ...
	</com:TContent>

The 'PluginContentId' application parameter is what all plugin pages should implement as the page TContent ID. This way all plugin pages can be changed to the page MasterClass layout TContentPlaceHolder for the application and layout. For example in the application configuration file:

<parameters>
 <parameter id="PluginContentId" value="Main" />
 </parameters>

Class hierarchy

\Prado\Util\TPluginModule implements IPluginModule

\Prado\TModule implements IModule

\Prado\TApplicationComponent

\Prado\TComponent

Author: Brad Anderson <belisoful@icloud.com>
Since: 4.2.0

Methods summary
`public`	`additionalPagePaths(TPageService $service, string $pagePath) : mixed` additionalPagePaths returns possible alternative paths for the $pagePath
`public`	`attachPageServiceBehavior(mixed $sender, mixed $param) : mixed` Called onBeginRequest
`public`	`getErrorFile() : null\|string`
`public`	`getPluginPagesPath() : string`
`public`	`getPluginPath() : string`
`public`	`getRelativePagesPath() : string`
`public`	`init(array<string\|int, mixed> $config) : mixed` initializes the plugin module, looks for a Pages directory and adds a new {@see \Prado\Util\TBehavior} to help TPageService find any plugin module pages
`public`	`setPluginPagesPath(string $path) : mixed`
`public`	`setPluginPath(string $path) : mixed`
`public`	`setRelativePagesPath(string $relativePagesPath) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getID, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, setID, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Constants summary
`public mixed`	`PAGES_DIRECTORY` Module pages directory for finding pages of a module	`'Pages'`

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Util\TPluginModule

Class hierarchy