Class Common

Nethgui\Module\AbstractModule implements Nethgui\Module\ModuleInterface, Nethgui\View\ViewableInterface, Nethgui\Log\LogConsumerInterface, Nethgui\Utility\PhpConsumerInterface, Nethgui\Authorization\AuthorizationAttributesProviderInterface, Nethgui\System\PlatformConsumerInterface, Nethgui\Authorization\PolicyEnforcementPointInterface

Extended by

Nethgui\Controller\AbstractController implements Nethgui\Controller\RequestHandlerInterface

Extended by

Nethgui\Module\Help\Common implements Nethgui\Component\DependencyConsumer

Direct known subclasses

Nethgui\Module\Help\Read, Nethgui\Module\Help\Show, Nethgui\Module\Help\Template

Namespace: Nethgui\Module\Help
Author: Davide Principi davide.principi@nethesis.it
Located at Module/Help/Common.php

Methods summary
`public Nethgui\Module\ModuleSetInterface`	# `getModuleSet( )` Returns `Nethgui\Module\ModuleSetInterface` $moduleSet Menu
`public`	# `bind( Nethgui\Controller\RequestInterface $request )` Put the request into the object internal state Parameters `$request` Api Overrides `Nethgui\Controller\AbstractController::bind()`
`public`	# `setFileNameResolver( $fileNameResolver )`
`protected Nethgui\Module\ModuleInterface`	# `getTargetModule( )` Returns `Nethgui\Module\ModuleInterface`
`protected`	# `getHelpDocumentPath( Nethgui\Module\ModuleInterface $module )`
`protected`	# `getFileNameResolver( )`
`protected string`	# `readHelpDocument( $filePath )` Extract the contents of the first div tag in the XHTML help document Extract the contents of the first div tag in the XHTML help document Returns string Throws `Nethgui\Exception\HttpException`
`public`	# `expandIncludes( $contents )`
`public`	# `readHelpDocumentsByPattern( $pattern )`
`public`	# `setNamespaceMap( $nsMap )`
`public array`	# `getDependencySetters( )` The returned hash is indexed by the model class name and has a callable objects as value. Each callable is invoked with the model instance as only argument. The returned hash is indexed by the model class name and has a callable objects as value. Each callable is invoked with the model instance as only argument. Returns array Implementation of `Nethgui\Component\DependencyConsumer::getDependencySetters()`

Methods inherited from Nethgui\Controller\AbstractController
`__construct(), createValidator(), declareParameter(), getRequest(), getValidator(), nextPath(), onParametersSaved(), prepareView(), process(), saveParameters(), validate()`

Methods inherited from Nethgui\Module\AbstractModule
`asAuthorizationString(), getAttributesProvider(), getAuthorizationAttribute(), getIdentifier(), getLog(), getParent(), getPhpWrapper(), getPlatform(), getPolicyDecisionPoint(), getViewTemplate(), hasPlatform(), initialize(), initializeAttributes(), isInitialized(), setLog(), setParent(), setPhpWrapper(), setPlatform(), setPolicyDecisionPoint(), setViewTemplate()`

Constants inherited from Nethgui\Controller\RequestHandlerInterface
`ACTION_MUTATE, ACTION_QUERY`

Constants inherited from Nethgui\Module\ModuleInterface
`ACTION_INSTANTIATE`

Properties inherited from Nethgui\Controller\AbstractController
`$parameters`