Class PluggableAction

Decorate an AbstractAction, allowing other (plugin) actions to extend it.

Collaborates with - PluginCollector, that actually holds the plugin actions - AbstractAction, the decorated module - TableController, the parent module

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

Nethgui\Controller\AbstractController implements Nethgui\Controller\RequestHandlerInterface

Nethgui\Controller\Table\AbstractAction implements Nethgui\Adapter\AdapterAggregateInterface

Nethgui\Controller\Table\PluggableAction implements Nethgui\Module\ModuleCompositeInterface, Nethgui\Component\DependencyInjectorAggregate

Namespace: Nethgui\Controller\Table
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
See: Decorator pattern
Api
Located at Controller/Table/PluggableAction.php

Methods summary
`public`	# `__construct( Nethgui\Controller\Table\AbstractAction $action, string $pluginsPath = NULL )` Parameters `$action` `$pluginsPath` Overrides `Nethgui\Controller\AbstractController::__construct()`
`public boolean`	# `hasAdapter( )` Returns boolean Overrides `Nethgui\Controller\Table\AbstractAction::hasAdapter()`
`public Nethgui\Adapter\AdapterInterface`	# `getAdapter( )` Returns `Nethgui\Adapter\AdapterInterface` Overrides `Nethgui\Controller\Table\AbstractAction::getAdapter()`
`public Nethgui\Controller\Table\AbstractAction`	# `setAdapter( Nethgui\Adapter\AdapterInterface $adapter )` Receive the adapter object from the TableController Receive the adapter object from the TableController Parameters `$adapter` Returns `Nethgui\Controller\Table\AbstractAction` Overrides `Nethgui\Controller\Table\AbstractAction::setAdapter()`
`public string`	# `getIdentifier( )` The Module Identifier is a string that univocally identifies a Module. The Module Identifier is a string that univocally identifies a Module. Returns string Returns the unique module identifier Api Overrides `Nethgui\Module\AbstractModule::getIdentifier()`
`public Nethgui\Module\ModuleAttributesInterface`	# `getAttributesProvider( )` Gain access to the attributes of this module Gain access to the attributes of this module Returns `Nethgui\Module\ModuleAttributesInterface` Api Overrides `Nethgui\Module\AbstractModule::getAttributesProvider()`
`protected Nethgui\Module\ModuleAttributesInterface`	# `initializeAttributes( Nethgui\Module\ModuleAttributesInterface $base )` Called after a default attributes provider object is created Called after a default attributes provider object is created Parameters `$base` $descriptor Returns `Nethgui\Module\ModuleAttributesInterface` See `Nethgui\Controller\Table\PluggableAction::getAttributesProvider()` Overrides `Nethgui\Module\AbstractModule::initializeAttributes()`
`public ModuleCompositeInterface`	# `addChild( Nethgui\Module\ModuleInterface $module )` Adds a child to this Composite. Implementations must send a setParent() message to $module. Adds a child to this Composite. Implementations must send a setParent() message to $module. Parameters `$module` The child module. Returns ModuleCompositeInterface The composite module Api Implementation of `Nethgui\Module\ModuleCompositeInterface::addChild()`
`public array`	# `getChildren( )` Returns array An array of ModuleInterface implementing objects. Api Implementation of `Nethgui\Module\ModuleCompositeInterface::getChildren()`
`public Nethgui\System\PlatformConsumerInterface`	# `setPlatform( Nethgui\System\PlatformInterface $platform )` Set the Platform object Set the Platform object Returns `Nethgui\System\PlatformConsumerInterface` Api Overrides `Nethgui\Module\AbstractModule::setPlatform()`
`public`	# `initialize( )` Overriding methods can read current state from model. Overriding methods can read current state from model. Overrides `Nethgui\Module\AbstractModule::initialize()`
`public`	# `bind( Nethgui\Controller\RequestInterface $request )` Put the request into the object internal state Parameters `$request` Api Overrides `Nethgui\Controller\AbstractController::bind()`
`public`	# `validate( Nethgui\Controller\ValidationReportInterface $report )` Validate object state Validate object state Errors must be sent to $report. Api Overrides `Nethgui\Controller\AbstractController::validate()`
`public`	# `process( )` Save parameters on mutation Save parameters on mutation Overrides `Nethgui\Controller\AbstractController::process()`
`public`	# `prepareView( Nethgui\View\ViewInterface $view )` Add default Cancel and FormAction URLs Add default Cancel and FormAction URLs Parameters `$view` Overrides `Nethgui\Controller\Table\AbstractAction::prepareView()`
`public mixed`	# `nextPath( )` Get the path to the next module. Relative paths resolving is deferred to implementors. Get the path to the next module. Relative paths resolving is deferred to implementors. Executed after process(), the user agent is directed to the designated module. If boolean FALSE is returned then no action takes place. Returns mixed boolean FALSE, string path (absolute), array request Api Overrides `Nethgui\Controller\Table\AbstractAction::nextPath()`
`public string`	# `asAuthorizationString( )` Convert an object to a default string representation Convert an object to a default string representation Returns string The string representing the object in authorization rules Api Overrides `Nethgui\Module\AbstractModule::asAuthorizationString()`
`public mixed`	# `getAuthorizationAttribute( $attributeName )` Get the value of an attribute Get the value of an attribute Returns mixed The value of the authorization attribute Api Overrides `Nethgui\Module\AbstractModule::getAuthorizationAttribute()`
`public Nethgui\Component\DependencyInjectorAggregate`	# `setDependencyInjector( callable $di )` Parameters `$di` Returns `Nethgui\Component\DependencyInjectorAggregate` The object itself Implementation of `Nethgui\Component\DependencyInjectorAggregate::setDependencyInjector()`

Methods inherited from Nethgui\Controller\Table\AbstractAction
`saveParameters()`

Methods inherited from Nethgui\Controller\AbstractController
`createValidator(), declareParameter(), getRequest(), getValidator(), onParametersSaved()`

Methods inherited from Nethgui\Module\AbstractModule
`getLog(), getParent(), getPhpWrapper(), getPlatform(), getPolicyDecisionPoint(), getViewTemplate(), hasPlatform(), isInitialized(), setLog(), setParent(), setPhpWrapper(), setPolicyDecisionPoint(), setViewTemplate()`

Constants inherited from Nethgui\Module\ModuleInterface
`ACTION_INSTANTIATE`

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

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

Namespaces

Classes

Class PluggableAction

Parameters

Overrides

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Returns

Api

Overrides

Returns

Api

Overrides

Parameters

Returns

See

Overrides

Parameters

Returns

Api

Implementation of

Returns

Api

Implementation of

Returns

Api

Overrides

Overrides

Parameters

Api

Overrides

Api

Overrides

Overrides

Parameters

Overrides

Returns

Api

Overrides

Returns

Api

Overrides

Returns

Api

Overrides

Parameters

Returns

Implementation of